doc(plugins/discussions): update

This commit is contained in:
lowlighter
2022-01-15 21:19:46 -05:00
parent 4a8f377685
commit 86ed52f48c
2 changed files with 40 additions and 24 deletions

View File

@@ -1,15 +1,28 @@
### 💬 Discussions <!--header-->
The *discussions* plugin displays your GitHub discussions metrics.
<table> <table>
<td align="center"> <tr><th colspan="2"><h3>💬 Discussions</h3></th></tr>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg"> <tr><td colspan="2" align="center"><p>This plugin displays your GitHub discussions stats.</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></td>
</tr>
<tr>
<td><code>👤 Users</code></td>
</tr>
<tr>
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg" alt=""></img>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</tr>
</table> </table>
<!--/header-->
#### ➡️ Available options ## ➡️ Available options
<!--options--> <!--options-->
<table> <table>
@@ -18,7 +31,7 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_discussions</code></td> <td nowrap="nowrap"><code>plugin_discussions</code></td>
<td rowspan="2"><p>GitHub discussions metrics</p> <td rowspan="2"><p>Enable discussions plugin</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>
@@ -28,7 +41,7 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_discussions_categories</code></td> <td nowrap="nowrap"><code>plugin_discussions_categories</code></td>
<td rowspan="2"><p>Display discussion categories</p> <td rowspan="2"><p>Toggle discussion categories display</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>
@@ -39,21 +52,21 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_discussions_categories_limit</code></td> <td nowrap="nowrap"><code>plugin_discussions_categories_limit</code></td>
<td rowspan="2"><p>Number of discussion categories to display</p> <td rowspan="2"><p>Display limit (categories)</p>
<p>Note that categories are sorted from highest to lowest count.</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br> <td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code> <b>type:</b> <code>number</code>
<br> <br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 0<br></td> <b>default:</b> 0<br></td>
</tr> </tr>
</table> </table>
<!--/options--> <!--/options-->
*[→ Full specification](metadata.yml)* ## Examples workflows
#### Examples workflows
<!--examples--> <!--examples-->
```yaml ```yaml

View File

@@ -1,5 +1,8 @@
name: "💬 Discussions" name: "💬 Discussions"
category: github category: github
description: This plugin displays your GitHub discussions stats.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg
index: 16 index: 16
supports: supports:
- user - user
@@ -7,21 +10,21 @@ scopes:
- public_access - public_access
inputs: inputs:
# Enable or disable plugin
plugin_discussions: plugin_discussions:
description: GitHub discussions metrics description: Enable discussions plugin
type: boolean type: boolean
default: no default: no
# Display discussion categories you have taken part in
plugin_discussions_categories: plugin_discussions_categories:
description: Display discussion categories description: Toggle discussion categories display
type: boolean type: boolean
default: yes default: yes
# Maximum number of categories to display (note that these are sorted desc)
# Set to 0 to disable limitations
plugin_discussions_categories_limit: plugin_discussions_categories_limit:
description: Number of discussion categories to display description: |
Display limit (categories)
Note that categories are sorted from highest to lowest count.
type: number type: number
default: 0 default: 0
zero: disable