Cleaning up Links and References in Ansible Documentation

Archives Ansible Project
1

Dear Team,
Hope every one safe there.

I would like to start some cleaning up on Ansible Documentation (https://docs.ansible.com/) where we have so many links pointing to unmaintained version of documentations.
Eg:

Page: https://docs.ansible.com/ansible/latest/plugins/connection.html
"paramiko SSH " link is pointing to an unmaintained version link (https://docs.ansible.com/ansible/2.8/plugins/connection/paramiko_ssh.html#paramiko-ssh-connection), instead of the latest collection information.

  1. Could anyone guide me that if this is okay to add entry there with latest link ?
  2. Could you share some guideline for adding link to different page instead of simple :ref:paramiko SSH<paramiko_ssh_connection>

Thank you.

Gineesh
https://www.linkedin.com/in/gineesh/

2

Hi Gineesh,

Thanks for reading the documentation carefully. Could you please raise an issue against ansible/ansible repo, so that we can track this?

3

Sure, I will raise an issue as well.
But could you please share some guidelines on link/reference creation in ansible documentation ?
I couldn’t find a proper one.

4

Please see the issue raised here.
https://github.com/ansible/ansible/issues/74807

5

Hi Gineesh,

Ansible Documentation is written in RsT and Sphinx is used to generate the documentation.

You might want to read -

  1. https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html?#cross-referencing-arbitrary-locations
  2. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks
6

Wonderful ! Thank you Abhijeet,
I will try my best (I have listed out some locations; will see how can I help on this.)

Thank you

Gineesh