]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs: move markdown docs from .github/ to docs/
authorFilipe Brandenburger <filbranden@google.com>
Fri, 7 Sep 2018 08:07:06 +0000 (01:07 -0700)
committerFilipe Brandenburger <filbranden@google.com>
Sat, 8 Sep 2018 20:39:03 +0000 (13:39 -0700)
The GitHub guide on contributing file says: "Decide whether to store your
contributing guidelines in your repository's root, docs, or .github directory."

https://help.github.com/articles/setting-guidelines-for-repository-contributors/#adding-a-contributing-file

But there's really no advantage to keeping it in the hidden .github/, since
these are public and really belong together with the other documentation.

We can still keep the issue templates under .github/, since they are not really
documentation on their own.

Updated the links pointing to CONTRIBUTING.md to refer to the one in docs/.

.github/ISSUE_TEMPLATE/Bug_report.md
docs/CONTRIBUTING.md [moved from .github/CONTRIBUTING.md with 100% similarity]
docs/HACKING
docs/RELEASE.md [moved from .github/RELEASE.md with 100% similarity]

index cea1c655b9718c93cc1b04f6dcfdce6a8072b917..6a0b5527d065bcdf1f8b9fb69eba9e01111dd507 100644 (file)
@@ -8,7 +8,7 @@ about: A report of an error in a recent systemd version
 > ...
 
 <!-- **NOTE:** Do not submit bug reports about anything but the two most recently released systemd versions upstream! -->
-<!-- For older version please use distribution trackers (see https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md#filing-issues). -->
+<!-- For older version please use distribution trackers (see https://github.com/systemd/systemd/blob/master/docs/CONTRIBUTING.md#filing-issues). -->
 
 **Used distribution**
  > …
similarity index 100%
rename from .github/CONTRIBUTING.md
rename to docs/CONTRIBUTING.md
index c7b700e6a70f85915b1ba56fd8dd56e75b93d93a..1778e4822d207b406c525ab3c5b858e50da144eb 100644 (file)
@@ -9,7 +9,7 @@ Request (PR):
 Please make sure to follow our Coding Style when submitting patches. See
 docs/CODING_STYLE for details. Also have a look at our Contribution Guidelines:
 
-        https://github.com/systemd/systemd/blob/master/.github/CONTRIBUTING.md
+        https://github.com/systemd/systemd/blob/master/docs/CONTRIBUTING.md
 
 When adding new functionality, tests should be added. For shared functionality
 (in src/basic and src/shared) unit tests should be sufficient. The general
similarity index 100%
rename from .github/RELEASE.md
rename to docs/RELEASE.md