docs: update images (close #860) [skip ci]
BIN
.github/readme/imgs/example_action_update.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 8.7 KiB |
BIN
.github/readme/imgs/example_action_update.light.png
vendored
Normal file
|
After Width: | Height: | Size: 8.2 KiB |
BIN
.github/readme/imgs/example_action_update.png
vendored
|
Before Width: | Height: | Size: 10 KiB |
BIN
.github/readme/imgs/example_github_profile.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 350 KiB |
BIN
.github/readme/imgs/example_github_profile.light.png
vendored
Normal file
|
After Width: | Height: | Size: 279 KiB |
BIN
.github/readme/imgs/example_github_profile.png
vendored
|
Before Width: | Height: | Size: 274 KiB |
BIN
.github/readme/imgs/setup_personal_repository.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 15 KiB |
BIN
.github/readme/imgs/setup_personal_repository.light.png
vendored
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
.github/readme/imgs/setup_personal_repository.png
vendored
|
Before Width: | Height: | Size: 19 KiB |
BIN
.github/readme/imgs/setup_personal_token.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 34 KiB |
BIN
.github/readme/imgs/setup_personal_token.light.png
vendored
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
.github/readme/imgs/setup_personal_token.png
vendored
|
Before Width: | Height: | Size: 31 KiB |
BIN
.github/readme/imgs/setup_private_contributions.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
.github/readme/imgs/setup_private_contributions.light.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
.github/readme/imgs/setup_private_contributions.png
vendored
|
Before Width: | Height: | Size: 11 KiB |
BIN
.github/readme/imgs/setup_public_membership_org.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
.github/readme/imgs/setup_public_membership_org.light.png
vendored
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
.github/readme/imgs/setup_public_membership_org.png
vendored
|
Before Width: | Height: | Size: 106 KiB |
BIN
.github/readme/imgs/setup_repository_secret.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
.github/readme/imgs/setup_repository_secret.light.png
vendored
Normal file
|
After Width: | Height: | Size: 33 KiB |
BIN
.github/readme/imgs/setup_repository_secret.png
vendored
|
Before Width: | Height: | Size: 88 KiB |
BIN
.github/readme/imgs/setup_token_org_read_scope.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 7.5 KiB |
BIN
.github/readme/imgs/setup_token_org_read_scope.light.png
vendored
Normal file
|
After Width: | Height: | Size: 7.4 KiB |
BIN
.github/readme/imgs/setup_token_org_read_scope.png
vendored
|
Before Width: | Height: | Size: 7.5 KiB |
BIN
.github/readme/imgs/setup_token_repo_scope.dark.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
.github/readme/imgs/setup_token_repo_scope.light.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
.github/readme/imgs/setup_token_repo_scope.png
vendored
|
Before Width: | Height: | Size: 11 KiB |
@@ -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**.
|
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**.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
`user` option will need to be set to organization name instead.
|
`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.
|
By default, GitHub only display public memberships.
|
||||||
Membership visibility canbe managed in the `People` tab of your organization.
|
Membership visibility canbe managed in the `People` tab of your organization.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
> ⚠️ 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.
|
> ⚠️ 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.
|
||||||
|
|
||||||
|
|||||||
@@ -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).
|
Create a repository with the same name as your GitHub login (if it doesn't exist).
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
Its `README.md` will be displayed on your user profile:
|
Its `README.md` will be displayed on your user profile:
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## 1️ Create a GitHub personal token
|
## 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)
|
> 💡 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)
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
A scope-less token can still display private contributions by enabling `Include private contributions on my profile` in account settings:
|
A scope-less token can still display private contributions by enabling `Include private contributions on my profile` in account settings:
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
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:
|
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.
|
Go to the `Settings` of your repository and to create a new secret and paste your freshly generated GitHub token there.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## 3️ Setup GitHub Action workflow
|
## 3️ Setup GitHub Action workflow
|
||||||
|
|
||||||
@@ -67,7 +72,8 @@ jobs:
|
|||||||
|
|
||||||
Rendered metrics will be committed to repository on each run.
|
Rendered metrics will be committed to repository on each run.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
### 3️.1️ Choosing between `@latest`, `@master`/`@main`, a fork or a pinned version
|
### 3️.1️ Choosing between `@latest`, `@master`/`@main`, a fork or a pinned version
|
||||||
|
|
||||||
|
|||||||
@@ -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).
|
Create a repository with the same name as your GitHub login (if it doesn't exist).
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
Its `README.md` will be displayed on your user profile:
|
Its `README.md` will be displayed on your user profile:
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## 2️ Configure *metrics*
|
## 2️ Configure *metrics*
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,8 @@ No additional scopes are required.
|
|||||||
|
|
||||||
> 💡 For security reasons, it is advised to use a scope-less token for web instances.
|
> 💡 For security reasons, it is advised to use a scope-less token for web instances.
|
||||||
|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
## 2️ Configure *metrics*
|
## 2️ Configure *metrics*
|
||||||
|
|
||||||
|
|||||||