Redirecting index pages in the package docs nav

Hi all,

We’re relocating the Getting Started with Execution Environments content from the package docs to a new ecosystem docsite [1] [2]. As part of this I’m setting up http redirects so that urls such as https://docs.ansible.com/ansible/devel/getting_started_ee/index.html take you to https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html.

This is probably sensible for sub-pages but I wonder if it is best practice for the index page. We want to keep “Getting started with EEs” in the left nav of the package docs. But would it be confusing or unexpected if someone clicks an item in the left nav then gets redirected to a different site?

Thoughts are welcome here or in the PR with redirects[3].

[1] Point EE getting started to ecosystem by oraNod · Pull Request #617 · ansible/ansible-documentation · GitHub
[2] index - Ansible ecosystem documentation
[3] redirect ee getting started docs by oraNod · Pull Request #187 · ansible/docsite · GitHub

My thought was we would not redirect the EE getting started index page. We’d leave that as a stub page that introduces what an EE is and then point to the ecosystem docsite for that guide.

I think this sets us up with findability (we have small intros to any ecosystem docset on our main Ansible docs) without too much clutter on the main Ansible package docs.

1 Like

Thanks @samccann I’ve removed the redirect for the index page from redirect ee getting started docs by oraNod · Pull Request #187 · ansible/docsite · GitHub

@Andersson007 Hey, heads up that I’ll merge Point EE getting started to ecosystem by oraNod · Pull Request #617 · ansible/ansible-documentation · GitHub later today. Just thought I’d ping you again as a final heads up.

As mentioned above I’ve also updated the redirects PR so the index page doesn’t take you to the ecosystem docsite.

@samccann had a good point yesterday in the DaWGs about links to the EE getting started in the package docs so I’m going to go through the logs and adjust all those in a PR later today too. e.g. hhttps://github.com/ansible/ansible-documentation/commit/e6f4c0eb50ad60715fd367241c29a3fabc5d5956

1 Like

Thanks for handling the package docs references. @Andersson007 also updated other projects with links back to the EE getting started. Perhaps he remembers which other projects need updating too? We could always open them as a batch of easyfix items to get community help with cleaning up the rest.

1 Like

@samccann the plan about easyfixes SGTM, here’s a list of places where it can be fixed:

1 Like

Finally opened the easyfix issues for these.
@Dule-martins - I added them to the community-writers board but you’ll want to check each one for the contributor guidelines. They are all different repos so may require things like commit signing etc.