docs(plugins): clarification, fix typos and style

This commit is contained in:
lowlighter
2022-07-04 23:18:01 -04:00
parent 3c00e64c57
commit 52ca4d04b7
47 changed files with 733 additions and 408 deletions

View File

@@ -1,6 +1,7 @@
name: "📜 Repository licenses"
name: 📜 Repository licenses
category: github
description: This plugin display repository license informations like permissions, limitations and conditions along with additional stats about dependencies.
description: |
This plugin display repository license informations like permissions, limitations and conditions along with additional stats about dependencies.
examples:
+permissions, limitations and conditions: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.svg
+licenses overview: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.ratio.svg
@@ -12,23 +13,31 @@ scopes:
inputs:
plugin_licenses:
description: Enable licenses plugin
description: |
Enable licenses plugin
type: boolean
default: no
extras: yes
extras:
- metrics.run.tempdir
- metrics.run.git
- metrics.run.licensed
- metrics.run.user.cmd
plugin_licenses_setup:
description: Setup command
description: |
Setup command
type: string
default: ""
example: npm ci
plugin_licenses_ratio:
description: Display used licenses ratio
description: |
Used licenses ratio
type: boolean
default: no
plugin_licenses_legal:
description: Display permissions, limitations and conditions about licenses
description: |
Permissions, limitations and conditions about used licenses
type: boolean
default: yes