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

Ansible version 2.3 documentation should warn for outdated and link to latest #67008

Closed
zeitounator opened this issue Feb 1, 2020 · 4 comments
Labels
affects_2.3 This issue/PR affects Ansible v2.3 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@zeitounator
Copy link
Contributor

zeitounator commented Feb 1, 2020

SUMMARY

I lately came across people referencing old documentation links by mistakes on help / forums / Q&A sites. Actually, some old pages still come in pretty high ranks when researching. I don't remember all the past links I have seen but from memory they tend to link to version 2.3 documentation.

Latest example I can give: ansible stop playbook on any error researched on https://www.qwant.com this morning gave me as third result => https://docs.ansible.com/ansible/2.3/playbooks_error_handling.html

On that page, there is no warning you are viewing an outdated version of the documentation as you can find in all other outdated version (did not thoroughly test all of them but 2.3 seems the only one). Worse: if you look at the top left, it tells you to consult the archive for even older documentation, which could let you think you are actually seeing the most up-to-date version.

The same warning and latest link should be added to this version as well if it is still online.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

!component
N/A: all documentaion seems affected

ANSIBLE VERSION

Ansible version 2.3 documentation (https://docs.ansible.com/ansible/2.3/)

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

ADDITIONAL INFORMATION

Adding the latest link on 2.3 outdated docs would be very valuable for people landing there by mistake and would probably help to raise the rank of the latest doc links on search engines as well as lowering it for those outdated ones.

@ansibot
Copy link
Contributor

ansibot commented Feb 1, 2020

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 ansibot added affects_2.3 This issue/PR affects Ansible v2.3 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 1, 2020
@sivel sivel removed the needs_triage Needs a first human triage before being processed. label Feb 13, 2020
@ansibot
Copy link
Contributor

ansibot commented Apr 29, 2020

Files identified in the description:

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

click here for bot help

@acozine
Copy link
Contributor

acozine commented Dec 2, 2020

Thanks @zeitounator for filing this issue - we have fixed it at last!

Closed by #72760. 2.3 docs now have a banner:

Screen Shot 2020-12-01 at 6 37 56 PM

@acozine acozine closed this as completed Dec 2, 2020
@zeitounator
Copy link
Contributor Author

Thanks for the personalised feedback, and glad I could contribute to enhance the documentation. Cheers.

@ansible ansible locked and limited conversation to collaborators Dec 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.3 This issue/PR affects Ansible v2.3 docs This issue/PR relates to or includes documentation. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

No branches or pull requests

4 participants