-
Notifications
You must be signed in to change notification settings - Fork 643
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] Use "stable" version as default version #1692
Comments
Thanks for merging #1693, this issue is 50% done. If admins agree with my proposal, could you please perform the following task?
|
@kurokobo Hi, apologies for the bit of delay here as I've been traveling. I switched the default version in readthedocs to the stable build and verified the changes. @thedoubl3j and @fosterseth On a related note, should I add either of you or anyone else as a maintainer in readthedocs so I'm not a bottleneck for these sorts of changes? Thanks! |
@oraNod |
@kurokobo I think that since we have such a fast release cadence, and to reduce confusion about which users should be looking at, we could just keep the single |
@kurokobo Yes, I guess this was partly my mistake as well. Hopefully I didn't give you a wrong impression by enabling the stable version. You had made some valid points but it was something that I should have discussed more thoroughly with the wider team first. My apologies for any confusion and thanks again! |
@rooftopcellist @oraNod Thanks for pointing that out, I want to respect your team's decision so there is completely no problem to revert the changes! |
Please confirm the following
Feature Summary
The current documentation has two versions;
latest
andstable
, and "default version" is configured aslatest
.This means:
latest
follows upstreamdevel
branch, andstable
follows the latest tagged release/
, currently/
redirects to thelatest
(/en/latest/
)Since the
latest
follows upstreamdevel
branch, it may contain unreleased feature. This can cause users to not be able to use Operator as documented and be confusing to users, such as the issue #1691.My suggestions are:
README.md
to pointhttps://awx-operator.readthedocs.io/
(means/
) orhttps://awx-operator.readthedocs.io/en/stable/
instead oflatest
: Done by chore: update docsite link to not include version #1693stable
(this can viaAdmin
>Advanced Settings
on the project page on the Read the Docs)The text was updated successfully, but these errors were encountered: