doc(plugins/traffic): update
This commit is contained in:
@@ -1,20 +1,28 @@
|
|||||||
### 🧮 Repositories traffic
|
<!--header-->
|
||||||
|
|
||||||
> ⚠️ This plugin requires a personal token with repo scope.
|
|
||||||
|
|
||||||
The repositories *traffic* plugin displays the number of page views across your repositories.
|
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<td align="center">
|
<tr><th colspan="2"><h3>🧮 Repositories traffic</h3></th></tr>
|
||||||
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg">
|
<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>
|
</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<!--/header-->
|
||||||
|
|
||||||
Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations.
|
## ➡️ Available options
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### ➡️ Available options
|
|
||||||
|
|
||||||
<!--options-->
|
<!--options-->
|
||||||
<table>
|
<table>
|
||||||
@@ -23,7 +31,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_traffic</code></td>
|
<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>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -33,7 +41,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
|
<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>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -45,9 +53,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
|
|||||||
</table>
|
</table>
|
||||||
<!--/options-->
|
<!--/options-->
|
||||||
|
|
||||||
*[→ Full specification](metadata.yml)*
|
## ℹ️ Examples workflows
|
||||||
|
|
||||||
#### ℹ️ Examples workflows
|
|
||||||
|
|
||||||
<!--examples-->
|
<!--examples-->
|
||||||
```yaml
|
```yaml
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
name: "🧮 Repositories traffic"
|
name: "🧮 Repositories traffic"
|
||||||
category: github
|
category: github
|
||||||
|
description: This plugin displays the number of page views across your repositories.
|
||||||
|
examples:
|
||||||
|
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg
|
||||||
index: 19
|
index: 19
|
||||||
supports:
|
supports:
|
||||||
- user
|
- user
|
||||||
@@ -9,15 +12,13 @@ scopes:
|
|||||||
- repo
|
- repo
|
||||||
inputs:
|
inputs:
|
||||||
|
|
||||||
# Enable or disable plugin
|
|
||||||
plugin_traffic:
|
plugin_traffic:
|
||||||
description: Display repositories traffic metrics
|
description: Enable traffic plugin
|
||||||
type: boolean
|
type: boolean
|
||||||
default: no
|
default: no
|
||||||
|
|
||||||
# List of repositories that will be skipped
|
|
||||||
plugin_traffic_skipped:
|
plugin_traffic_skipped:
|
||||||
description: Repositories to skip
|
description: Skipped repositories
|
||||||
type: array
|
type: array
|
||||||
format: comma-separated
|
format: comma-separated
|
||||||
default: ""
|
default: ""
|
||||||
|
|||||||
Reference in New Issue
Block a user