From 1d8930cb0d2ddb4f699192be99ea1198b98ac739 Mon Sep 17 00:00:00 2001 From: Jack Date: Thu, 25 Jul 2024 18:21:20 +0200 Subject: [PATCH] docs: move files to docs folder (#5654) * docs * fix links --- .github/workflows/publish-docker-images.yml | 4 ++-- README.md | 8 ++++++-- CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 0 CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 CONTRIBUTING_ADVANCED.md => docs/CONTRIBUTING_ADVANCED.md | 0 CONTRIBUTING_BASIC.md => docs/CONTRIBUTING_BASIC.md | 0 LANGUAGES.md => docs/LANGUAGES.md | 0 QUOTES.md => docs/QUOTES.md | 0 SECURITY.md => docs/SECURITY.md | 0 SELF_HOSTING.md => docs/SELF_HOSTING.md | 0 THEMES.md => docs/THEMES.md | 0 11 files changed, 8 insertions(+), 4 deletions(-) rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (100%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename CONTRIBUTING_ADVANCED.md => docs/CONTRIBUTING_ADVANCED.md (100%) rename CONTRIBUTING_BASIC.md => docs/CONTRIBUTING_BASIC.md (100%) rename LANGUAGES.md => docs/LANGUAGES.md (100%) rename QUOTES.md => docs/QUOTES.md (100%) rename SECURITY.md => docs/SECURITY.md (100%) rename SELF_HOSTING.md => docs/SELF_HOSTING.md (100%) rename THEMES.md => docs/THEMES.md (100%) diff --git a/.github/workflows/publish-docker-images.yml b/.github/workflows/publish-docker-images.yml index 9cd911ba3..9c6bf3cb8 100644 --- a/.github/workflows/publish-docker-images.yml +++ b/.github/workflows/publish-docker-images.yml @@ -52,7 +52,7 @@ jobs: password: ${{ secrets.DOCKER_ACCESS_TOKEN }} repository: ${{ env.BE_REPO }} short-description: Official backend server for monkeytype.com - readme-filepath: ./SELF_HOSTING.md + readme-filepath: ./docs/SELF_HOSTING.md - name: Frontend extract metadata (tags, labels) id: femeta @@ -79,4 +79,4 @@ jobs: password: ${{ secrets.DOCKER_ACCESS_TOKEN }} repository: ${{ env.FE_REPO }} short-description: Official frontend server for monkeytype.com - readme-filepath: ./SELF_HOSTING.md + readme-filepath: ./docs/SELF_HOSTING.md diff --git a/README.md b/README.md index e6d46f613..077d57cf1 100644 --- a/README.md +++ b/README.md @@ -33,11 +33,15 @@ If you encounter a bug or have a feature request, [send us an email](mailto:cont # Want to Contribute? -Refer to [CONTRIBUTING.md](./CONTRIBUTING.md). +Refer to [CONTRIBUTING.md](./docs/CONTRIBUTING.md). # Code of Conduct -Before contributing to this repository, please read the [code of conduct](./CODE_OF_CONDUCT.md). +Before contributing to this repository, please read the [code of conduct](./docs/CODE_OF_CONDUCT.md). + +# Security + +To report a security vulnerability, please refer to [SECURITY.md](./docs/SECURITY.md). # Credits diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/CONTRIBUTING_ADVANCED.md b/docs/CONTRIBUTING_ADVANCED.md similarity index 100% rename from CONTRIBUTING_ADVANCED.md rename to docs/CONTRIBUTING_ADVANCED.md diff --git a/CONTRIBUTING_BASIC.md b/docs/CONTRIBUTING_BASIC.md similarity index 100% rename from CONTRIBUTING_BASIC.md rename to docs/CONTRIBUTING_BASIC.md diff --git a/LANGUAGES.md b/docs/LANGUAGES.md similarity index 100% rename from LANGUAGES.md rename to docs/LANGUAGES.md diff --git a/QUOTES.md b/docs/QUOTES.md similarity index 100% rename from QUOTES.md rename to docs/QUOTES.md diff --git a/SECURITY.md b/docs/SECURITY.md similarity index 100% rename from SECURITY.md rename to docs/SECURITY.md diff --git a/SELF_HOSTING.md b/docs/SELF_HOSTING.md similarity index 100% rename from SELF_HOSTING.md rename to docs/SELF_HOSTING.md diff --git a/THEMES.md b/docs/THEMES.md similarity index 100% rename from THEMES.md rename to docs/THEMES.md