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

[Epic] Open up the Ansible package docs publishing outside of RH #179

Closed
samccann opened this issue Jul 14, 2023 · 4 comments
Closed

[Epic] Open up the Ansible package docs publishing outside of RH #179

samccann opened this issue Jul 14, 2023 · 4 comments
Assignees
Labels

Comments

@samccann
Copy link
Collaborator

Today we're tied to Red Hat being the only people who can publish Ansible package and core documentation to the test site or docs.ansible.com.

This issue tracks the work to open this up to community docs mantainers.

@samccann samccann changed the title Open up the docs publishing outside of RH Open up theAnsible package docs publishing outside of RH Dec 4, 2023
@Spredzy
Copy link
Contributor

Spredzy commented Jan 4, 2024

@oraNod with the move to RTD does that ticket still stand ?

@samccann
Copy link
Collaborator Author

samccann commented Jan 4, 2024

So far, the package docs are not on RTD because (I think) they are a beast to build.

@oraNod oraNod changed the title Open up theAnsible package docs publishing outside of RH Open up the Ansible package docs publishing outside of RH Jan 4, 2024
@oraNod
Copy link
Collaborator

oraNod commented Jan 4, 2024

Yep. We still need to get the package docs to build on RTD or somewhere. I think with the nox tooling we added in the past year we can do it by breaking the build into stages. Hopefully the work to update Sphinx versions will help us move faster and pick up performance improvements.

@samccann samccann added the epic label Mar 5, 2024
@samccann samccann changed the title Open up the Ansible package docs publishing outside of RH [Epic] Open up the Ansible package docs publishing outside of RH Mar 5, 2024
@samccann
Copy link
Collaborator Author

Something we'll need to keep in mind. We currently have redirects between the old 2.9 module pages and the new collection module pages here. This supports the ability for the version switcher to go between latest/devel and 2.9 (or someone hacking the url to go from 2.9 to latest since there is no version switcher anymore on the EOL 2.9).

As part of this, we discovered that any publishing of the Ansible package docs would blow away those redirect folders and we had to tie the docs jenkins build to the docsite jenkins build (to republish the docsite and those redirects whenever we publish the package docs).

NOTE: The jenkins job for the core docs also triggers the docsite jenkins job but may not need to since these redirects don't work on the core docsite anyway (there is no 'core' 2.9).

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

No branches or pull requests

3 participants