diff options
| author | s-makin <sally.makin@canonical.com> | 2022-11-22 20:34:28 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-22 13:34:28 -0700 |
| commit | f1a9e44ecdf74c6f407afedd74454565a1e20948 (patch) | |
| tree | 7354c2ae4f55b5aa69ef9276822cdd0b2db80d63 /CONTRIBUTING.rst | |
| parent | c038808e86306e48eec65b1ab361b7e346f73d35 (diff) | |
| download | cloud-init-git-f1a9e44ecdf74c6f407afedd74454565a1e20948.tar.gz | |
Docs: adding relative links
- index.rst: changed contributing link to :ref:
- found CONTRIBUTING.rst had rtd.io links still in it
- added labels to several topic pages to fix that issue
- changed all of those to :ref: links
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 62628fd5..e9e25499 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,5 @@ +.. _contributing: + Contributing to cloud-init ************************** @@ -17,15 +19,12 @@ Before any pull request can be accepted, you must do the following: * Add your Github username (alphabetically) to the in-repository list that we use to track CLA signatures: `tools/.github-cla-signers`_ -* Add or update any `unit tests`_ accordingly -* Add or update any `integration tests`_ (if applicable) +* Add or update any :ref:`unit tests<testing>` accordingly +* Add or update any :ref:`integration_tests` (if applicable) * Format code (using black and isort) with `tox -e do_format` * Ensure unit tests and linting pass using `tox`_ * Submit a PR against the `main` branch of the `cloud-init` repository -.. _unit tests: https://cloudinit.readthedocs.io/en/latest/topics/testing.html -.. _integration tests: https://cloudinit.readthedocs.io/en/latest/topics/integration_tests.html - The detailed instructions ------------------------- @@ -77,7 +76,7 @@ Follow these steps to submit your first pull request to cloud-init: git remote add upstream git@github.com:canonical/cloud-init.git git push origin main -* Read through the cloud-init `Code Review Process`_, so you understand +* Read through the cloud-init :ref:`Code Review Process<code_review_process>`, so you understand how your changes will end up in cloud-init's codebase. * Submit your first cloud-init pull request, adding your Github username to the @@ -182,14 +181,13 @@ Do these things for each feature or bug - Click 'Create Pull Request` Then, a cloud-init committer will review your changes and -follow up in the pull request. Look at the `Code Review Process`_ doc +follow up in the pull request. Look at the :ref:`Code Review Process<code_review_process>` doc to understand the following steps. Feel free to ping and/or join ``#cloud-init`` on Libera irc if you have any questions. .. _tox: https://tox.readthedocs.io/en/latest/ -.. _Code Review Process: https://cloudinit.readthedocs.io/en/latest/topics/code_review.html Design ====== |