Skip to content

Commit ab85858

Browse files
authored
fix(docs): lot of misspelling (lowlighter#1180) [skip ci]
1 parent e2f27e9 commit ab85858

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+115
-115
lines changed

.github/readme/partials/documentation/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ It is possible to host workflows in the `.github` repository of organizations, a
3232
## *️⃣ Organizations memberships for user accounts
3333

3434
By default, GitHub only display public memberships.
35-
Membership visibility canbe managed in the `People` tab of your organization.
35+
Membership visibility can be managed in the `People` tab of your organization.
3636

3737
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.light.png#gh-light-mode-only)
3838
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.dark.png#gh-dark-mode-only)

.github/readme/partials/documentation/setup/web.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Update profile `README.md` to include rendered image.
154154

155155
### 4️.1️ URL parameters syntax
156156

157-
The GitHub action and the web instance uses the same engine behing the hood.
157+
The GitHub action and the web instance uses the same engine behind the hood.
158158

159159
It is actually possible to generate image directly from url without passing by the web ui by knowing how to pass parameters.
160160

.github/readme/partials/templated/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📊 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)
1+
# 📊 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)
22

33
[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
44

.github/readme/partials/templated/plugins.community.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Be sure to read [contribution guide](/CONTRIBUTING.md) and [architecture](/ARCHI
3434
3535
Please respect the following guidelines:
3636

37-
- A plugin should be independant and should not rely on other plugins
37+
- A plugin should be independent and should not rely on other plugins
3838
- [🧱 core](/source/plugins/core/README.md) and [🗃️ base](/source/plugins/base/README.md) output can be reused though
3939
- A plugin should never edit its original arguments, as it is shared amongst other plugins and would create unattended side effects
40-
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically typecheck and default user inputs through defined `metadata.yml`
40+
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically type check and default user inputs through defined `metadata.yml`
4141
- Plugin options should respect the "lexical field" of existing option to keep consistency
4242
- Plugin errors should be handled gracefully by partials with error message
4343
- New dependencies should be avoided, consider using existing `imports`
@@ -210,7 +210,7 @@ export default async function(
210210
{
211211
login, //GitHub username
212212
q, //Raw user inputs (dot notation without plugin_ prefix, don't use it directly)
213-
imports, //Various utilitaires (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
213+
imports, //Various utilities (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
214214
data, //Raw data from core/base plugin
215215
computed, //Computed data from core/base plugin
216216
rest, //Rest authenticated GitHub octokit

.github/readme/partials/templated/plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Plugins provide additional content and lets you customize rendered metrics.
55
**📦 Maintained by core team**
66
<% { 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)) { %>
77
<% if (previous !== category) { previous = category -%>
8-
* **<%= `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)} plugins` %>**
8+
* **<%= `${category === "github" ? "GitHub" : `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)}`} plugins` %>**
99
<% } -%>
1010
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/<%= plugin %>/README.md)<%# -%><% if (deprecation) { %> <sub>`⚠️ deprecated`</sub><% } %><%# -%>
1111
<% }} %>
@@ -14,4 +14,4 @@ Plugins provide additional content and lets you customize rendered metrics.
1414
* **[Community plugins](/source/plugins/community/README.md)**
1515
<% { 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)) { %><%# -%>
1616
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
17-
<% }} %>
17+
<% }} %>

.github/scripts/markdown_example.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const browser = await puppeteer.launch({
1010
})
1111
const page = await browser.newPage()
1212

13-
//Select markdown example and take screenshoot
13+
//Select markdown example and take screenshot
1414
await page.setViewport({width: 600, height: 600})
1515
await page.goto("https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.md")
1616
const clip = await page.evaluate(() => {

.github/workflows/examples.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ jobs:
354354
user: lowlighter
355355
plugins_errors_fatal: yes
356356
if: ${{ success() || failure() }}
357-
- name: 💡 Coding habits and activity - Midly interesting facts
357+
- name: 💡 Coding habits and activity - Mildly interesting facts
358358
uses: lowlighter/metrics@master
359359
with:
360360
filename: metrics.plugin.habits.facts.svg
@@ -806,7 +806,7 @@ jobs:
806806
user: lowlighter
807807
plugins_errors_fatal: yes
808808
if: ${{ success() || failure() }}
809-
- name: ⏱️ Google PageSpeed - Succint report
809+
- name: ⏱️ Google PageSpeed - Succinct report
810810
uses: lowlighter/metrics@master
811811
with:
812812
filename: metrics.plugin.pagespeed.svg

ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ To solve this, metrics now spawns a [puppeteer](https://github.com/puppeteer/pup
6262

6363
![Metrics marker](/.github/readme/imgs/about_metrics_marker.png)
6464

65-
Additional bonus of using pupeeter is that it can take screenshots, making it easy to convert SVGs to PNG output.
65+
Additional bonus of using puppeteer is that it can take screenshots, making it easy to convert SVGs to PNG output.
6666

6767
### 💬 Gathering external data from GitHub APIs and Third-Party services
6868

6969
*metrics* mostly use GitHub APIs since it is its primary target. Most of the time, data are retrieved through GraphQL to save APIs requests, but it sometimes fallback on REST for other features. Octokit SDKs are used to make it easier.
7070

7171
As for other external services (Twitter, Spotify, PageSpeed, ...), metrics use their respective APIs, usually making https requests through [axios](https://github.com/axios/axios) and by following their documentation. It would be overkill to install entire SDKs for these since plugins rarely uses more than 2/3 calls.
7272

73-
In last resort, pupeeter is seldom used to scrap websites, though its use tends to make things slow and unstable (as it'll break upon HTML structural changes).
73+
In last resort, puppeteer is seldom used to scrap websites, though its use tends to make things slow and unstable (as it'll break upon HTML structural changes).
7474

7575
### 💬 Web instance and GitHub action similarities
7676

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
8+
identity and expression, level of experience, education, socioeconomic status,
99
nationality, personal appearance, race, religion, or sexual identity
1010
and orientation.
1111

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The following contributions are accepted:
2020
<table>
2121
<tr>
2222
<th>Section</th>
23-
<th>Editions</th>
23+
<th>Changes</th>
2424
<th>Additions</th>
2525
<th>Notes</th>
2626
</tr>
@@ -41,7 +41,7 @@ The following contributions are accepted:
4141
<td>❌</td>
4242
<td>
4343
<ul>
44-
<li>Templates editions are allowed with new features additions (but must remain consistent with current visuals)</li>
44+
<li>Template changes are allowed with new features additions (but must remain consistent with current visuals)</li>
4545
<li>New templates should use <a href="https://github.com/lowlighter/metrics/blob/master/source/templates/community/README.md">📕 Community templates</a> instead</li>
4646
</ul>
4747
</td>
@@ -73,7 +73,7 @@ The following contributions are accepted:
7373
<td>❌</td>
7474
<td>
7575
<ul>
76-
<li>Core editions impact all rendering process and should be avoided unless necessary</li>
76+
<li>Core changes impact all rendering process and should be avoided unless necessary</li>
7777
<li>New dependencies should be avoided when possible</li>
7878
</ul>
7979
</td>

0 commit comments

Comments
 (0)