@samccann Maybe an entry for the package docs on the left nav would be useful? For sure we want to avoid fragmentation with the package docs or confusion and what I feel like you’re saying - at least in part - is that it isn’t clear enough how this page relates back to the Ansible package docs?
To recap a bit, the ideal outcome is to end up with:
docs.ansible.com/ansible
docs.ansible.com/ansible-core
docs.ansible.com/ecosystem
docs.ansible.com/molecule
- …
The end goal is to have all project documentation available under the docs.ansible.com
subdomain.
We could host everything on readthedocs and add the CNAME to the “ansible” namespace. There has been some reluctance from the community to go this route with the package docs so it would need to go to a vote. Before we can even do that we need to tackle the build and tame down the resource consumption. The full sphinx build for “webdocs” needs a chonky host. As it stands now the build puts us in the range of the RTD enterprise plan, which is quite costly (note that the Ansible community at Red Hat supports RTD with a gold membership).
Anyway switching to RTD could banjax SEO for the package docs. That belongs to the community and is very valuable. Right now there is some work going on to examine a proxy configuration on the http server so that docs.ansible.com/ansible-core
→ readthedocs.io/projects/ansible-core
. If this experiment is successful then we can safely move the core docs to RTD hosting. That content joins the rest of the ecosystem. We’d also have a way forward with the package docs pending all the work to break that build down, which we’ll figure out. Porting the makefile over to nox is likely to be a good way forward here and will allow us to do things in stages.
We’ve also looked at ecosystem.ansible.com
. There’s a hackmd or gh issue around here some place with the details. IIRC the TL;DR is that’s a reasonable backup move but not the ideal outcome because it leaves the Ansible documentation split. The package is part of the ecosystem too. And once that subdomain gets created…
@Leo I get what you mean with the same guide appearing in each project but that raises maintenance issues and the need to single-source. That also results in multiple entry points for users which makes it more difficult to provide guided signposts through content.