4
Add versioning to the documentation
Source: directus/directus#22877 · opened by @mungo312
Summary
It would be really awesome to have the docs versioned. Nearly all software projects I know have the docs versioned, so you can get the docs to a specific release.
Currently there is no real chance to get an old version of the docs.
Basic Example
_No response_
Motivation
If I run an old version of directus I want to have the docs for this version, not the latest version.
Especially for breaking changes it is really good to be able to see how things worked before.
Also of you are doing updates it is really helpful to check the old docs to see when things changed.
Detailed Design
The source of the docs is already versioned, even if there is only a very short history, because of some migrations.
Requirements List
Must Have:
• Version selection in the rendered docs
Drawbacks
None
Alternatives
Search the docs source code, which is terrible to do.
Adoption Strategy
Everybody will be happy.
Unresolved Questions
_No response_
It would be really awesome to have the docs versioned. Nearly all software projects I know have the docs versioned, so you can get the docs to a specific release.
Currently there is no real chance to get an old version of the docs.
Basic Example
_No response_
Motivation
If I run an old version of directus I want to have the docs for this version, not the latest version.
Especially for breaking changes it is really good to be able to see how things worked before.
Also of you are doing updates it is really helpful to check the old docs to see when things changed.
Detailed Design
The source of the docs is already versioned, even if there is only a very short history, because of some migrations.
Requirements List
Must Have:
• Version selection in the rendered docs
Drawbacks
None
Alternatives
Search the docs source code, which is terrible to do.
Adoption Strategy
Everybody will be happy.
Unresolved Questions
_No response_
No pledges yet. Be the first to back this.
Comments
Similar requests
Enhancing Directus Flows: Versioning, Archiving, and Improved Manageability
28 votes · 0 comments
Proposed Content Versioning Enhancement for Directus
66 votes · 0 comments
Add more simple `draft` and `publish` versioning mode
36 votes · 0 comments
Documentate how to access content versions by extensions
1 vote · 0 comments
🔍 Integration of Kapa.ai (or similar) for an interactive and intelligent documentation assistan
2 votes · 0 comments
No comments yet.