-
Notifications
You must be signed in to change notification settings - Fork 18
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
[website] Enable documentation versioning #517
Comments
Docsy features provide navigation between the various versions of the docs and can display an information banner on the archived sites. These mostly control the appearance of the "releases" drop down and does not help in structuring or hosting the documentation. In fact, the docsy site clearly states Netlify does not support this out of the box. They suggest hosting multiple versions using subdomains, or explicitly keeping versioned docs as a copy under the
This is also the recommendation in google/docsy#114 and on hugo discourse. There are numerous other references to this topic (e.g., vsoch/docsy-jekyll#23, jenkins-x/jx-docs#3114, vitessio/website#625 - the last issue is certainly worth a detailed read...) and most come to the same conclusion - use folders as the simpler method. |
Relevant Hugo tweaks needed (e.g., shortcodes and frontmatter):
|
The use of folders requires that we define
For example: Structure
Process (example: release v0.2.0 from "main", v0.1.0 exists)
|
possible approach (verify still works correctly after each step):
|
Currently, the https://clusterlink.net website holds only the the latest (
main
) documentation. Thus, it may intermittently diverge from the last ("officially") release code. Despite the project being in the 0.x.y state, and allow breaking changes, we should see if we can enable version based documentation to match release artifacts.There's already Docys support for this.
The text was updated successfully, but these errors were encountered: