sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

doc(plugins/traffic): update

Browse Source
This commit is contained in:
lowlighter
2022-01-15 19:44:12 -05:00
parent 6aa7e159db
commit a79fe8c947
2 changed files with 31 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
source/plugins/traffic/README.md
View File

@@ -1,20 +1,28 @@
### 🧮 Repositories traffic
> ⚠️ This plugin requires a personal token with repo scope.
The repositories *traffic* plugin displays the number of page views across your repositories.
<!--header-->
<table>
<td align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg">
</td>
<tr><th colspan="2"><h3>🧮 Repositories traffic</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin displays the number of page views across your repositories.</p>
</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<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>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
</tr>
<tr>
<td><code>🔑 repo</code> <code>read:org (optional)</code> <code>read:user (optional)</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations.
![Token with repo scope](/.github/readme/imgs/setup_token_repo_scope.png)
#### ➡️ Available options
## ➡️ Available options
<!--options-->
<table>
@@ -23,7 +31,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic</code></td>
<td rowspan="2"><p>Display repositories traffic metrics</p>
<td rowspan="2"><p>Enable traffic plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -33,7 +41,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
<td rowspan="2"><p>Repositories to skip</p>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -45,9 +53,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
</table>
<!--/options-->
*[→ Full specification](metadata.yml)*
#### ℹ️ Examples workflows
## ℹ️ Examples workflows
<!--examples-->
```yaml
@@ -60,4 +66,4 @@ with:
plugin_traffic: 'yes'
```
<!--/examples-->
<!--/examples-->