From a8a8313bf7fffbf6abbb32edd360cf88114dfda4 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sun, 16 Jan 2022 08:49:52 -0500 Subject: [PATCH] doc(plugins/people): update --- source/plugins/people/README.md | 117 ++++++++++++++++------------- source/plugins/people/metadata.yml | 91 +++++++++++++--------- 2 files changed, 119 insertions(+), 89 deletions(-) diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md index d3487cbd..fb058870 100644 --- a/source/plugins/people/README.md +++ b/source/plugins/people/README.md @@ -1,39 +1,29 @@ -### 🧑‍🤝‍🧑 People plugin - -The *people* plugin can display people you're following or sponsoring, and also users who're following or sponsoring you. -In repository mode, it's possible to display sponsors, stargazers, watchers. - + - + + + + + + + + + + + + + + +
-
Related to an user - -
-
Related to a repository - -
- -

🧑‍🤝‍🧑 People plugin

This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc.

+
Supported features
→ Full specification		📗 Classic template 📘 Repository template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
Related to an user
+
Related to a repository
+ +
+ -The following types are supported: - -| Type | Alias | User metrics | Repository metrics | -| --------------- | ------------------------------------ | :----------------: | :----------------: | -| `followers` | | ✔ī¸ | ❌ | -| `following` | `followed` | ✔ī¸ | ❌ | -| `sponsoring` | `sponsored`, `sponsorshipsAsSponsor` | ✔ī¸ | ❌ | -| `sponsors` | `sponsorshipsAsMaintainer` | ✔ī¸ | ✔ī¸ | -| `contributors` | | ❌ | ✔ī¸ | -| `stargazers` | | ❌ | ✔ī¸ | -| `watchers` | | ❌ | ✔ī¸ | -| `thanks` | | ✔ī¸ | ✔ī¸ | -| `members` | | ✔ī¸ (organization) | ❌ | - - -Sections will be ordered the same as specified in `plugin_people_types`. -`sponsors` for repositories will output the same as the owner's sponsors. - -#### ➡ī¸ Available options +## ➡ī¸ Available options @@ -42,7 +32,7 @@ Sections will be ordered the same as specified in `plugin_people_types`. - @@ -52,7 +42,7 @@ Sections will be ordered the same as specified in `plugin_people_types`. - @@ -60,11 +50,23 @@ Sections will be ordered the same as specified in `plugin_people_types`. (0 ≤ đ‘Ĩ)
+zero behaviour: disable
default: 24
+ + + + + + + - @@ -77,7 +79,22 @@ Sections will be ordered the same as specified in `plugin_people_types`. - @@ -89,7 +106,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. - @@ -99,27 +117,20 @@ Sections will be ordered the same as specified in `plugin_people_types`. - - - - - - - - - @@ -130,9 +141,7 @@ Sections will be ordered the same as specified in `plugin_people_types`.
plugin_people

Display GitHub users from various affiliations

+

Enable people plugin
plugin_people_limit

Maximum number of user to display

+

Display limit
plugin_people_identicons

Toggle identicons display

+

This can be used to mask user profile pictures for privacy

+
type: boolean +
+default: no
plugin_people_size

Size of displayed GitHub users' avatars

+

Profile picture display size
plugin_people_types

Affiliations to display

+

Displayed sections (order is respected)

+

User and organization accounts support the following values:

+
    +
  • followers
    • +
  • following/followed
    • +
  • sponsoring/sponsored
    • +
  • sponsors
    • +
  • members (organization only)
    • +
  • thanks(to be configured with plugin_people_thanks) +Repositories support the following values:
    • +
  • sponsors (same as owner sponsors)
    • +
  • contributors
    • +
  • stargazers
    • +
  • watchers
    • +
  • thanks(to be configured with plugin_people_thanks)
    • +
plugin_people_thanks

GitHub users to personally thanks

+

Special thanks

+

This list can be used to thank specific users
plugin_people_sponsors_custom

Custom GitHub sponsors

+

Custom sponsors

+

