# Cleaning up Links and References in Ansible Documentation

**URL:** <https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215>\
**Category:** Ansible Project\
**Created:** [May 24, 2021, 9:38am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215 "2021-05-24T09:38:56Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![gineesh](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/gineesh/32/956_2.png) [@gineesh](https://forum.ansible.com/u/gineesh)\
**Post date:** [May 24, 2021, 9:38am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/1 "2021-05-24T09:38:56Z")

</div>

Dear Team,  
Hope every one safe there.

I would like to start some cleaning up on Ansible Documentation ([https://docs.ansible.com/](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](https://docs.ansible.com/ansible/latest/plugins/connection.html)  
"[paramiko SSH](https://docs.ansible.com/ansible/2.8/plugins/connection/paramiko_ssh.html#paramiko-ssh-connection) " link is pointing to an unmaintained version link ([https://docs.ansible.com/ansible/2.8/plugins/connection/paramiko\_ssh.html#paramiko-ssh-connection](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/](https://www.linkedin.com/in/gineesh/)

---

<div class="post-metadata">

**Author:** ![Akasurde](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/akasurde/32/230_2.png) [@Akasurde](https://forum.ansible.com/u/Akasurde)\
**Post date:** [May 24, 2021, 9:44am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/2 "2021-05-24T09:44:46Z")

</div>

Hi Gineesh,

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

---

<div class="post-metadata">

**Author:** ![gineesh](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/gineesh/32/956_2.png) [@gineesh](https://forum.ansible.com/u/gineesh)\
**Post date:** [May 24, 2021, 9:47am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/3 "2021-05-24T09:47:53Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![gineesh](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/gineesh/32/956_2.png) [@gineesh](https://forum.ansible.com/u/gineesh)\
**Post date:** [May 24, 2021, 10:00am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/4 "2021-05-24T10:00:56Z")

</div>

Please see the issue raised here.  
[https://github.com/ansible/ansible/issues/74807](https://github.com/ansible/ansible/issues/74807)

---

<div class="post-metadata">

**Author:** ![Akasurde](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/akasurde/32/230_2.png) [@Akasurde](https://forum.ansible.com/u/Akasurde)\
**Post date:** [May 24, 2021, 10:02am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/5 "2021-05-24T10:02:01Z")

</div>

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](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](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks)

---

<div class="post-metadata">

**Author:** ![gineesh](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/gineesh/32/956_2.png) [@gineesh](https://forum.ansible.com/u/gineesh)\
**Post date:** [May 24, 2021, 10:04am UTC](https://forum.ansible.com/t/cleaning-up-links-and-references-in-ansible-documentation/35215/6 "2021-05-24T10:04:14Z")

</div>

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