[tor-commits] [sbws/master] fix: docs: Remove contributing from readme

juga at torproject.org juga at torproject.org
Wed Mar 27 09:59:23 UTC 2019


commit a9dc014e3fc04d13d8595127a1a5dcbba66adb54
Author: juga0 <juga at riseup.net>
Date:   Tue Mar 26 08:39:30 2019 +0000

    fix: docs: Remove contributing from readme
    
    and move contributing from the root directory to the docs/ one,
    since it links to testing but testing is not in the root directory.
    This way when a user only reads the readme locally, does not try
    to find testing in the root directory and instead will search for
    more documentation in docs/.
---
 README.md                                        | 6 ------
 docs/source/CONTRIBUTING.rst                     | 1 -
 CONTRIBUTING.rst => docs/source/contributing.rst | 0
 docs/source/index.rst                            | 2 +-
 4 files changed, 1 insertion(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 8c57464..e796e46 100644
--- a/README.md
+++ b/README.md
@@ -42,12 +42,6 @@ Deploying and running
 See [./DEPLOY.rst](DEPLOY.rst) (in local directory or GitHub) or
 [DEPLOY.html](DEPLOY.html) (local build or Read the Docs).
 
-Contributing
---------------
-
-See [./CONTRIBUTING.rst](CONTRIBUTING.rst) (in local directory or GitHub) or
-[CONTRIBUTING.html](CONTRIBUTING.html) (local build or Read the Docs).
-
 Changelog
 --------------
 
diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst
deleted file mode 120000
index e9a8ba6..0000000
--- a/docs/source/CONTRIBUTING.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../CONTRIBUTING.rst
\ No newline at end of file
diff --git a/CONTRIBUTING.rst b/docs/source/contributing.rst
similarity index 100%
rename from CONTRIBUTING.rst
rename to docs/source/contributing.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e6c5d6e..9806ef3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -19,7 +19,6 @@ and in ``sbws`` Debian package:
    README
    INSTALL
    DEPLOY
-   CONTRIBUTING
    CHANGELOG
    AUTHORS
    man_sbws
@@ -37,6 +36,7 @@ Included in the
 .. toctree::
    :maxdepth: 1
 
+   contributing
    testing
    documenting
    how_works





More information about the tor-commits mailing list