Display versioned manuals on nixos.org #1022
Conversation
There was a problem hiding this comment.
👍 on the intent to show 5 version of documentation for Nix. And thank you for putting in the work @jlesquembre !
But we should improve the implementation, because it puts more work on the marketing team to keep everything in sync. I hope to explain this bellow.
In current situation Nix team has full control what gets deployed to the website, by just pushing to certain branches -> master and latest-release. Then an hourly github action will update the website.
I would like to keep this workflow.
As far as I can understand this PR, this would not be the case anymore, since if a patch release is done for older versions we would need to manually intervene and bump it. This also means that each release we would have to manually bump the versions (since we are showing 5 versions with this PR).
Can we figure it out that his happens automatically without any intervention from anybody.
Maybe this version bump could happen in scripts/update.sh (this is the hourly github action script) keeping website up-to-date.
This reverts commit 97155d7.
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-46/26872/1 |
Manuals for all the version in the nix_versions.json files are generated, but only the 3 previous are displayed on the website. Includes a script, update-nix-versions.py, to update nix_versions.json. New versions are automatically added. The script also updates the patch version (e.g.: if latest 2.13 version is 2.13.3, the script will replace that version with 2.13.4)
|
@garbas thanks for your feedback. |
|
Sorry for taking long to review this, but I have some time planned to review this over the coming weekend. |
|
@garbas no worries, thanks for reviewing it :) |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-06-05-documentation-team-meeting-notes-52/28937/1 |
|
It's very unfortunate how it turned out, but I'm closing this PR. @edolstra suggested to use build artifacts from Hydra instead of rebuilding the manual on this page. @garbas and the @NixOS/documentation-team agreed to move the manuals to nix.dev in the process of reworking nixos.org. @alejandrosame and me will sit down at Ocean Sprint (2023-10-16--20) and implement the manuals part, likely based on this PR. @jlesquembre thank you so much for your help regardless! |
Generate documentation for the latest 3 nix versions. 3 is a random choice, we can change how many versions we want to display.
Screenshot: