Skip to content

Commit

Permalink
docs: Add link to contributing to docs
Browse files Browse the repository at this point in the history
On the page for contributing to the docs, there is no direct link
to the docs source code.  This change adds a link to the top of
that page.
  • Loading branch information
catmsred committed Jan 2, 2024
1 parent 82162cb commit e80db72
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/rtd/development/contribute_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ Contribute to our docs
Style guide <style_docs.rst>
Directory layout <docs_layout.rst>

The documentation for cloud-init is hosted in GitHub and rendered on
`Read the Docs`_. It is mostly written in reStructuredText.
The documentation for cloud-init is hosted in the
`cloud-init GitHub repository`_ and rendered on `Read the Docs`_. It is mostly
written in reStructuredText.

The process for contributing to the docs is largely the same as for code,
except that for cosmetic changes to the documentation (spelling, grammar, etc)
Expand Down Expand Up @@ -65,6 +66,7 @@ reviewer.

.. LINKS
.. include:: ../links.txt
.. _cloud-init GitHub repository: https://github.com/canonical/cloud-init/tree/main/doc/rtd
.. _Read the Docs: https://readthedocs.com/
.. _tools/.github-cla-signers: https://github.com/canonical/cloud-init/blob/main/tools/.github-cla-signers
.. _tagging s-makin: https://github.com/s-makin

0 comments on commit e80db72

Please sign in to comment.