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

Publish the docs for the latest release instead of master #1518

Closed
cooperbenson-qz opened this issue Sep 16, 2021 · 5 comments
Closed

Publish the docs for the latest release instead of master #1518

cooperbenson-qz opened this issue Sep 16, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@cooperbenson-qz
Copy link
Contributor

Summary

The project documentation should be built from the most recent release instead of master or default to displaying the most recent release and allow users to switch to the master version.

Use Cases

Right now the publically published documentation is built from the master branch, which means it contains documentation for unreleased features. This is extremely confusing for users who can spend hours attempting to use (and then subsequently debug) a missing feature (e.g. #1305). It's very surprising to have a stable project include documentation for unreleased features on its homepage.


Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

@cooperbenson-qz cooperbenson-qz added the enhancement New feature or request label Sep 16, 2021
@jessesuen
Copy link
Member

Agree 100%. We need to do what Argo CD did and use readthedocs to version the docs per branch argoproj/argo-cd#5099

@kostis-codefresh
Copy link
Member

kostis-codefresh commented Sep 21, 2021

I added a first PR #1528 to implement readthedocs building (before actually adding the selector of the versions)

Current result is at https://argo-rollouts.readthedocs.io/en/latest/

kostis-codefresh added a commit to kostis-codefresh/argo-rollouts that referenced this issue Nov 25, 2021
@kostis-codefresh
Copy link
Member

I added another PR #1671 for the selector of versions.

Here is how it looks https://argo-rollouts.readthedocs.io/en/doc-versioning/

drop-down

Currently it is pointing at my own github repo. But when this is merged I will point readthedocs to the Argoproj repo.

The previous versions of Argo Rollouts did not have readthedocs support. The first "official" one that will appear on the repo will be 1.2

@kostis-codefresh
Copy link
Member

@cooperbenson-qz This has been implemented. However since we just added the versioning, only "latest/master" is visible right now. All the next Rollout releases will appear on the drop-down as soon as we release them.

@kostis-codefresh
Copy link
Member

It is now available in production docs starting with 1.2 release
argo-rollouts-version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants