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

Create redirects for AWX/Controller docs #184

Open
2 tasks
samccann opened this issue Sep 11, 2023 · 7 comments
Open
2 tasks

Create redirects for AWX/Controller docs #184

samccann opened this issue Sep 11, 2023 · 7 comments

Comments

@samccann
Copy link
Collaborator

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

  • redirect automation-controller/latest to access.redhat.com when all docs are published at that location.
  • Update docs.ansible.com/platform.html so readers get directed to either access.redhat.com (for Ansible controller) or AWX docs, or the controller archive (for older docs) and translated docs.
@samccann
Copy link
Collaborator Author

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

@samccann
Copy link
Collaborator Author

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

@oraNod
Copy link
Collaborator

oraNod commented Sep 13, 2023

@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
Copy link
Collaborator Author

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

  • 4.5 (and all future versions) will appear as AWX API reference only (nothing after 4.4 will say Ansible Controller)
  • Downstream documentation will point to this AWX API reference as needed (until there is an internal toolchain support for it to appear on access.redhat.com)

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

@oraNod
Copy link
Collaborator

oraNod commented Sep 14, 2023

@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
Copy link
Collaborator Author

@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
Copy link
Collaborator

oraNod commented Sep 14, 2023

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.

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

No branches or pull requests

2 participants