Docs as code: More like docs IN code. Learning about swagger.annotations while advocating for upgrade to support OpenAPI v3. It's been a while since I worked in Java. Weird to get nostalgia vibes on a current project. Also I feel like the teacher learning the subject the night before the class. Damn I love this job. #techWriterLife #technicalWriting #writeTheDocs #docsAsCode

Swimm looks very useful for code documentation. #DocsAsCode #Programming #Development #JavaScript

“How well does Swimm’s new IDE plugin - which lets you create docs right inside your IDE - fare in addressing the internal documentation problem for developers? A review.” https://javascript.plainenglish.io/my-honest-review-of-swimms-official-vs-code-extension-c5041ef0b4ad

Are there any #c4model rendering tools outside Java land? 🙄
#docsascode #docs

Just started The DevOps Handbook. The environment I support is #DocsAsCode and #StaticSiteGenerators; I don’t entirely know how to adapt our non-traditional product to the principles provided. Is there a good #DevOps reference for what we do, or, like nearly everything I seem to encounter in this job, am I going to have to be that person?

Docs-as-Code, Accessibility, OWASP Top Ten – wir haben neue Trainings im Programm! Ist etwas für dich dabei? https://www.socreatory.com/de/news/neue-trainings-2023?ref=mastodon #trainings #softwarearchitektur #docsascode #documention #owasp #websecurity #accessibility

#Markdown #AsciiDoc #reStructuredText #DocsAsCode #TechnicalWriting: "In the first part of my docs-as-code series, I’ll talk about the choice of markup languages, the available frameworks, and do a comparison among Markdown (md), Asciidoc (adoc), and reStructuredText (reST) based on some use cases. I’ll skip the history but in case you’re interested, my friend and colleague Tibs delivered a talk on the history of text markup languages. My hope is to provide you with a detailed analysis of these choices of markup languages and frameworks so that you can make an informed decision when selecting one for your next developer documentation project. If you don’t need a brief intro and would like to skip the appetizer, you can go straight to the entrée - Choose the right markup section."
https://www.dewanahmed.com/markdown-asciidoc-restructuredtext/

And here's a more technical #introduction, given Hachyderm's focus:

I've been an #OpenSource and #Linux user for about 10 years, recently moved the work laptop from #Manjaro and #XFCE to #Fedora and #GNOME.

At #GitLab I create #documentation with #Markdown. We do #DocsAsCode and lint them with #Vale. I use #VSCode and I'm good at #Git.

I used to co-organize a #Python meetup in Warsaw.

More #Introduction

By day I engage in a mix of #TechnicalWriting, #DevOps, and #WebArchitexture, and at night I host #PubQuiz. I like to talk about all those things, along with #DocsAsCode, #Jekyll and other #StaticSiteGenerators, #RetroGaming, #HumanRights, and #MentalHealth. That said, I am still getting my feet wet in social media again so it'll be a bit before my post frequency picks up.

Repair Cafe for your #DocsAsCode: Join us for the first edition which will focus on the preview on Jan 18: https://www.meetup.com/continuous-documentation-regulars/events/290277704/

Kindle edition of Git Doesn't Have to Be Hard is now available! https://smile.amazon.com/dp/B0BNWR9P45/r #github #git #docops #DocsAsCode

So, it turns out I don't scale 🤷

2023 will be the year of #DocsAsCode

Blogged:
Example of adding Antora local author preview
Making it easier for developers to contribute to #docsascode by adding Antora local preview tools to code repos
https://www.synesthesia.co.uk/note/2022/12/02/example-of-adding-antora-local-author-preview/

...
Adam Tornhill with a great talk on the real impact of bad code, and visualising using #CodeScene to make problem areas visible.

Adam's talks inspired my own Polyglot tools (quick plug: https://polyglot.korny.info ) but Code Scene is far more sophisticated than my little side project!

Also @lornajane making me want to rewrite my docs site! #DocsAsCode

Fellow Technical Writers (and anyone else who writes docs, especially #DocsAsCode), a question for you!

With #Atom being deprecated this December, are there any other lightweight, customizable text editors that do the same job? I was looking at Sublime Text, but the pricing seems a little steep.

Boosts appreciated ♥ Thank you!

Following hashtags is a cool thing! But using lists, it's less helpful to have posts in my Home TL.

Instead, I have a saved, pinned search column that can include multiple hashtags to see related posts together. This is especially helpful given that we still don't know which hashtag to use for Astro: #AstroDotBuild ? #AstroJS ? ... ?

Also handy for: #WriteTheDocs + #Documentation + any other angles of interest (#DocsAsCode , #TechnicalWriting)

Following hashtags is a cool thing! But using lists, it's less helpful to have posts in my Home TL.

Instead, I have a saved, pinned search column that can include multiple hashtags to see related posts together. This is especially helpful given that we still don't know which hashtag to use for Astro: #AstroDotBuild ? #AstroJS ? ... ?

Also handy for: #WriteTheDocs + #Documentation + any other angles of interest (#DocsAsCode , #TechnicalWriting)

- Since Theologicus is #docsascode (Markdown / Hugo / Zapier / Netlify), I would be remiss if I did not share my #github https://github.com/joelouthan

Today in "Brain-melting pieces of wisdom":

Without proper documentation, nobody will know how to use your product, so they will have to rely on you to solve their questions.

YOU. DON'T. SCALE.

#devops #docsascode

#introductions
Hi I'm Jared Morgan (or jaredmorgs on most social platforms).

I #WriteTheDocs at Squiz in #brisbane using Antora.
https://help.squiz.net

I am a co-host for the BlahCade Pinball Podcast which focuses on commercial digital pinball from indie and larger game studios.
https://blahcadepinball.com

I restore pinball machines and own three 1980 Gottlieb System 80 wide body pinball machines.

#documentation #docs #pinball #DocsAsCode #asciidoctor #podcast

I'm running https://imageoptim.com/mac over my Antora docs-as-code repository and it is doing a slow but steady job of compressing and optimising all of my images so they load faster for users.
#writethedocs #documentation #docsascode #antora #asciidoctor #asciidoc