From ef557240367bcdf2896675199f64c17013363973 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Thu, 8 Apr 2021 20:37:23 +0200 Subject: [PATCH] Update image links --- .../readme/partials/documentation/contributing.md | 2 ++ .../readme/partials/documentation/organizations.md | 6 +++--- .github/readme/partials/setup/action.md | 12 ++++++------ .github/readme/partials/setup/web.md | 2 +- CONTRIBUTING.md | 4 ++-- 5 files changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/readme/partials/documentation/contributing.md b/.github/readme/partials/documentation/contributing.md index 101843cd..14c94262 100644 --- a/.github/readme/partials/documentation/contributing.md +++ b/.github/readme/partials/documentation/contributing.md @@ -9,3 +9,5 @@ To suggest new features or requesting help to setup metrics, check out [discussi If you want to contribute, submit a [pull request](https://github.com/lowlighter/metrics/pulls). Be sure to read [CONTRIBUTING.md](CONTRIBUTING.md) for more information about this. + +If you don't know where to start, you can also take a look at issues labeled with [help wanted](https://github.com/lowlighter/metrics/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). \ No newline at end of file diff --git a/.github/readme/partials/documentation/organizations.md b/.github/readme/partials/documentation/organizations.md index 6d8a8591..8b84fb0d 100644 --- a/.github/readme/partials/documentation/organizations.md +++ b/.github/readme/partials/documentation/organizations.md @@ -9,7 +9,7 @@ While metrics targets mainly user accounts, it's possible to render metrics for Setup is the same as for user accounts, though you'll need to add `read:org` scope, **whether you're member of 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.png) You'll also need to set `user` option with your organization name. @@ -37,11 +37,11 @@ To support private repositories, add full `repo` scope to your personal token. Only public memberships can be displayed by metrics by default. You can manage your membership visibility 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.png) For organization memberships, add `read:org` scope to your personal token. -![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.png) diff --git a/.github/readme/partials/setup/action.md b/.github/readme/partials/setup/action.md index bff5f779..8bfadf94 100644 --- a/.github/readme/partials/setup/action.md +++ b/.github/readme/partials/setup/action.md @@ -19,11 +19,11 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics Create a repository with the same name as your GitHub login (if it's not already done). -![Setup personal repository](.github/readme/imgs/setup_personal_repository.png) +![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png) 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.png) ### 1. Create a GitHub personal token @@ -34,11 +34,11 @@ No additional scopes are needed for basic metrics, but you may have to grant add - `read:org` scope for all organizations related metrics - `repo` scope for all private repositories related metrics -![Setup a GitHub personal token](.github/readme/imgs/setup_personal_token.png) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png) A scope-less token can still display private contributions by enabling `Include private contributions on my profile` in your 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.png) If a plugin has not enough scopes to operate (and `plugins_errors_fatal` isn't enabled), it'll be reported in the rendering like below: @@ -48,7 +48,7 @@ If a plugin has not enough scopes to operate (and `plugins_errors_fatal` isn't e Go to the `Settings` of your repository 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.png) ### 3. Create a GitHub Action workflow in your repository @@ -77,7 +77,7 @@ See all supported options in [action.yml](action.yml). Rendered metrics will be committed to your repository on each run. -![Action update example](.github/readme/imgs/example_action_update.png) +![Action update example](/.github/readme/imgs/example_action_update.png) #### Choosing between `@latest`, `@master` or a fork diff --git a/.github/readme/partials/setup/web.md b/.github/readme/partials/setup/web.md index b25f29af..d67f8a84 100644 --- a/.github/readme/partials/setup/web.md +++ b/.github/readme/partials/setup/web.md @@ -23,7 +23,7 @@ From the `Developer settings` of your account settings, select `Personal access No additional scopes are needed. -![Setup a GitHub personal token](.github/readme/imgs/setup_personal_token.png) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png) ### 2. Install dependencies diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c156607..21d9e448 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -564,7 +564,7 @@ This section explore some topics which explain globally how metrics was designed Metrics actually exploit the possibility of integrating HTML and CSS into SVGs, so basically creating these images is as simple as designing static web pages. It can even handle animations and transparency. -![Metrics are html](.github/readme/imgs/about_metrics_are_html.png) +![Metrics are html](/.github/readme/imgs/about_metrics_are_html.png) SVGs are templated through [EJS framework](https://github.com/mde/ejs) to make the whole rendering process easier thanks to variables, conditional and loop statements. Only drawback is that it tends to make syntax coloration a bit confused because templates are often misinterpreted as HTML tags markers (`<%= "EJS templating syntax" %>`). @@ -574,7 +574,7 @@ Since SVG renders differently depending on OS and browsers (system fonts, CSS su To solve this, metrics now spawns a [puppeteer](https://github.com/puppeteer/puppeteer) instance and directly render SVG in a browser environment (with all animations disabled). An hidden "marker" element is placed at the end of the image, and is used to resize image through its Y-offset. -![Metrics marker](.github/readme/imgs/about_metrics_marker.png) +![Metrics marker](/.github/readme/imgs/about_metrics_marker.png) Additional bonus of using pupeeter is that it can take screenshots, making it easy to convert SVGs to PNG output.