sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: update images (close #860) [skip ci]

Browse Source
This commit is contained in:
lowlighter
2022-02-15 23:52:22 -05:00
parent ca913a1d56
commit 740947ba9f
31 changed files with 22 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/readme/partials/documentation/organizations.md vendored
View File

@@ -8,7 +8,8 @@ While *metrics* targets mainly user accounts, it's possible to render metrics fo
Setup is mostly the same as for user accounts. A personal access token from an user account is required excepted that `read:org` scope must be enabled, **whether you are member of the target organization or not**.
![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.png)
![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.light.png#gh-light-mode-only)
![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.dark.png#gh-dark-mode-only)
`user` option will need to be set to organization name instead.
@@ -33,7 +34,8 @@ It is possible to host workflows in the `.github` repository of organizations, a
By default, GitHub only display public memberships.
Membership visibility canbe managed in the `People` tab of your organization.
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.png)
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.light.png#gh-light-mode-only)
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.dark.png#gh-dark-mode-only)
> ⚠️ Seeing your organization membership in your profile **does not** mean that it is visible from other users! You can check this by viewing your profile in an private browser window.

18
.github/readme/partials/documentation/setup/action.md vendored
View File

@@ -6,11 +6,13 @@ Setup a GitHub Action which runs periodically and pushes generated images to a r
Create a repository with the same name as your GitHub login (if it doesn't exist).
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png)
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.light.png#gh-light-mode-only)
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.dark.png#gh-dark-mode-only)
Its `README.md` will be displayed on your user profile:
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.png)
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.light.png#gh-light-mode-only)
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.dark.png#gh-dark-mode-only)
## 1️ Create a GitHub personal token
@@ -27,11 +29,13 @@ A a general rule, the following scopes may be required:
> 💡 For security reasons, it is advised to always use the least amount of scopes. It is possible to prevent security issues by [forking this repository](https://github.com/lowlighter/metrics/fork) and using it in your workflow instead (more information available in step 3)
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png)
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.light.png#gh-light-mode-only)
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.dark.png#gh-dark-mode-only)
A scope-less token can still display private contributions by enabling `Include private contributions on my profile` in account settings:
![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.png)
![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.light.png#gh-light-mode-only)
![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.dark.png#gh-dark-mode-only)
When a plugin has not enough scopes to operate (and `plugins_errors_fatal` is disabled), an error will be reported in the rendering like below:
@@ -41,7 +45,8 @@ When a plugin has not enough scopes to operate (and `plugins_errors_fatal` is di
Go to the `Settings` of your repository and to create a new secret and paste your freshly generated GitHub token there.
![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.png)
![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.light.png#gh-light-mode-only)
![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.dark.png#gh-dark-mode-only)
## 3️ Setup GitHub Action workflow
@@ -67,7 +72,8 @@ jobs:
Rendered metrics will be committed to repository on each run.
![Action update example](/.github/readme/imgs/example_action_update.png)
![Action update example](/.github/readme/imgs/example_action_update.light.png#gh-light-mode-only)
![Action update example](/.github/readme/imgs/example_action_update.dark.png#gh-dark-mode-only)
### 3️.1️ Choosing between `@latest`, `@master`/`@main`, a fork or a pinned version

6
.github/readme/partials/documentation/setup/shared.md vendored
View File

@@ -6,11 +6,13 @@ For convenience, a free shared instance is available at [metrics.lecoq.io](https
Create a repository with the same name as your GitHub login (if it doesn't exist).
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png)
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.light.png#gh-light-mode-only)
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.dark.png#gh-dark-mode-only)
Its `README.md` will be displayed on your user profile:
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.png)
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.light.png#gh-light-mode-only)
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.dark.png#gh-dark-mode-only)
## 2️ Configure *metrics*

3
.github/readme/partials/documentation/setup/web.md vendored
View File

@@ -14,7 +14,8 @@ No additional scopes are required.
> 💡 For security reasons, it is advised to use a scope-less token for web instances.
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png)
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.light.png#gh-light-mode-only)
![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.dark.png#gh-dark-mode-only)
## 2️ Configure *metrics*