devguide: make 'contributing' a chapter

This could be justified from a semantic point of view, and also can help
in bringing more attention to where this information is, as it is less
hidden, now.

Also add Dev Guide as one of our resources in our Readme.

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index eaa19b74f9a8a8bcfb962029ae5df90772d78416..f3b58981fdf0c71152affcf99a714d1bd07c9ec5 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -2,7 +2,7 @@ Contributing to Suricata
 ========================
 
 We're happily taking patches and other contributions. The process is documented at
-[Contribution Process](https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html). Please have a look at this document before submitting.
+[Contribution Process](https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html). Please have a look at this document before submitting.
 
 Contribution Agreement
 ----------------------

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 15977b06f540c47c39701acc1abedcd6ca670660..b62c865f966723a33914f0fd4f3387be7f0b3067 100644 (file)
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,7 @@
 Make sure these boxes are signed before submitting your Pull Request -- thank you.
 
 - [ ] I have read the contributing guide lines at
-   https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html
+   https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html
 - [ ] I have signed the Open Information Security Foundation contribution agreement at
    https://suricata.io/about/contribution-agreement/ (note: this is only required once)
 - [ ] I have updated the user guide (in doc/userguide/) to reflect the changes made (if applicable)

diff --git a/README.md b/README.md
index 2b1a213bcbcbdbdbeb873d536887daf29ada7d48..657549be2619587cf08a1d36aa738c09ae910cc1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ developed by the [OISF](https://oisf.net) and the Suricata community.
 - [Home Page](https://suricata.io)
 - [Bug Tracker](https://redmine.openinfosecfoundation.org/projects/suricata)
 - [User Guide](https://docs.suricata.io)
+- [Dev Guide](https://docs.suricata.io/en/latest/devguide/index.html)
 - [Installation Guide](https://docs.suricata.io/en/latest/install.html)
 - [User Support Forum](https://forum.suricata.io)
 
@@ -20,7 +21,7 @@ developed by the [OISF](https://oisf.net) and the Suricata community.
 
 We're happily taking patches and other contributions. Please see our
 [Contribution
-Process](https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html)
+Process](https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html)
 for how to get started.
 
 Suricata is a complex piece of software dealing with mostly untrusted
@@ -105,7 +106,7 @@ change, it will probably go into the next major version.
 __Q: Why was my PR closed?__
 
 A: As documented in the [Suricata GitHub
-workflow](https://docs.suricata.io/en/latest/devguide/codebase/contributing/github-pr-workflow.html),
+workflow](https://docs.suricata.io/en/latest/devguide/contributing/github-pr-workflow.html),
 we expect a new pull request for every change.
 
 Normally, the team (or community) will give feedback on a pull request

diff --git a/doc/userguide/devguide/codebase/index.rst b/doc/userguide/devguide/codebase/index.rst
index f6cb95592cc71eaf780819d6b398d4ecc2e5802a..8f0e493f2057fc63b7097a50238a65ad3c6a7a63 100644 (file)
--- a/doc/userguide/devguide/codebase/index.rst
+++ b/doc/userguide/devguide/codebase/index.rst
@@ -4,7 +4,6 @@ Working with the Codebase
 .. toctree::
    :maxdepth: 2
 
-   contributing/index.rst
    installation-from-git
    code-style
    fuzz-testing

diff --git a/doc/userguide/devguide/codebase/contributing/code-submission-process.rst b/doc/userguide/devguide/contributing/code-submission-process.rst
similarity index 100%
rename from doc/userguide/devguide/codebase/contributing/code-submission-process.rst
rename to doc/userguide/devguide/contributing/code-submission-process.rst

diff --git a/doc/userguide/devguide/codebase/contributing/contribution-process.rst b/doc/userguide/devguide/contributing/contribution-process.rst
similarity index 100%
rename from doc/userguide/devguide/codebase/contributing/contribution-process.rst
rename to doc/userguide/devguide/contributing/contribution-process.rst

diff --git a/doc/userguide/devguide/codebase/contributing/github-pr-workflow.rst b/doc/userguide/devguide/contributing/github-pr-workflow.rst
similarity index 100%
rename from doc/userguide/devguide/codebase/contributing/github-pr-workflow.rst
rename to doc/userguide/devguide/contributing/github-pr-workflow.rst

diff --git a/doc/userguide/devguide/codebase/contributing/index.rst b/doc/userguide/devguide/contributing/index.rst
similarity index 100%
rename from doc/userguide/devguide/codebase/contributing/index.rst
rename to doc/userguide/devguide/contributing/index.rst

diff --git a/doc/userguide/devguide/index.rst b/doc/userguide/devguide/index.rst
index b6b5fbc1c7d378b514057d18df6f6b3dc48548c1..26a83497114fbb8051c281751036fe9ab30cfe43 100644 (file)
--- a/doc/userguide/devguide/index.rst
+++ b/doc/userguide/devguide/index.rst
@@ -5,5 +5,6 @@ Suricata Developer Guide
    :maxdepth: 2
 
    codebase/index.rst
+   contributing/index.rst
    internals/index.rst
    extending/index.rst

diff --git a/doc/userguide/support-status.rst b/doc/userguide/support-status.rst
index 8a870d209a96110cb611c3fc1105d509d4193e50..49dc31ca7d74e6b16e25e55531a2da25e118442d 100644 (file)
--- a/doc/userguide/support-status.rst
+++ b/doc/userguide/support-status.rst
@@ -77,7 +77,7 @@ support is done by the core team. If someone wants to help maintain
 and support such a feature, we recommend talking to the core team
 before spending a lot of time on it.
 
-Please see :doc:`devguide/codebase/contributing/contribution-process`
+Please see :doc:`devguide/contributing/contribution-process`
 for more information if you wish to contribute.
 
 Distributions