Moving the community ee content to package docs

Project Discussions
, ,
1

Hi all.

@Andersson007 and I have recently been talking about the community ee content in the ecosystem docsite.

It seems like a good time to rethink things and move the community ee content back into the package docs. This is where we placed the content initially and there is still a section in the nav.

Here is a summary of the proposed change:

  • Community ee content moves to the Getting started with Execution Environments section in package docs.
  • Remove the http redirects.

The justification for this is two-fold. Firstly, we now have a path to fully migrate all Ansible documentation, including the package docs, to Read The Docs (RTD) hosting. At the time that we moved the community ee content, it didn’t look like it would be possible to get package docs on to RTD. Happily enough, and with lots of help from the community, we’ve been able to publish the package docs on RTD.

At the time we had a vision for a set of Ansible ecosystem docs on RTD alongside the core and package docs on docs.ansible.com. With the ability to publish everything on RTD, it’s better to keep everything together. It’s always better to avoid a split and cause fragmentation. In fact “de-fragging” the docs has been a central goal behind a lot of the effort put into the docsites on RTD.

The second thing here is that the ecosystem docsite just didn’t really turn into the set of cross-project How Tos and Tutorials that I set out to achieve. Whatever the reasons, that content hasn’t really come together.

The fact is the “ecosystem docsite” is also getting in the way of the full RTD migration. Now that package docs are up and running, the last thing to move over are the landing pages that you currently get on docs.ansible.com. It makes sense to put them at the top-level of all the projects, which happens to ansible.readthedocs.io. Once we have the landing pages set up, we’ll effectively have everything ported over to RTD except for the docs.ansible.com subdomain. We’ve got a plan for that too but that’s for another time.

So, TL;DR. We’ll move the community ee content from ansible.readthedocs.io to the package docs and replace it with the landing pages from docs.ansible.com.

If you have any questions, concerns, or thoughts, please let us know. Thanks for your patience and continued support!

3 Likes