diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md
index ff2d833a..80541e91 100644
--- a/source/plugins/notable/README.md
+++ b/source/plugins/notable/README.md
@@ -1,27 +1,29 @@
-### đŠ Notable contributions
-
-The *notable* plugin displays badges of organization where you commited at least once on main branch.
-
+
+
-#### Using `indepth` statistics
-
-The `plugin_notable_indepth` option lets you get additional metrics about your contribution, such as:
-- Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge.
-
-> đŖ On web instances, `indepth` is an extra feature and must be enabled globally in `settings.json`
-
-#### âĄī¸ Available options
+## âĄī¸ Available options
@@ -30,7 +32,7 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
plugin_notable |
- Display notable contributions in organizations
+ | Enable notable plugin
![]() |
@@ -41,6 +43,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
plugin_notable_filter |
Query filter
+Based on GitHub search syntax.
+Supported fields are stars, forks and watchers
![]() |
@@ -49,7 +53,12 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
plugin_notable_from |
- Filter by repository host account type
+ | Filter by repository owner account type
+
+all: no filtering
+organization: only organization accounts repositories
+user: only user accounts repositories
+
![]() |
@@ -60,7 +69,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
plugin_notable_repositories |
- Also display repository name
+ | Toggle repository name display
+Note that Repositories hosted by user account will always be fully displayed
![]() |
@@ -70,7 +80,7 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
plugin_notable_indepth |
- Indepth notable contributions processing
+ | Indepth mode
![]() |
@@ -82,9 +92,14 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
-*[â Full specification](metadata.yml)*
+## đ `indepth` mode
-#### âšī¸ Examples workflows
+The `plugin_notable_indepth` option collects additional stats about your contributions, such as:
+- Total number of commits within a repository or organization.
+
+For each of the above, a badge is awarded. Its color and progress depends of the associated value.
+
+## âšī¸ Examples workflows
```yaml
diff --git a/source/plugins/notable/metadata.yml b/source/plugins/notable/metadata.yml
index 64904b03..c6315055 100644
--- a/source/plugins/notable/metadata.yml
+++ b/source/plugins/notable/metadata.yml
@@ -1,5 +1,9 @@
name: "đŠ Notable contributions"
category: github
+description: This plugin displays badges of repositories where you commited at least once on default branch.
+examples:
+ +indepth analysis: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg
+ contributions in organizations only: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg
index: 15
supports:
- user
@@ -7,41 +11,44 @@ scopes:
- public_access
inputs:
- # Enable or disable plugin
plugin_notable:
- description: Display notable contributions in organizations
+ description: Enable notable plugin
type: boolean
default: no
- # Query filter
- # Based on GitHub search notation
- # Supported fields are "stars", "forks" and "watchers"
plugin_notable_filter:
- description: Query filter
+ description: |
+ Query filter
+
+ Based on [GitHub search syntax](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax).
+ Supported fields are `stars`, `forks` and `watchers`
type: string
default: ""
example: stars:>500 forks:>100
- # Filter repositories depending on which type of account it is hosted
plugin_notable_from:
- description: Filter by repository host account type
+ description: |
+ Filter by repository owner account type
+ - `all`: no filtering
+ - `organization`: only organization accounts repositories
+ - `user`: only user accounts repositories
type: string
default: organization
values:
- - all #
- - organization # Only hosted by organization accounts
- - user # Only hosted by user accounts
+ - all
+ - organization
+ - user
- # Also display repository name along with organization name
- # Note that repositories hosted by user account will always be displayed fully
plugin_notable_repositories:
- description: Also display repository name
+ description: |
+ Toggle repository name display
+
+ Note that Repositories hosted by user account will always be fully displayed
type: boolean
default: no
- # Compute notable contributions with measured impact
plugin_notable_indepth:
- description: Indepth notable contributions processing
+ description: Indepth mode
type: boolean
default: no
extras: yes