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] Use "stable" version as default version #1692

Closed
5 tasks done
kurokobo opened this issue Jan 24, 2024 · 6 comments
Closed
5 tasks done

[DOCS] Use "stable" version as default version #1692

kurokobo opened this issue Jan 24, 2024 · 6 comments
Assignees

Comments

@kurokobo
Copy link
Contributor

kurokobo commented Jan 24, 2024

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • I understand that AWX Operator is open source software provided for free and that I might not receive a timely response.

Feature Summary

The current documentation has two versions; latest and stable, and "default version" is configured as latest.

This means:

Since the latest follows upstream devel 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:

  • Update the link on the README.md to point https://awx-operator.readthedocs.io/ (means /) or https://awx-operator.readthedocs.io/en/stable/ instead of latest: Done by chore: update docsite link to not include version #1693
  • Configure "default version" to stable (this can via Admin > Advanced Settings on the project page on the Read the Docs)
@kurokobo
Copy link
Contributor Author

Thanks for merging #1693, this issue is 50% done.

If admins agree with my proposal, could you please perform the following task?

Configure "default version" to stable (this can via Admin > Advanced Settings on the project page on the Read the Docs)

@oraNod
Copy link
Contributor

oraNod commented Feb 6, 2024

@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. awx-operator/en/stable/ should be the default now and currently corresponds to the 2.11 tag. Please take a look and confirm.

@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!

@kurokobo
Copy link
Contributor Author

kurokobo commented Feb 6, 2024

@oraNod
Hi, I'm sure you had a great travel😃 Thanks for working on this!
Confirmed that the link in README.md redirects stable version of the docs, so will close this issue. Thanks!

@kurokobo kurokobo closed this as completed Feb 6, 2024
@rooftopcellist
Copy link
Member

@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 latest docs stream. That way it will also remain consistent with the other repos.

@oraNod
Copy link
Contributor

oraNod commented Feb 22, 2024

@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!

@kurokobo
Copy link
Contributor Author

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants