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

Figure out a way to version published documentation. #276

Closed
nfachan opened this issue May 3, 2024 · 1 comment
Closed

Figure out a way to version published documentation. #276

nfachan opened this issue May 3, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@nfachan
Copy link
Collaborator

nfachan commented May 3, 2024

There are at least two reasons I want this.

First, it could be useful for a user to go back to an older version of the documentation if they're running an older version of the software. They may have a reason for not updating their software.

Second, when new features are added, or changes are made, we'd like to update the documentation concurrent with the changes. But if that immediately publishes to the public documentation, users are going to be confused because the documentation doesn't match their software.

At the very least, I want to come up with a solution to the second problem. If we're just solving this problem, we may just want to not publish the documentation automatically in CI, and instead have publishing it be a part of releasing.

@nfachan nfachan added the documentation Improvements or additions to documentation label May 3, 2024
@nfachan nfachan added this to the Someday milestone May 3, 2024
@nfachan nfachan self-assigned this Jul 11, 2024
@nfachan nfachan modified the milestones: Someday, 0.11.0 Jul 11, 2024
@nfachan
Copy link
Collaborator Author

nfachan commented Jul 11, 2024

Okay, we now have this.

In doc/book there are subdirectories, one for each version, plus a symlink for latest.

@nfachan nfachan closed this as completed Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant