News for hackers. Stuff that matters.
Re:Our docs are now built with Starlight instead of Docusaurus by MrDarcy on Tuesday May 27, 2025 @03:16PM (#44109895)
For documentation versioned docs are critical. Docusaurus handles multiple versions extremely well, curious if the author has released a new major version of Glasskube and if not, will they miss this feature in the future.
Re:Our docs are now built with Starlight instead of Docusaurus by pmig on Tuesday May 27, 2025 @04:01PM (#44110207)
It's a good point. I am personally not really a fan of versioned docs. Having a CHANGELOG.md or similar is critical, but how often do you really want to explore the docs in a specific version? And there are also way better options to pinpoint changes. You can think of using git blame instead of clicking through a dozen of point releases of your versioned docs.
Re:Our docs are now built with Starlight instead of Docusaurus by MrDarcy on Tuesday May 27, 2025 @04:15PM (#44110307)
> how often do you really want to explore the docs in a specific version?

All the time. It's inevitable. If you ever sell software in the tools / configuration / package management space to "the enterprise" (which I think you do) then some of your biggest customers are going to be stuck on old versions. They'll need to easily select the version they're running if only to figure out how to upgrade to the version you want them to be running.

Re:Our docs are now built with Starlight instead of Docusaurus by ramoz on Tuesday May 27, 2025 @05:09PM (#44110699)
Literally every day when working on any type of data science or ML task
Re:Our docs are now built with Starlight instead of Docusaurus by IanCal on Tuesday May 27, 2025 @04:14PM (#44110298)
> but how often do you really want to explore the docs in a specific version?

Absolutely any time I'm not using the latest version?

Re:Our docs are now built with Starlight instead of Docusaurus by Aeolun on Tuesday May 27, 2025 @07:55PM (#44111652)
I think the idea is that you shouldn’t ever do that?
Re:Our docs are now built with Starlight instead of Docusaurus by IanCal on Wednesday May 28, 2025 @10:52AM (#44116632)
Never use anything other than the absolute bleeding edge immediately after release? That's frankly wild, and totally ignores that many people release new versions while supporting older ones for transition.
Re:Our docs are now built with Starlight instead of Docusaurus by 0cf8612b2e1e on Wednesday May 28, 2025 @11:43AM (#44117247)
Here I am on my 10+ year old database version thinking, “Damn, why didn’t I think to just not use this thing anymore?”
Re:Our docs are now built with Starlight instead of Docusaurus by joseda-hg on Wednesday May 28, 2025 @02:07PM (#44118899)
So always be on cutting edge of everything?

No testing? No stable? No LTS? No we'll update when the resources are available?

Re:Our docs are now built with Starlight instead of Docusaurus by pixelready on Tuesday May 27, 2025 @05:05PM (#44110665)
The versioned docs for both MUI and Tanstack Query have been very helpful in recent projects I’m working on. Obviously versioned docs are only valuable against major / breaking changes. Changelog is sufficient for non-breaking stuff.

I also really like sites that have site wide settings for code examples in different available languages, package managers, etc. I know this must be a maintenance burden on the teams of those projects but boy do I appreciate it as an implementer.

Re:Our docs are now built with Starlight instead of Docusaurus by dumah on Tuesday May 27, 2025 @05:45PM (#44110908)
It's wild that you are offering your views on software documentation while you think checking git blame is a substitute for retaining documentation, and you don't understand why users would want documentation for old versions.
Re:Our docs are now built with Starlight instead of Docusaurus by tacker2000 on Tuesday May 27, 2025 @06:23PM (#44111175)
Are you serious? In the real world, people dont update software as soon as a new version comes out. Sometimes I am still using an age old version of an app or a framework because the client doesnt want to pay to upgrade, there are dependencies, or whatever…

Having easily accessible documentation for the older versions is a must, for anything that is remotely “serious”.

Just check the Laravel docs for example, or Vue, etc…

Re:Our docs are now built with Starlight instead of Docusaurus by lelandbatey on Tuesday May 27, 2025 @07:32PM (#44111543)
I want versioned docs literally always. I am basically never on the _most_ recent version of a software package, so being able to pick the version of the docs that matches my actual version is genuinely not negotiable.

I never want to "pinpoint changes", I want to avoid documentation totally irrelevant for the version I actually use. Here's a real world example:

Redis.io doesn't let you look up docs for any version but the latest version. The URL for docs has "latest" in the path, but swapping that for a version number just 404s. Let's look at the EXPIRE redis command and how it interacts with HSET, in the context of using Redis to cache some data with a TTL. https://redis.io/docs/latest/commands/expire/

HSET means setting a field of a hash (object/dictionary/map) to a value. EXPIRE means setting the expiration (TTL, time before autodelete) of a particular thing in redis. You can set the expiration for an entire hash in redis, but not for individual fields of that hash. HSET is like an upsert by default; it creates the hash in redis and then populates the given field with the value you set. In your application, it's pretty reasonable to want to have an operation which is like an HSET as an upsert which also sets a maximum expiration time on the parent hash, but only if there's not an expiration time set. Looking at the docs for EXPIRE, you might note that there's a special option you can set which does this exact thing, the NX flag. Thus you can implement a simple "sharded-by-hash upsert with a maximum TTL" by doing an HSET followed by an EXPIRE NX. Great!

Except that is not true! You cannot do that! Read all the paragraphs you want, you won't find this critical note unless you scroll aaaaaalll the way to the bottom of the page, past the "Differences in Redis X.Y.Z", past the Appendix, to the very last little section called "History", which isn't about the history of this page, but is instead a single bullet point of critical information noting the following:

    Starting with Redis version 7.0.0: Added options: NX, XX, GT and LT.
Redis 8 released this month, Redis 7.0.0 released in April 2022. Some version of Redis prior to 7 (6.4) will be explicitly supported by Redis the company till August of this year. I encountered this particular hiccup much further back when it was very reasonable to still be using Redis 6.X

In such a case as this, I desperately wish that I could have clicked a little dropdown and chosen docs for Redis 6 instead of Redis 7, because this caused a serious problem as hashes just weren't expiring at all. It was especially bad because the Redis clients would send those command options to the server and the server would silently drop them, so everything looked completely fine except that the hash keys were being perpetually moved forward and never expiring!

Please version your docs!

Re:Our docs are now built with Starlight instead of Docusaurus by antirez on Wednesday May 28, 2025 @04:16AM (#44113777)
As the person that wrote such documentation, I disagree. Redis is a system that is 99% backward compatible across all versions combinations: Redis 2 was released more than 10 years ago, and this is a very hard to find case where things are not perfectly backward compatible, but still in a case where the Redis 2 semantic was so odd to be avoided in most tasks. Now, in a system like that, to have man pages that tell you the differences among versions is much better than versioned documents where you would require to diff yourself among the different pages. In a single document you know all the behavioral history of a particular command, that often is just: "always as it used to be", plus features that are backward compatible entering newer versions.
Re:Our docs are now built with Starlight instead of Docusaurus by lelandbatey on Wednesday May 28, 2025 @06:51PM (#44121338)
I think a changelog on the page is key, as you say. I also think that having versioned docs does not requires us as users to do diffs manually, that's what a changelog/history is for. Ideally, I'd like to have both: all docs are versioned and all docs have "history" sections.
Re:Our docs are now built with Starlight instead of Docusaurus by truetraveller on Tuesday May 27, 2025 @09:54PM (#44112154)
You're correct. Versioned docs = major maintenance headache. What if you want to add some new content that is applicable to all versions?

Docs are notorious already for not being updated. Adding "versioned docs" exponentially increases the complexity, and makes updating them and reading them far harder. It's a lose/lose, for the writer and the reader.