Skip to content

Commit a79fe8c

Browse files
committedJan 16, 2022
doc(plugins/traffic): update
1 parent 6aa7e15 commit a79fe8c

File tree

2 files changed

+31
-24
lines changed

2 files changed

+31
-24
lines changed
 

‎source/plugins/traffic/README.md

+26-20
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
1-
### 🧮 Repositories traffic
2-
3-
> ⚠️ This plugin requires a personal token with repo scope.
4-
5-
The repositories *traffic* plugin displays the number of page views across your repositories.
6-
1+
<!--header-->
72
<table>
8-
<td align="center">
9-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg">
10-
</td>
3+
<tr><th colspan="2"><h3>🧮 Repositories traffic</h3></th></tr>
4+
<tr><td colspan="2" align="center"><p>This plugin displays the number of page views across your repositories.</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> <a href="/source/templates/repository"><code>📘 Repository template</code></a> <a href="/source/templates/terminal"><code>📙 Terminal template</code></a></td>
9+
</tr>
10+
<tr>
11+
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
12+
</tr>
13+
<tr>
14+
<td><code>🔑 repo</code> <code>read:org (optional)</code> <code>read:user (optional)</code></td>
15+
</tr>
16+
<tr>
17+
<td colspan="2" align="center">
18+
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg" alt=""></img>
19+
<img width="900" height="1" alt="">
20+
</td>
21+
</tr>
1122
</table>
23+
<!--/header-->
1224

13-
Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations.
14-
15-
![Token with repo scope](/.github/readme/imgs/setup_token_repo_scope.png)
16-
17-
#### ➡️ Available options
25+
## ➡️ Available options
1826

1927
<!--options-->
2028
<table>
@@ -23,7 +31,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
2331
</tr>
2432
<tr>
2533
<td nowrap="nowrap"><code>plugin_traffic</code></td>
26-
<td rowspan="2"><p>Display repositories traffic metrics</p>
34+
<td rowspan="2"><p>Enable traffic plugin</p>
2735
<img width="900" height="1" alt=""></td>
2836
</tr>
2937
<tr>
@@ -33,7 +41,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
3341
</tr>
3442
<tr>
3543
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
36-
<td rowspan="2"><p>Repositories to skip</p>
44+
<td rowspan="2"><p>Skipped repositories</p>
3745
<img width="900" height="1" alt=""></td>
3846
</tr>
3947
<tr>
@@ -45,9 +53,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
4553
</table>
4654
<!--/options-->
4755

48-
*[→ Full specification](metadata.yml)*
49-
50-
#### ℹ️ Examples workflows
56+
## ℹ️ Examples workflows
5157

5258
<!--examples-->
5359
```yaml
@@ -60,4 +66,4 @@ with:
6066
plugin_traffic: 'yes'
6167

6268
```
63-
<!--/examples-->
69+
<!--/examples-->

‎source/plugins/traffic/metadata.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: "🧮 Repositories traffic"
22
category: github
3+
description: This plugin displays the number of page views across your repositories.
4+
examples:
5+
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg
36
index: 19
47
supports:
58
- user
@@ -9,15 +12,13 @@ scopes:
912
- repo
1013
inputs:
1114

12-
# Enable or disable plugin
1315
plugin_traffic:
14-
description: Display repositories traffic metrics
16+
description: Enable traffic plugin
1517
type: boolean
1618
default: no
1719

18-
# List of repositories that will be skipped
1920
plugin_traffic_skipped:
20-
description: Repositories to skip
21+
description: Skipped repositories
2122
type: array
2223
format: comma-separated
2324
default: ""

0 commit comments

Comments
 (0)
Failed to load comments.