From 7ef3db3730d7bddad471372ed823c770634933a7 Mon Sep 17 00:00:00 2001 From: Robert Helgesson Date: Tue, 17 Aug 2021 19:28:04 +0200 Subject: [PATCH] docs: rename "doc" directory to "docs" Also remove `CONTRIBUTING.adoc` and `FAQ.adoc` from project root since GitHub knows to pick them up from the docs directory. Fixes #2273 --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- CONTRIBUTING.adoc | 1 - FAQ.adoc | 1 - default.nix | 2 +- {doc => docs}/contributing.adoc | 0 {doc => docs}/default.nix | 0 {doc => docs}/faq.adoc | 0 {doc => docs}/installation.adoc | 0 {doc => docs}/man-configuration.xml | 0 {doc => docs}/man-home-manager.xml | 0 {doc => docs}/man-pages.xml | 0 {doc => docs}/manual.xml | 0 {doc => docs}/release-notes/release-notes.adoc | 0 {doc => docs}/release-notes/rl-1809.adoc | 0 {doc => docs}/release-notes/rl-1903.adoc | 0 {doc => docs}/release-notes/rl-1909.adoc | 0 {doc => docs}/release-notes/rl-2003.adoc | 0 {doc => docs}/release-notes/rl-2009.adoc | 0 {doc => docs}/release-notes/rl-2105.adoc | 0 {doc => docs}/release-notes/rl-2111.adoc | 0 {doc => docs}/writing-modules.adoc | 0 modules/manual.nix | 2 +- 22 files changed, 4 insertions(+), 6 deletions(-) delete mode 120000 CONTRIBUTING.adoc delete mode 120000 FAQ.adoc rename {doc => docs}/contributing.adoc (100%) rename {doc => docs}/default.nix (100%) rename {doc => docs}/faq.adoc (100%) rename {doc => docs}/installation.adoc (100%) rename {doc => docs}/man-configuration.xml (100%) rename {doc => docs}/man-home-manager.xml (100%) rename {doc => docs}/man-pages.xml (100%) rename {doc => docs}/manual.xml (100%) rename {doc => docs}/release-notes/release-notes.adoc (100%) rename {doc => docs}/release-notes/rl-1809.adoc (100%) rename {doc => docs}/release-notes/rl-1903.adoc (100%) rename {doc => docs}/release-notes/rl-1909.adoc (100%) rename {doc => docs}/release-notes/rl-2003.adoc (100%) rename {doc => docs}/release-notes/rl-2009.adoc (100%) rename {doc => docs}/release-notes/rl-2105.adoc (100%) rename {doc => docs}/release-notes/rl-2111.adoc (100%) rename {doc => docs}/writing-modules.adoc (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6c68d75b..fd0a266b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ pull-request. Also make sure to read the guidelines found at - https://github.com/nix-community/home-manager/blob/master/doc/contributing.adoc#sec-guidelines + https://github.com/nix-community/home-manager/blob/master/docs/contributing.adoc#sec-guidelines --> @@ -35,7 +35,7 @@ Also make sure to read the guidelines found at {long description} ``` - See [CONTRIBUTING](https://github.com/nix-community/home-manager/blob/master/doc/contributing.adoc#sec-commit-style) for more information and [recent commit messages](https://github.com/nix-community/home-manager/commits/master) for examples. + See [CONTRIBUTING](https://github.com/nix-community/home-manager/blob/master/docs/contributing.adoc#sec-commit-style) for more information and [recent commit messages](https://github.com/nix-community/home-manager/commits/master) for examples. - If this PR adds a new module diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 120000 index b615999d..00000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1 +0,0 @@ -doc/contributing.adoc \ No newline at end of file diff --git a/FAQ.adoc b/FAQ.adoc deleted file mode 120000 index 7d90da71..00000000 --- a/FAQ.adoc +++ /dev/null @@ -1 +0,0 @@ -doc/faq.adoc \ No newline at end of file diff --git a/default.nix b/default.nix index 4219d370..4438d827 100644 --- a/default.nix +++ b/default.nix @@ -1,7 +1,7 @@ { pkgs ? import { } }: rec { - docs = with import ./doc { inherit pkgs; }; { + docs = with import ./docs { inherit pkgs; }; { html = manual.html; manPages = manPages; json = options.json; diff --git a/doc/contributing.adoc b/docs/contributing.adoc similarity index 100% rename from doc/contributing.adoc rename to docs/contributing.adoc diff --git a/doc/default.nix b/docs/default.nix similarity index 100% rename from doc/default.nix rename to docs/default.nix diff --git a/doc/faq.adoc b/docs/faq.adoc similarity index 100% rename from doc/faq.adoc rename to docs/faq.adoc diff --git a/doc/installation.adoc b/docs/installation.adoc similarity index 100% rename from doc/installation.adoc rename to docs/installation.adoc diff --git a/doc/man-configuration.xml b/docs/man-configuration.xml similarity index 100% rename from doc/man-configuration.xml rename to docs/man-configuration.xml diff --git a/doc/man-home-manager.xml b/docs/man-home-manager.xml similarity index 100% rename from doc/man-home-manager.xml rename to docs/man-home-manager.xml diff --git a/doc/man-pages.xml b/docs/man-pages.xml similarity index 100% rename from doc/man-pages.xml rename to docs/man-pages.xml diff --git a/doc/manual.xml b/docs/manual.xml similarity index 100% rename from doc/manual.xml rename to docs/manual.xml diff --git a/doc/release-notes/release-notes.adoc b/docs/release-notes/release-notes.adoc similarity index 100% rename from doc/release-notes/release-notes.adoc rename to docs/release-notes/release-notes.adoc diff --git a/doc/release-notes/rl-1809.adoc b/docs/release-notes/rl-1809.adoc similarity index 100% rename from doc/release-notes/rl-1809.adoc rename to docs/release-notes/rl-1809.adoc diff --git a/doc/release-notes/rl-1903.adoc b/docs/release-notes/rl-1903.adoc similarity index 100% rename from doc/release-notes/rl-1903.adoc rename to docs/release-notes/rl-1903.adoc diff --git a/doc/release-notes/rl-1909.adoc b/docs/release-notes/rl-1909.adoc similarity index 100% rename from doc/release-notes/rl-1909.adoc rename to docs/release-notes/rl-1909.adoc diff --git a/doc/release-notes/rl-2003.adoc b/docs/release-notes/rl-2003.adoc similarity index 100% rename from doc/release-notes/rl-2003.adoc rename to docs/release-notes/rl-2003.adoc diff --git a/doc/release-notes/rl-2009.adoc b/docs/release-notes/rl-2009.adoc similarity index 100% rename from doc/release-notes/rl-2009.adoc rename to docs/release-notes/rl-2009.adoc diff --git a/doc/release-notes/rl-2105.adoc b/docs/release-notes/rl-2105.adoc similarity index 100% rename from doc/release-notes/rl-2105.adoc rename to docs/release-notes/rl-2105.adoc diff --git a/doc/release-notes/rl-2111.adoc b/docs/release-notes/rl-2111.adoc similarity index 100% rename from doc/release-notes/rl-2111.adoc rename to docs/release-notes/rl-2111.adoc diff --git a/doc/writing-modules.adoc b/docs/writing-modules.adoc similarity index 100% rename from doc/writing-modules.adoc rename to docs/writing-modules.adoc diff --git a/modules/manual.nix b/modules/manual.nix index ab01c450..a5c02051 100644 --- a/modules/manual.nix +++ b/modules/manual.nix @@ -6,7 +6,7 @@ let cfg = config.manual; - docs = import ../doc { inherit lib pkgs; }; + docs = import ../docs { inherit lib pkgs; }; in