This list can be used to add users from unsupported GitHub sponsors sources. +The option plugin_people_types must contain the sponsors section in order for this setting to be effective
type: array (comma-separated)
plugin_people_identicons

Use identicons instead of avatars

-
type: boolean -
-default: no
plugin_people_shuffle

Shuffle users

+

Shuffle data for varied output

+

This will fetch 10 times more data than plugin_people_limit to ensure output is always different
-*[→ Full specification](metadata.yml)* - -#### ℹī¸ Examples workflows +## ℹī¸ Examples workflows ```yaml @@ -162,4 +171,4 @@ with: marcreichel ``` - \ No newline at end of file + diff --git a/source/plugins/people/metadata.yml b/source/plugins/people/metadata.yml index 26f17058..fadebe76 100644 --- a/source/plugins/people/metadata.yml +++ b/source/plugins/people/metadata.yml @@ -1,5 +1,9 @@ name: "🧑‍🤝‍🧑 People plugin" category: github +description: This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc. +examples: + +related to an user: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.followers.svg + related to a repository: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.repository.svg index: 9 supports: - user @@ -9,75 +13,92 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_people: - description: Display GitHub users from various affiliations + description: Enable people plugin type: boolean default: no - # Number of users to display per section plugin_people_limit: - description: Maximum number of user to display + description: Display limit type: number default: 24 min: 0 + zero: disable + + plugin_people_identicons: + description: | + Toggle identicons display + + This can be used to mask user profile pictures for privacy + type: boolean + default: no - # Size of displayed user's avatar plugin_people_size: - description: Size of displayed GitHub users' avatars + description: Profile picture display size type: number default: 28 min: 8 max: 64 - # List of section to display - # Ordering will be kept plugin_people_types: - description: Affiliations to display + description: | + Displayed sections (order is respected) + + User and organization accounts support the following values: + - `followers` + - `following`/`followed` + - `sponsoring`/`sponsored` + - `sponsors` + - `members` (organization only) + - `thanks`(to be configured with `plugin_people_thanks`) + Repositories support the following values: + - `sponsors` (same as owner sponsors) + - `contributors` + - `stargazers` + - `watchers` + - `thanks`(to be configured with `plugin_people_thanks`) type: array format: comma-separated default: followers, following example: follower, following, sponsors, sponsoring values: - - followers # For user metrics - - following # For user metrics - - followed # For user metrics, alias for "following" - - sponsoring # For user metrics - - members # For organization metrics - - sponsored # Alias for "sponsored" - - sponsors # For both user and repository metrics - - contributors # For repository metrics - - stargazers # For repository metrics - - watchers # For repository metrics - - thanks # For both user and repository metrics, see "plugin_people_thanks" below + - followers + - following + - followed + - sponsoring + - members + - sponsored + - sponsors + - contributors + - stargazers + - watchers + - thanks - # When displaying "thanks" section, specified users list will be displayed - # This is useful to craft "Special thanks" badges plugin_people_thanks: - description: GitHub users to personally thanks + description: | + Special thanks + + This list can be used to thank specific users type: array format: comma-separated default: "" example: octocat, hubot - # Add specified users to GitHub sponsors ("sponsors" must be specified in "plugin_people_types") - # This is useful to list sponsors from unsupported GitHub sponsors sources plugin_people_sponsors_custom: - description: Custom GitHub sponsors + description: | + Custom sponsors + + This list can be used to add users from unsupported GitHub sponsors sources. + The option `plugin_people_types` must contain the `sponsors` section in order for this setting to be effective type: array format: comma-separated default: "" example: octocat, hubot - # Use GitHub identicons instead of users' avatar (for privacy purposes) - plugin_people_identicons: - description: Use identicons instead of avatars - type: boolean - default: no - - # Shuffle users for varied outputs - # If "plugin_people_limit" is set, plugin will fetch up to 10 ten times limit to ensure output is different each time plugin_people_shuffle: - description: Shuffle users + description: | + Shuffle data for varied output + + This will fetch 10 times more data than `plugin_people_limit` to ensure output is always different type: boolean default: no