diff options
| author | James Falcon <james.falcon@canonical.com> | 2021-11-22 17:17:26 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-22 16:17:26 -0700 |
| commit | b36b4e2fde2c76958880bad27ba1d1a44fdf320d (patch) | |
| tree | cd671ec70238a2a317a88e216c6522ad0c1ac79d /doc/rtd | |
| parent | 31daf6670aeeba1d452c70bc0d4d04139652be36 (diff) | |
| download | vyos-cloud-init-b36b4e2fde2c76958880bad27ba1d1a44fdf320d.tar.gz vyos-cloud-init-b36b4e2fde2c76958880bad27ba1d1a44fdf320d.zip | |
docs: Rename HACKING.rst to CONTRIBUTING.rst (#1118)
This is more consistent with other github repositories, and will prompt
a first-time contributor to read the contributing guidelines before
submitting the pull request.
Additionally, added a summary section to the top, updated some outdated
language, and removed some outdated typing guidance.
Diffstat (limited to 'doc/rtd')
| -rw-r--r-- | doc/rtd/index.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/contributing.rst | 2 | ||||
| -rw-r--r-- | doc/rtd/topics/hacking.rst | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index 69cf2068..251a904d 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -68,7 +68,7 @@ Having trouble? We would like to help! :titlesonly: :caption: Development - topics/hacking.rst + topics/contributing.rst topics/code_review.rst topics/security.rst topics/debugging.rst diff --git a/doc/rtd/topics/contributing.rst b/doc/rtd/topics/contributing.rst new file mode 100644 index 00000000..c9e88dbb --- /dev/null +++ b/doc/rtd/topics/contributing.rst @@ -0,0 +1,2 @@ +.. include:: ../../../CONTRIBUTING.rst +.. vi: textwidth=78 diff --git a/doc/rtd/topics/hacking.rst b/doc/rtd/topics/hacking.rst deleted file mode 100644 index 5ec25bfb..00000000 --- a/doc/rtd/topics/hacking.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: ../../../HACKING.rst -.. vi: textwidth=78 |