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

Multiple versions #104

Open
karbyshevds opened this issue Feb 25, 2021 · 0 comments
Open

Multiple versions #104

karbyshevds opened this issue Feb 25, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@karbyshevds
Copy link
Contributor

As a operations engineer I'd like to be able to switch between documentation versions. Documentation page should display latest stable release by default but it's also should be a dropdown or any other selector to change documentation version on the fly. That's common practice that required to simplify work with ODAHU system and make it more friendly.

Documentation is build via sphinx and hosted on github pages currently so there are two main options for now:

  1. Use sphinx plugin that allows to generate docs for multiple versions and adds version selector to final result.
    Pros:
    • stay on github pages
      Cons:
    • all documentation should be rebuilt when new version released
    • plugin looks outdated and forks are also seems dead
  2. Migrate to readthedocs.org that can keep multiple versions natively
    Pros:
    • do not require changes for documentation build logic & plugins usage
      Cons:
    • migration
@viravit viravit removed the 1.5 label Jun 25, 2021
@viravit viravit added the documentation Improvements or additions to documentation label Jun 25, 2021
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

3 participants