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 On Mon, May 24, 2021 at 3:18 PM Gini Gangadharan <[email protected]> wrote: > 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. > > > *Gineesh* > linkedin.com/in/gineesh <https://www.linkedin.com/in/gineesh/> > > > On Mon, 24 May 2021 at 17:45, Abhijeet Kasurde <[email protected]> > wrote: > >> Hi Gineesh, >> >> Thanks for reading the documentation carefully. Could you please raise an >> issue against `ansible/ansible` repo, so that we can track this? >> >> On Mon, May 24, 2021 at 3:09 PM Gini Gangadharan <[email protected]> >> wrote: >> >>> 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 >>> <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), >>> 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/ >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "Ansible Project" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to [email protected]. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/ansible-project/78f7ae5e-f0ba-473c-881a-25689cf8aecen%40googlegroups.com >>> <https://groups.google.com/d/msgid/ansible-project/78f7ae5e-f0ba-473c-881a-25689cf8aecen%40googlegroups.com?utm_medium=email&utm_source=footer> >>> . >>> >> >> >> -- >> Thanks, >> Abhijeet Kasurde >> >> -- >> You received this message because you are subscribed to a topic in the >> Google Groups "Ansible Project" group. >> To unsubscribe from this topic, visit >> https://groups.google.com/d/topic/ansible-project/wzAWKLEixJY/unsubscribe >> . >> To unsubscribe from this group and all its topics, send an email to >> [email protected]. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/ansible-project/CAFwWkHorvdVjS1iDvOa%3DcDuJ1dfhfgCWsNRLOQaJD_NaC%2B4mUw%40mail.gmail.com >> <https://groups.google.com/d/msgid/ansible-project/CAFwWkHorvdVjS1iDvOa%3DcDuJ1dfhfgCWsNRLOQaJD_NaC%2B4mUw%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> > -- > You received this message because you are subscribed to the Google Groups > "Ansible Project" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/ansible-project/CAH5GZWOsXbAg8zZnoajqKsxn9Y3WQ4TXF-A7twO--xFrvE4U5g%40mail.gmail.com > <https://groups.google.com/d/msgid/ansible-project/CAH5GZWOsXbAg8zZnoajqKsxn9Y3WQ4TXF-A7twO--xFrvE4U5g%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > -- Thanks, Abhijeet Kasurde -- You received this message because you are subscribed to the Google Groups "Ansible Project" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/CAFwWkHrL1aVsYULvyXrn6n4coA9R5xmbW2no_Yj5eOz8Lh9Osw%40mail.gmail.com.
