Skip to content

Commit 0849c3f

Browse files
Patch 1 documentation updates (#267)
* Improve documentation following deployment test in Kubernetes using a GitHub App * code review fixes --------- Co-authored-by: Sébastien Bonami <7561088+sebastienbonami@users.noreply.github.com>
1 parent 6225ba0 commit 0849c3f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Public variables:
158158
- `NUXT_PUBLIC_GITHUB_ORG`
159159
- `NUXT_PUBLIC_GITHUB_TEAM`
160160

161-
can be overriden by route parameters, e.g.
161+
can be overridden by route parameters, e.g.
162162
- `http://localhost:3000/enterprises/octo-demo-ent`
163163
- `http://localhost:3000/orgs/octo-demo-org`
164164
- `http://localhost:3000/orgs/octo-demo-org/teams/the-a-team`
@@ -227,19 +227,19 @@ For more information see [Nuxt Sessions and Authentication](https://nuxt.com/doc
227227
228228
#### NUXT_PUBLIC_USING_GITHUB_AUTH
229229

230-
Default is `false`. When set to `true`, GitHub OAuth App Authentication will be performed to verify users' access to the dashboard. For this, a GitHub App must be registered and installed in the enterprise/org. See [Github App Registration](DEPLOYMENT.md#github-app-registration) for the steps to follow.
230+
Default is `false`. When set to `true`, GitHub OAuth App Authentication will be performed to verify users' access to the dashboard. For this, a GitHub App must be registered and installed in the enterprise/org. See [GitHub App Registration](DEPLOYMENT.md#github-app-registration) for the steps to follow.
231231

232232
Variables required for GitHub Auth are:
233233
1. `NUXT_OAUTH_GITHUB_CLIENT_ID` - client ID of the GitHub App.
234234
2. `NUXT_OAUTH_GITHUB_CLIENT_SECRET` - client secret of the GitHub App.
235-
3. [Optional] `NUXT_OAUTH_GITHUB_CLIENT_SCOPE` for scope requests when using OAuth App instead of GitHub App. See [Github docs](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps) for details.
235+
3. [Optional] `NUXT_OAUTH_GITHUB_CLIENT_SCOPE` for scope requests when using OAuth App instead of GitHub App. See [GitHub docs](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps) for details.
236236

237237
>[!WARNING]
238238
> Only users with permissions (scopes listed in [NUXT_GITHUB_TOKEN](#NUXT_GITHUB_TOKEN)) can view copilot metrics, GitHub uses the authenticated users permissions to make API calls for data.
239239
240240
#### HTTP_PROXY
241241

242-
Solution supports HTTP Proxy settings when running in corporate environment. Simple set `HTTP_PROXY` environment variable.
242+
Solution supports HTTP Proxy settings when running in corporate environment. Simply set `HTTP_PROXY` environment variable.
243243

244244
For custom CA use environment variable `CUSTOM_CA_PATH` to load the certificate into proxy agent options.
245245

0 commit comments

Comments
 (0)