Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs automatically/periodically update when new software versions are release (e.g., lotus, go) #2348

Open
BigLep opened this issue Jan 10, 2025 · 2 comments
Assignees

Comments

@BigLep
Copy link
Member

BigLep commented Jan 10, 2025

Done Criteria

When a new version of critical software referenced in the docs (e.g., lotus, go) is released, the docs should update to reference this version instead of a static outdated version from the paste. This update should come through as a PR that gets reviewed/approved.

Why Important

Many docs.filecoin.io docs are for helping users get started. We won't want to start them off on the wrong foot using outdated versions.

User/Customer

  1. Doc consumers so they get accurate / updated information
  2. Doc maintainers so they don't have to do manual updates

Notes

  1. At least as of 2025-01-10, https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node is a good example. It references lotus v1.29 even though that is from a previous network version.
  2. A github action workflow where this is done for lotus docs is https://github.com/filecoin-project/lotus-docs/blob/main/.github/workflows/update-version.yml . It handles lotus, lotus-miner, and go. Here is a sample PR it created: Bump Lotus versions (node=1.31.0, miner=1.31.0, go=1.22.7) lotus-docs#775 . (Lotus Docs is using Hugp templating I think for referencing these values. I assume something similar can be done for GitBook.)
  3. Here is an example for ipfs-docs: https://github.com/ipfs/ipfs-docs/blob/main/.github/workflows/update-on-new-ipfs-tag.yml
@BigLep
Copy link
Member Author

BigLep commented Jan 10, 2025

@lanzafame @smagdali : given your engagement on #2312 , is this something you think you would take on?

Cc @rjan90 as FYI given past discussions we've had in the Lotus release process about updating corresponding docs when new Lotus versions are released.

@smagdali
Copy link
Member

Yes, I've wanted to have this happen forever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants