Better 404 page for docs.ansible.com/ansible

[acozine]

SUMMARY

Edited after the Docs Working Group meeting April 9 2019:

As a user, when I request a URL that does not exist, I would like a useful 404 page that gives me some navigation options and, if possible, information about the versions available and helpful hints.

Minimum requirements:

• add https://pypi.org/project/sphinx-notfound-page/ to the ansible docs project
• build a 404 page for the devel branch
• test that we can reach docs.ansible.com/ansible/devel/404.html and navigate from there to other places on the docsite

Once those requirements are met, we'll need to configure the webserver to serve up that page for 404s on the /ansible subdirectory and think about the multiple-version complications.

Some documentation pages do not exist in all our currently-supported versions - for example the documentation contributions page exists in devel but not in 2.6.

As a user, I want to navigate easily from one version of the documentation to another. I also want to understand where I am in the docsite.

ISSUE TYPE

• Documentation Report

COMPONENT NAME

docs.ansible.com

ANSIBLE VERSION

2.8

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

ADDITIONAL INFORMATION

Related to #45651, #41782, #37049, #28553, and ansible/proposals#60.

[ansibot]

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

@acozine: Greetings! Thanks for taking the time to open this issue. In order for the community to handle your issue effectively, we need a bit more information.

Here are the items we could not find in your description:

• issue type
• ansible version
• component name

Please set the description of this issue with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/ISSUE_TEMPLATE.md

click here for bot help

[acozine]

Per discussion at the Docs Working Group today, we're looking at using https://pypi.org/project/sphinx-notfound-page/ for this improvement.

[acozine]

Extra points for incorporating cowsay:

/ this is not the page you are looking
\ for /

     \   ^__^
      \  (oo)\_______
         (__)\       )\/\
             ||----w |
             ||     ||

[maxwell-k]

This was discussed at the DaWG working group today: https://meetbot.fedoraproject.org/ansible-docs/2019-05-14/

This will block any version changer, or saying the same thing another way this must be resolved before merging #55655 (demo at http://docs.testing.ansible.com/ansible/latest/index.html)

The solution will need to be backported so that 2.6, 2.7, 2.8, and the devel branch all have the custom 404.

An example of a page that needs a custom 404 is http://docs.testing.ansible.com/ansible/2.6/scenario_guides/cloud_guides.html.