From b01b9dd11457e2ff657ff2e3ae32a3225dfa5ba3 Mon Sep 17 00:00:00 2001 From: Daofeng Wu Date: Fri, 26 Apr 2024 00:54:39 +0900 Subject: [PATCH] doc(github): add guide for scope auth --- docs/pages/api-apps/github.mdx | 2 +- docs/pages/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/api-apps/github.mdx b/docs/pages/api-apps/github.mdx index 51be21ad..b17759b4 100644 --- a/docs/pages/api-apps/github.mdx +++ b/docs/pages/api-apps/github.mdx @@ -12,7 +12,7 @@ The GitHub App is crafted to refine your GitHub workflow, offering efficient man ### Get Github Access Token - Follow this guide to get your GitHub access token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens + Follow this guide to get your GitHub access token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. You may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)) ### Authorization diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index 33a21f2d..11d6cc2c 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -59,7 +59,7 @@ Confirm server connectivity by running `npi connect test`. If you receive a `ser ### Authorize NPi to access your GitHub account -Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to your GitHub account with: +Generate a new token via [GitHub Tokens Page](https://github.com/settings/tokens) for NPi, and authorize NPi's access to your GitHub account with the following command. You may need to grant the `repo` scope so that NPi can access repositories on behalf of you. ([Read more about scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)) ```sh npi auth github --access-token YOUR_GITHUB_ACCESS_TOKEN