fix(docs): lot of misspelling (#1180) [skip ci]

This commit is contained in:
Josh Soref
2022-08-14 12:04:03 -04:00
committed by GitHub
parent e2f27e931d
commit ab85858528
59 changed files with 115 additions and 115 deletions

View File

@@ -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.
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.light.png#gh-light-mode-only)
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.dark.png#gh-dark-mode-only)

View File

@@ -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.

View File

@@ -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)
[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)

View File

@@ -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

View File

@@ -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(" ") %>
<% }} %>
<% }} %>

View File

@@ -10,7 +10,7 @@ const browser = await puppeteer.launch({
})
const page = await browser.newPage()
//Select markdown example and take screenshoot
//Select markdown example and take screenshot
await page.setViewport({width: 600, height: 600})
await page.goto("https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.md")
const clip = await page.evaluate(() => {

View File

@@ -354,7 +354,7 @@ jobs:
user: lowlighter
plugins_errors_fatal: yes
if: ${{ success() || failure() }}
- name: 💡 Coding habits and activity - Midly interesting facts
- name: 💡 Coding habits and activity - Mildly interesting facts
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.habits.facts.svg
@@ -806,7 +806,7 @@ jobs:
user: lowlighter
plugins_errors_fatal: yes
if: ${{ success() || failure() }}
- name: ⏱️ Google PageSpeed - Succint report
- name: ⏱️ Google PageSpeed - Succinct report
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.pagespeed.svg