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

Docs: Versioning considerations #106

Open
AdrianoKF opened this issue Mar 12, 2024 · 0 comments
Open

Docs: Versioning considerations #106

AdrianoKF opened this issue Mar 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@AdrianoKF
Copy link
Contributor

A few observations on the use of docs versions:

  • latest (a pre-release version) is set as the default docs version. This causes the notification banner to be shown - however, the link in the banner links to the default version (i.e., by clicking on it, you are still looking at the pre-release docs).
  • There is only one stable version. Going forward, this might confuse users, who cannot access the docs for previous stable releases.

I propose adopting the same versioning scheme as for lakeFS-spec, with latest as an alias for the latest stable version and set as the default. Pre-releases are labeled as development in that scheme.

@AdrianoKF AdrianoKF added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 12, 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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant