From 7edcb6bb58d05ee2b505d5bb633ecb438396066b Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Thu, 18 Feb 2021 12:47:02 +0100 Subject: [PATCH] Update documentation --- .github/ISSUE_TEMPLATE/feature_request.md | 21 ------------------- .github/ISSUE_TEMPLATE/question.md | 20 ------------------ .../partials/documentation/contributing.md | 4 +++- .github/readme/partials/introduction.md | 2 +- source/plugins/anilist/README.md | 2 +- source/plugins/anilist/metadata.yml | 2 +- source/plugins/contributors/README.md | 2 +- source/plugins/contributors/metadata.yml | 2 +- source/plugins/introduction/README.md | 6 ++++-- source/plugins/licenses/README.md | 2 +- source/plugins/licenses/metadata.yml | 2 +- source/plugins/projects/README.md | 2 +- source/plugins/projects/metadata.yml | 2 +- 13 files changed, 16 insertions(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 084e0b2d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: 🗳️ Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 23bb8b57..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: 💬 Question -about: Ask a question or request help -title: '' -labels: question -assignees: '' - ---- - - diff --git a/.github/readme/partials/documentation/contributing.md b/.github/readme/partials/documentation/contributing.md index f0d880e6..101843cd 100644 --- a/.github/readme/partials/documentation/contributing.md +++ b/.github/readme/partials/documentation/contributing.md @@ -3,7 +3,9 @@ Metrics is built to be easily customizable. Fork this repository, switch used action from `lowlighter/metrics@latest` to your fork and start coding! -To suggest a new feature, report a bug or ask for help, fill an [issue](https://github.com/lowlighter/metrics/issues) describing it. +To report a bug fill an [issue](https://github.com/lowlighter/metrics/issues) describing it. + +To suggest new features or requesting help to setup metrics, check out [discussions](https://github.com/lowlighter/metrics/discussions). If you want to contribute, submit a [pull request](https://github.com/lowlighter/metrics/pulls). Be sure to read [CONTRIBUTING.md](CONTRIBUTING.md) for more information about this. diff --git a/.github/readme/partials/introduction.md b/.github/readme/partials/introduction.md index 86c818fc..71623b37 100644 --- a/.github/readme/partials/introduction.md +++ b/.github/readme/partials/introduction.md @@ -53,7 +53,7 @@ Generate your metrics that you can embed everywhere, including your GitHub profi <% if (elements.length%2) diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index 984824a0..dd6cacec 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -1,4 +1,4 @@ -### 🌸 Anilist +### 🌸 Anilist watch list and reading list" The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account. diff --git a/source/plugins/anilist/metadata.yml b/source/plugins/anilist/metadata.yml index 195592aa..af17d25a 100644 --- a/source/plugins/anilist/metadata.yml +++ b/source/plugins/anilist/metadata.yml @@ -1,4 +1,4 @@ -name: "🌸 Anilist" +name: "🌸 Anilist watch list and reading list" cost: N/A categorie: social supports: diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 5cc4e5d0..7717032a 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -1,4 +1,4 @@ -### 🏅 Contributors +### 🏅 Repository contributors The *contributors* plugin lets you display repositories contributors from a commit range, that can be specified through either sha, tags, branch, etc. diff --git a/source/plugins/contributors/metadata.yml b/source/plugins/contributors/metadata.yml index 7d9742bf..177b61ea 100644 --- a/source/plugins/contributors/metadata.yml +++ b/source/plugins/contributors/metadata.yml @@ -1,4 +1,4 @@ -name: "🏅 Contributors" +name: "🏅 Repository contributors" cost: N/A categorie: github supports: diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index f0c826b4..98105b39 100644 --- a/source/plugins/introduction/README.md +++ b/source/plugins/introduction/README.md @@ -5,8 +5,10 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
- 🖼️ <%= elements.length-1 %> templates + 🖼️ <%= elements.length-1 %>+ templates
- -
Repository version +
Account version + +
+
Repository version
diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index ab7658c4..bfc99a83 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -1,4 +1,4 @@ -### 📜 Licenses +### 📜 Repository licenses ⚠️ This is NOT legal advice, use at your own risk 💣 Do NOT enable this plugin on public web instances (plugin allows raw commands injection) diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index 85f5ff40..15dc8af5 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -1,4 +1,4 @@ -name: "📜 Licenses" +name: "📜 Repository licenses" cost: N/A categorie: github supports: diff --git a/source/plugins/projects/README.md b/source/plugins/projects/README.md index f74749bd..3f45e913 100644 --- a/source/plugins/projects/README.md +++ b/source/plugins/projects/README.md @@ -1,4 +1,4 @@ -### 🗂️ Projects +### 🗂️ Active projects ⚠️ This plugin requires a personal token with public_repo scope. diff --git a/source/plugins/projects/metadata.yml b/source/plugins/projects/metadata.yml index d2675d68..570d7582 100644 --- a/source/plugins/projects/metadata.yml +++ b/source/plugins/projects/metadata.yml @@ -1,4 +1,4 @@ -name: "🗂️ Projects" +name: "🗂️ Active projects" cost: 1 GraphQL request + 1 GraphQL request per repository project categorie: github supports: