ansible / docsite

Static HTML and assets for docs.ansible.com
18 stars 15 forks source link

Create redirects for AWX/Controller docs #184

Open samccann opened 1 year ago

samccann commented 1 year ago

There are two efforts currently happening on the AWX and controller docs: 1 - Converting existing controller docs on docs.ansible.com to AWX docs 2 - Red Hat is converting those same docs to access.redhat.com to make it more obvious they are official product documentation for the Ansible controller.

Once these efforts complete, we need to put in redirects so those looking for AWX docs can find them in their new home, and those looking for Ansible Controller docs can find them in their new home.

The current plan is to

samccann commented 1 year ago

@oraNod - to clarify all older controller docs as well as all translations stay on docs.ansible.com right?

samccann commented 1 year ago

oh and the CLI/API docs that aren't currently getting converted to access.redhat.com

oraNod commented 1 year ago

@samccann Yes, all the 4.4 and earlier controller docs + translations will remain on docs.ansible.com. We'll prune anything that is EOL though and keep only supported versions linked.

When I say linked I mean there will be a link to a given supported html page on the web server. The EOL pages will still be available on the web server, just not linked from docs.ansible.com.

The generated API reference will also be available for 4.4 and previous supported version. For anything 4.5+ I guess there will be no downstream equivalent until the publishing toolchain can handle that. But the downstream docs can always point to the AWX docs in community.

samccann commented 1 year ago

Just to be sure I'm understanding you wrt the API reference:

I'll doublecheck whether downstream is converting the CLI guide as well.

oraNod commented 1 year ago

@samccann I think it's more precise to say there will be no 4.5 doc versions in community or on "docs.ansible.com". There will only be AWX latest docs and whatever that downstream team have got.

Can you clarify what you mean by CLI guide please? That's not one that I'm aware of.

samccann commented 1 year ago

@oraNod I was basically looking at the list of controller docs at https://docs.ansible.com/platform.html which lists a CLI guide which is not on the short-list for conversion to access.redhat.com.

And trying to figure out if anything stays as 'controller' for 4.5 (aka what will be latest).

As a second question - when there is a 4.6 for AWX, will there be a 4.5 and a latest version? or are we going to a model of providing only latest docs for AWX?

oraNod commented 1 year ago

Oh yeah, that CLI guide. TBH I think we need to organize something with @tvo318 when she returns from PTO.

Only latest docs for AWX.