Skip to content

Commit 82c15c3

Browse files
authored
update for new fine grain GitHub tokens
1 parent 73ff50e commit 82c15c3

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,19 @@ cd documentation
5959
We use the [gatsby-remark-embed-snippet](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-remark-embed-snippet) to use files from GitHub in our docs. Before you can build a local development site, you need to provide a GitHub token to the environment:
6060

6161
1. Log in to GitHub and go to <https://github.com/settings/tokens>
62-
1. Click **Generate new token**
62+
1. Click **Generate new token**.
63+
1. Give the token a name, expiration, and description.
64+
1. Select your GitHub user as the resource owner.
65+
1. For repository access, select **Only select repositories** and select your fork of this repository.
66+
1. Under Repository permissions, choose **Access: Read-only** from the **Access** dropdown button.
67+
1. Click **Generate token**.
68+
69+
#### GitHub Tokens (classic)
70+
71+
Alternatively, if you'd rather create a classic-style token:
72+
73+
1. Log in to GitHub and go to <https://github.com/settings/tokens>
74+
1. Click **Generate new token (classic)**
6375
1. Give the token a name and click the **public_repo** checkbox, then the **Generate Token** button at the bottom
6476
1. Copy the token to your clipboard
6577
1. In the root `documentation` directory, create a new file called `.env.development` and add (replacing `$TOKENHASH` ):
@@ -81,7 +93,7 @@ npm ci
8193
Still in the `documentation` directory:
8294
8395
```bash
84-
npm run develop
96+
npm start
8597
```
8698
8799
Use your local browser to navigate to `localhost:8000/`.

0 commit comments

Comments
 (0)