docs: enable versioning feature #374
Merged
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
This will address a common challenge of having staged changes not being visible in the documentation, or the need for banners like
New in X
due to not having docs related to a particular release.mike
inmkdocs.yml
develop
and upon new releasesdevelop
as well as releases e.g., /develop/api, /1.15.0/apilatest
aliasDemo: https://heitorlessa.github.io/powertools-docs-versioning/latest/
This will introduce a
/<version>
in the URLand will break bookmark links, since GH Pages doesn't support redirects. Redirecting might work with mkdocs-redirects plugin, though we might reactively fix it as I'm not sure whether pages have been bookmarked as >90% of customers come straight to index then navigate.Update: Thanks to @saragerion, including a 404.html in the root of GH Pages works to preserve old docs to latest version.
Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.