fix(docs): lot of misspelling (#1180) [skip ci]
This commit is contained in:
@@ -32,7 +32,7 @@ It is possible to host workflows in the `.github` repository of organizations, a
|
||||
## *️⃣ Organizations memberships for user accounts
|
||||
|
||||
By default, GitHub only display public memberships.
|
||||
Membership visibility canbe managed in the `People` tab of your organization.
|
||||
Membership visibility can be managed in the `People` tab of your organization.
|
||||
|
||||

|
||||

|
||||
|
||||
@@ -154,7 +154,7 @@ Update profile `README.md` to include rendered image.
|
||||
|
||||
### 4️.1️ URL parameters syntax
|
||||
|
||||
The GitHub action and the web instance uses the same engine behing the hood.
|
||||
The GitHub action and the web instance uses the same engine behind the hood.
|
||||
|
||||
It is actually possible to generate image directly from url without passing by the web ui by knowing how to pass parameters.
|
||||
|
||||
|
||||
2
.github/readme/partials/templated/README.md
vendored
2
.github/readme/partials/templated/README.md
vendored
@@ -1,4 +1,4 @@
|
||||
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
|
||||
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics)
|
||||
|
||||
[](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
|
||||
|
||||
|
||||
@@ -34,10 +34,10 @@ Be sure to read [contribution guide](/CONTRIBUTING.md) and [architecture](/ARCHI
|
||||
|
||||
Please respect the following guidelines:
|
||||
|
||||
- A plugin should be independant and should not rely on other plugins
|
||||
- A plugin should be independent and should not rely on other plugins
|
||||
- [🧱 core](/source/plugins/core/README.md) and [🗃️ base](/source/plugins/base/README.md) output can be reused though
|
||||
- A plugin should never edit its original arguments, as it is shared amongst other plugins and would create unattended side effects
|
||||
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically typecheck and default user inputs through defined `metadata.yml`
|
||||
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically type check and default user inputs through defined `metadata.yml`
|
||||
- Plugin options should respect the "lexical field" of existing option to keep consistency
|
||||
- Plugin errors should be handled gracefully by partials with error message
|
||||
- New dependencies should be avoided, consider using existing `imports`
|
||||
@@ -210,7 +210,7 @@ export default async function(
|
||||
{
|
||||
login, //GitHub username
|
||||
q, //Raw user inputs (dot notation without plugin_ prefix, don't use it directly)
|
||||
imports, //Various utilitaires (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
|
||||
imports, //Various utilities (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
|
||||
data, //Raw data from core/base plugin
|
||||
computed, //Computed data from core/base plugin
|
||||
rest, //Rest authenticated GitHub octokit
|
||||
|
||||
4
.github/readme/partials/templated/plugins.md
vendored
4
.github/readme/partials/templated/plugins.md
vendored
@@ -5,7 +5,7 @@ Plugins provide additional content and lets you customize rendered metrics.
|
||||
**📦 Maintained by core team**
|
||||
<% { let previous = null; for (const [plugin, {name, category, deprecation, authors = []}] of Object.entries(plugins).filter(([key, value]) => (value)&&(value.category !== "community")).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %>
|
||||
<% if (previous !== category) { previous = category -%>
|
||||
* **<%= `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)} plugins` %>**
|
||||
* **<%= `${category === "github" ? "GitHub" : `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)}`} plugins` %>**
|
||||
<% } -%>
|
||||
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/<%= plugin %>/README.md)<%# -%><% if (deprecation) { %> <sub>`⚠️ deprecated`</sub><% } %><%# -%>
|
||||
<% }} %>
|
||||
@@ -14,4 +14,4 @@ Plugins provide additional content and lets you customize rendered metrics.
|
||||
* **[Community plugins](/source/plugins/community/README.md)**
|
||||
<% { let previous = null; for (const [plugin, {name, category, authors = []}] of Object.entries(plugins).filter(([key, value]) => (value)&&(value.category === "community")).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %><%# -%>
|
||||
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
|
||||
<% }} %>
|
||||
<% }} %>
|
||||
|
||||
Reference in New Issue
Block a user