Do you know the difference between #Microsoft #Azure #API #documentation and the #Necronomicon?

None. Nobody could read them and keep their sanity.

Documentation: Write it down, save future you

Struggling to remember what your own code does? Imagine how others feel!

Good #documentation makes your code usable, shareable, and way less frustrating. Let’s make it happen.

Learn how in our workshop: https://coderefinery.github.io/2025-03-25-workshop/

Less than a week until a software update at work, that is requiring updates to two sets of #documentation, a smattering of blog post updates, some website content changes, and a new blog post announcing the change. I am the company's lone writer
https://media.giphy.com/media/YHpmahJgMjxL6S29Au/giphy.gif

New #Documentation: Geo-blocking UK users in #BunnyCDN

I've got a site that, I think, #Ofcom _could_ decide falls under Part 5 of the #OnlineSafetyAct (actually, more accurately, I can't say definitively enough that they wouldn't).

I'm not willing to pay any money to the Age Verification industry, or let them have visitor data.

So, I've decided to move the site definitively out of scope by ensuring it doesn't have UK users

The post describes how to geoblock the UK

https://www.bentasker.co.uk/posts/documentation/general/geoblocking-uk-users-with-bunnycdn.html

How do you document your homelab?

Do you have a structured system for keeping track of your setups? Are you a meticulous curator of computer configurations? A dotfile dilettante? A network note-taker?

I'm looking for sustainable, open-source-friendly ways to document and templatize system and network setups. I really am only interested in something easy to maintain, not tied to a specific proprietary tool, and useful for both tracking infrastructure state and making changes over time.

How do you manage this? Markdown wikis? Git-based IaC? YAML sprawl? Hand-etched stone tablets? Drop your thoughts, workflows, or favorite tools!

The #OPENRNDR guide build process is now even more automated than before.

Starting today, if a commit is tagged and pushed to the repo, the guide is built and released at https://guide.openrndr.org/, including over 130 auto-generated screenshots and videos.

Then the example programs are extracted and published to https://github.com/openrndr/openrndr-examples

Now we can focus on writing documentation and the publication is automatic

It has been [0] days since I wished every command line program had as its first example the simplest way to use it to do something useful.

For example: the "cp" program in Unix:

cp input.txt output.txt

More intricate use cases can also have examples, but start with the simplest.

No, it's not enough to assume readers will figure it out from the man page SYNOPSIS.

BookStack v24.12 is now here with:

New import/export ZIP format
Improvements for new WYSIWYG editor
REST API enhancements
+ many fixes & improvements

https://www.bookstackapp.com/blog/bookstack-release-v24-12/

In my previous job I was occationally reading Microsoft Azure documentation and always complained that it's bad - written poorly, no proper structure and highlights. I guess there's why

Thanks for the contribution here and appreciate your attention to detail. We have decided to keep as-is.. part of that decision is that more and more folks are using AI chat to access guidance and tables don't always translate well in that context.

Microsoft prefers bots over people as primary documentation consumers

As mentioned by @davidgerard

Encore une "mine d'or" pour les amateurs de trains britanniques, la Barrowmore Model Railway society propose une large collection de recueils de diagrammes des automotrices, autorails, voitures, ... et divers règlements de British Rail. Bref, une adresse pour ceux qui font du modélisme et/ou qui s'intéresse aux trains UK.

Another "goldmine" for enthusiasts of British trains, the Barrowmore Model Railway Society hosts a large collection of Diagram Books for EMUs, DMUs, Coaching stock, ... as a lot of British Rail Staff instructions Books. Well, a good address for railway modellers and/or who's interested in UK's trains.

http://www.barrowmoremrg.co.uk/Prototype.html

@trains #railways #railway #documentation #chemins_de_fer #trains

The PHP manual has learned a new trick, you can now run the code right in the browser!

Thanks to @soyuka for the implementation!

Deux sites pour ceux qui sont intéressés par les trains et trams belges :

1. La bibliothèque virtuelle du Train World, le musée national des chemins de fer Belges où l'on trouve numérisé pas mal de littérature ferroviaire et notamment les excellents ouvrages rédigés par Mr. Vandenberghen, ingénieur SNCB, qui publia dans les années 1980 sur l'électrification du réseau et le matériel moteur électrique.

Lien spécifique pour ces ouvrages : https://nmbs.adlibhosting.com/results

Lien général de la bibliothèque de Train World : https://nmbs.adlibhosting.com/search/simple

2. Le grenier ferroviaire de Patrick DGRR, auquel je contribue de temps à autres par la mise à disposition de documents, on y trouve des anciens horaires, des catalogues de constructeurs, archives en tout genre tant sur les trains que sur les métros, trams, bus, ... : https://www.tassignon.be/trains/documentation/documentation.php#gsc.tab=0

Two websites for those of you who are interested in Belgian trains and trams:

1. The virtual library of Train World, the national museum of Belgian railways where you can find a lot of railway literature and in particular the excellent works written by Mr. Vandenberghen, an SNCB engineer, who published in the 1980s on the electrification of the network and rolling stock.

Specific link for these works: https://nmbs.adlibhosting.com/results

Train World Library General Link: https://nmbs.adlibhosting.com/search/simple

2. Patrick DGRR's railway attic, to which I contribute from time to time by making documents available, there are old timetables, manufacturers' catalogues, archives of all kinds on trains as well as on metros, trams, buses,...: https://www.tassignon.be/trains/documentation/documentation.php#gsc.tab=0

New #Documentation: Mini Cooper: Removing Valve Cover
Author: Ben Tasker

https://www.bentasker.co.uk/posts/documentation/vehicles/replacing-the-rocker-cover-on-a-mini-cooper.html?utm_source=rss

You know what's frustrating?

People who announce FOSS software and drop a github link, but don't say anywhere, including in the github readme:

1) what environments the software will run in

2) which files you should download from github

3) what we should do with those files to get them to do something

We're not all programmers. I'm an old-head computer-toucher but I don't know how to use your mix of folders and loose random files.

Some #developers: "No need to write #documentation. It's obvious to customers how to use it."

#dxday Early Bird Tickets are now available!

Don't miss the opportunity to participate at dxday at the best possible price!

Only 50 tickets available!
https://bit.ly/48Z7CuX

#DeveloperProductivity #AI #coding #IDP #Onboarding #DevEx #EphemeralEnvironments #Documentation #remotedevelopment #community #conference #networking
---
dxday2025 | Exploring and enhancing Developer Experience (DX) 
The event is international, and all sessions will be in English.
Bologna | March 13, 2025