From fad714d039c792f5b90aaa03f9fb77b45f24a295 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Sun, 29 Oct 2023 00:51:14 +0200 Subject: [PATCH] chore: move dev doc in .docs (#150) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- docs/dev/labels/README.md => .docs/LABELS.md | 0 {docs/dev/release => .docs}/README.md | 6 +++--- docs/README.md | 1 - docs/dev/README.md | 6 ------ 4 files changed, 3 insertions(+), 10 deletions(-) rename docs/dev/labels/README.md => .docs/LABELS.md (100%) rename {docs/dev/release => .docs}/README.md (52%) delete mode 100644 docs/dev/README.md diff --git a/docs/dev/labels/README.md b/.docs/LABELS.md similarity index 100% rename from docs/dev/labels/README.md rename to .docs/LABELS.md diff --git a/docs/dev/release/README.md b/.docs/README.md similarity index 52% rename from docs/dev/release/README.md rename to .docs/README.md index 3529fbc6..87d9d3ac 100644 --- a/docs/dev/release/README.md +++ b/.docs/README.md @@ -6,7 +6,7 @@ This docs contains informations for releasing releasing. Creating a release can be done by pushing a tag to the GitHub repository (begining with `v`). -The [release workflow](../../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts. +The [release workflow](../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts. ```shell VERSION="v0.1.0" @@ -18,8 +18,8 @@ git push origin $TAG ## Release notes -Release notes for the `main` branch lives in [main.md](../../.release-notes/main.md). +Release notes for the `main` branch lives in [main.md](../.release-notes/main.md). Make sure it is up to date and rename the file to the version being released. -You can then copy [_template.md](../../.release-notes/_template.md) to [main.md](../../.release-notes/main.md) for the next release. +You can then copy [_template.md](../.release-notes/_template.md) to [main.md](../.release-notes/main.md) for the next release. diff --git a/docs/README.md b/docs/README.md index 6884305f..8f5b87f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,5 +2,4 @@ This documentation contains the following docs: -- [Dev docs](./dev/README.md) - [User docs](./user/README.md) diff --git a/docs/dev/README.md b/docs/dev/README.md deleted file mode 100644 index 562af86c..00000000 --- a/docs/dev/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Dev docs - -This documentation contains the following dev docs: - -- [Release docs](./release/README.md) -- [Labels docs](./labels/README.md)