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

Implemeent versioning for the documentation #7

Open
erezrokah opened this issue Nov 25, 2019 · 5 comments
Open

Implemeent versioning for the documentation #7

erezrokah opened this issue Nov 25, 2019 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@erezrokah
Copy link

To avoid confusion, we should have some indication in the documentation Website to which version they are relating to (e.g. current documentation site is relevant for the latest beta version).

@rl-saen
Copy link

rl-saen commented Nov 26, 2019

(e.g. current documentation site is relevant for the latest beta version).

The documentation directly available at netlifycms.org should be for the most current stable release.
A select (widget) could control which specific doc version to display but the default should be the stable version.

@erezrokah
Copy link
Author

erezrokah commented Nov 26, 2019

(e.g. current documentation site is relevant for the latest beta version).

The documentation directly available at netlifycms.org should be for the most current stable release.
A select (widget) could control which specific doc version to display but the default should be the stable version.

Completely agree with the select widget for changing doc versions and that the default docs should represent the latest stable version. As a first step we should at least have some kind of indication for the version (before we add multiple versions).

@rl-saen
Copy link

rl-saen commented Nov 26, 2019

The Jest docs could serve as example:

https://github.com/facebook/jest/tree/master/website/versioned_docs

@martinjagodic martinjagodic transferred this issue from decaporg/decap-cms Feb 2, 2024
@privatemaker
Copy link
Collaborator

Introducing doc versioning will require refactoring. I think this only makes sense if Decap CMS plans to move to a more breaking changes style major releases. When upgrading sites from v2 to v3 I don't recall any issues.

Maybe others experienced breaking changes? @martinjagodic can you comment on the future release style plans? Otherwise I vote to not implement such a style docs.

@privatemaker privatemaker changed the title feat: Label docs with corresponding version Implemeent versioning for the documentation Feb 15, 2024
@privatemaker privatemaker added the documentation Improvements or additions to documentation label Feb 15, 2024
@martinjagodic
Copy link
Member

I think this is a good idea long-term, but it's not a priority right now. Some breaking changes will occur with the next major version which will include the UX redesign.

Let's keep this open for that phase.

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

4 participants