Skip to content

Commit a22c93c

Browse files
lowlighterlowlighter
committedJan 16, 2022
doc(plugins/notable): update
1 parent bc0724b commit a22c93c

File tree

2 files changed

+65
-43
lines changed

2 files changed

+65
-43
lines changed
 

‎source/plugins/notable/README.md

+42-27
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
### 🎩 Notable contributions
2-
3-
The *notable* plugin displays badges of organization where you commited at least once on main branch.
4-
1+
<!--header-->
52
<table>
6-
<td align="center">
7-
<details open><summary>Indepth analysis</summary>
8-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg">
9-
</details>
10-
<details><summary>Contributions in organizations only</summary>
11-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg">
12-
</details>
13-
<img width="900" height="1" alt="">
14-
</td>
3+
<tr><th colspan="2"><h3>🎩 Notable contributions</h3></th></tr>
4+
<tr><td colspan="2" align="center"><p>This plugin displays badges of repositories where you commited at least once on default branch.</p>
5+
</td></tr>
6+
<tr>
7+
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
8+
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a></td>
9+
</tr>
10+
<tr>
11+
<td><code>👤 Users</code></td>
12+
</tr>
13+
<tr>
14+
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
15+
</tr>
16+
<tr>
17+
<td colspan="2" align="center">
18+
<details open><summary>Indepth analysis</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg" alt=""></img></details>
19+
<details><summary>Contributions in organizations only</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg" alt=""></img></details>
20+
<img width="900" height="1" alt="">
21+
</td>
22+
</tr>
1523
</table>
24+
<!--/header-->
1625

17-
#### Using `indepth` statistics
18-
19-
The `plugin_notable_indepth` option lets you get additional metrics about your contribution, such as:
20-
- Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge.
21-
22-
> 🔣 On web instances, `indepth` is an extra feature and must be enabled globally in `settings.json`
23-
24-
#### ➡️ Available options
26+
## ➡️ Available options
2527

2628
<!--options-->
2729
<table>
@@ -30,7 +32,7 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
3032
</tr>
3133
<tr>
3234
<td nowrap="nowrap"><code>plugin_notable</code></td>
33-
<td rowspan="2"><p>Display notable contributions in organizations</p>
35+
<td rowspan="2"><p>Enable notable plugin</p>
3436
<img width="900" height="1" alt=""></td>
3537
</tr>
3638
<tr>
@@ -41,6 +43,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
4143
<tr>
4244
<td nowrap="nowrap"><code>plugin_notable_filter</code></td>
4345
<td rowspan="2"><p>Query filter</p>
46+
<p>Based on <a href="https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax">GitHub search syntax</a>.
47+
Supported fields are <code>stars</code>, <code>forks</code> and <code>watchers</code></p>
4448
<img width="900" height="1" alt=""></td>
4549
</tr>
4650
<tr>
@@ -49,7 +53,12 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
4953
</tr>
5054
<tr>
5155
<td nowrap="nowrap"><code>plugin_notable_from</code></td>
52-
<td rowspan="2"><p>Filter by repository host account type</p>
56+
<td rowspan="2"><p>Filter by repository owner account type</p>
57+
<ul>
58+
<li><code>all</code>: no filtering</li>
59+
<li><code>organization</code>: only organization accounts repositories</li>
60+
<li><code>user</code>: only user accounts repositories</li>
61+
</ul>
5362
<img width="900" height="1" alt=""></td>
5463
</tr>
5564
<tr>
@@ -60,7 +69,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
6069
</tr>
6170
<tr>
6271
<td nowrap="nowrap"><code>plugin_notable_repositories</code></td>
63-
<td rowspan="2"><p>Also display repository name</p>
72+
<td rowspan="2"><p>Toggle repository name display</p>
73+
<p>Note that Repositories hosted by user account will always be fully displayed</p>
6474
<img width="900" height="1" alt=""></td>
6575
</tr>
6676
<tr>
@@ -70,7 +80,7 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
7080
</tr>
7181
<tr>
7282
<td nowrap="nowrap"><code>plugin_notable_indepth</code></td>
73-
<td rowspan="2"><p>Indepth notable contributions processing</p>
83+
<td rowspan="2"><p>Indepth mode</p>
7484
<img width="900" height="1" alt=""></td>
7585
</tr>
7686
<tr>
@@ -82,9 +92,14 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
8292
</table>
8393
<!--/options-->
8494

85-
*[→ Full specification](metadata.yml)*
95+
## 🔎 `indepth` mode
96+
97+
The `plugin_notable_indepth` option collects additional stats about your contributions, such as:
98+
- Total number of commits within a repository or organization.
99+
100+
For each of the above, a badge is awarded. Its color and progress depends of the associated value.
86101

87-
#### ℹ️ Examples workflows
102+
## ℹ️ Examples workflows
88103

89104
<!--examples-->
90105
```yaml

‎source/plugins/notable/metadata.yml

+23-16
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,54 @@
11
name: "🎩 Notable contributions"
22
category: github
3+
description: This plugin displays badges of repositories where you commited at least once on default branch.
4+
examples:
5+
+indepth analysis: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg
6+
contributions in organizations only: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg
37
index: 15
48
supports:
59
- user
610
scopes:
711
- public_access
812
inputs:
913

10-
# Enable or disable plugin
1114
plugin_notable:
12-
description: Display notable contributions in organizations
15+
description: Enable notable plugin
1316
type: boolean
1417
default: no
1518

16-
# Query filter
17-
# Based on GitHub search notation
18-
# Supported fields are "stars", "forks" and "watchers"
1919
plugin_notable_filter:
20-
description: Query filter
20+
description: |
21+
Query filter
22+
23+
Based on [GitHub search syntax](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax).
24+
Supported fields are `stars`, `forks` and `watchers`
2125
type: string
2226
default: ""
2327
example: stars:>500 forks:>100
2428

25-
# Filter repositories depending on which type of account it is hosted
2629
plugin_notable_from:
27-
description: Filter by repository host account type
30+
description: |
31+
Filter by repository owner account type
32+
- `all`: no filtering
33+
- `organization`: only organization accounts repositories
34+
- `user`: only user accounts repositories
2835
type: string
2936
default: organization
3037
values:
31-
- all #
32-
- organization # Only hosted by organization accounts
33-
- user # Only hosted by user accounts
38+
- all
39+
- organization
40+
- user
3441

35-
# Also display repository name along with organization name
36-
# Note that repositories hosted by user account will always be displayed fully
3742
plugin_notable_repositories:
38-
description: Also display repository name
43+
description: |
44+
Toggle repository name display
45+
46+
Note that Repositories hosted by user account will always be fully displayed
3947
type: boolean
4048
default: no
4149

42-
# Compute notable contributions with measured impact
4350
plugin_notable_indepth:
44-
description: Indepth notable contributions processing
51+
description: Indepth mode
4552
type: boolean
4653
default: no
4754
extras: yes

0 commit comments

Comments
 (0)
Failed to load comments.