From fe9c4523781d19814a15bba3200f02704578c4cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Sat, 12 Jun 2021 17:36:15 +0000 Subject: [PATCH] Remove pat --- documentation/configuration/legacy.md | 2 +- documentation/configuration/pat.md | 51 --------------------------- documentation/developer/frontend.md | 2 +- sidebars.js | 2 +- static/_redirects | 3 +- 5 files changed, 5 insertions(+), 55 deletions(-) delete mode 100644 documentation/configuration/pat.md diff --git a/documentation/configuration/legacy.md b/documentation/configuration/legacy.md index 8b2f5fd6..9d17ecfc 100644 --- a/documentation/configuration/legacy.md +++ b/documentation/configuration/legacy.md @@ -18,7 +18,7 @@ hacs: | key | optional | default | description | | ----------------- | -------- | ----------------- | -------------------------------------------------------------------------------------------------- | -| `token` | False | | [A Github Personal Access Token](/docs/configuration/pat) | +| `token` | False | | [A Github Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) | | `sidepanel_title` | True | Community | The name used for the sidepanel link. | | `sidepanel_icon` | True | "mdi:alpha-c-box" | The icon used for the sidepanel link. | | `appdaemon` | True | `False` | Enable tracking of AppDaemon apps. | diff --git a/documentation/configuration/pat.md b/documentation/configuration/pat.md deleted file mode 100644 index e8a5f5cf..00000000 --- a/documentation/configuration/pat.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: pat -title: Github Personal Access Token -description: "Create Github Personal Access Token" ---- - -In order to work, HACS needs to retrieve information about repositories using Github's API. - -:::info -Because of the [rate limits set by Github](https://developer.github.com/v3/#rate-limiting), HACS needs to be authenticated by a Personal Access Token, that you can generate using the following steps. -::: - -## Step 1 - Open browser - -_You are probably looking at this in a browser, so we can probably check this off._ - -## Step 2 - Go to your GitHub "Developer settings" - -_And then "Personal access tokens."_ -or click here: [https://github.com/settings/tokens](https://github.com/settings/tokens) - - -## Step 3 - Start generation - -Click the "Generate new token" button. - -![token1](/img/token1.png) - -_If you are asked to login, do so._ - -![token2](/img/token2.png) - -## Step 4 - Choices - -First give it a logical name so that you can recognize it. - -Then click the "Generate token" button at the bottom. - -You **do not** need to check _any_ of the boxes. - -![token3](/img/token3.png) - -## Step 5 - Copy - -Now you see the generated token, this will be the **only** time you see it, make sure that you copy it manually or by clicking the clipboard icon. - -![token4](/img/token4.png) - -## Step 6 - Edit configuration.yml - -Follow the [instructions here](legacy.md) to add the token to the Home Assistant configuration diff --git a/documentation/developer/frontend.md b/documentation/developer/frontend.md index da83702e..11eb6e86 100644 --- a/documentation/developer/frontend.md +++ b/documentation/developer/frontend.md @@ -24,4 +24,4 @@ hacs: frontend_repo_url: http://localhost:5000 ``` -Replace `token` with [A Github Personal Access Token](/docs/configuration/pat) and change `localhost:5000` for the IP of your devserver if not the same. Make sure that your Home Assistant instance can access provided URL. If development frontend isn't hosted on the same device as HA it can't be accessed with `localhost`. +Replace `token` with [A Github Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) and change `localhost:5000` for the IP of your devserver if not the same. Make sure that your Home Assistant instance can access provided URL. If development frontend isn't hosted on the same device as HA it can't be accessed with `localhost`. diff --git a/sidebars.js b/sidebars.js index 8918ff0e..ba55444a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -23,7 +23,7 @@ module.exports = { installation: { Installation: ['installation/prerequisites', 'installation/installation'], Configuration: ['configuration/start', 'configuration/basic', 'configuration/options'], - 'Legacy Configuration (YAML)': ['configuration/legacy', 'configuration/pat'], + 'Legacy Configuration (YAML)': ['configuration/legacy'], Remove: ['installation/remove'], }, 'developer documentation': { diff --git a/static/_redirects b/static/_redirects index 386ccaa1..0fe89499 100644 --- a/static/_redirects +++ b/static/_redirects @@ -3,4 +3,5 @@ https://hacs.netlify.com/* https://hacs.xyz/:splat 301! /docs/installation/manual_cli /docs/installation/prerequisites /docs/installation/manual /docs/installation/prerequisites -/docs/default_repositories /default_repositories \ No newline at end of file +/docs/default_repositories /default_repositories +/docs/configuration/pat /docs/configuration/legacy \ No newline at end of file