From d63a7dcc823c763c2e54a9bb64a912324a5e950d Mon Sep 17 00:00:00 2001 From: James McMahon Date: Wed, 9 Oct 2024 09:15:51 +0100 Subject: [PATCH] Lots of typo fixes and grammar tweaks (#581) * Update documentation.md * Update maintainer.md * Update translation.md * Update addons.md * Update download.md * Update private_repositories.md * Update issues.md * Update action.md * Update appdaemon.md * Update include.md * Update integration.md * Update plugin.md * Update python_script.md * Update remove.md * Update start.md * Update template.md * Update theme.md * Update basic.md * Update download.md * Update prerequisites.md * Update appdaemon.md * Update dashboard.md * Update theme.md * Update dashboard.md * Update diagnostics.md * Update hacs_update_broke_my_hacs.md * Update logs.md * Update logs.md * Update data.md * Update remove.md * Update update.md * Update maintainer.md * Update source/docs/publish/appdaemon.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/contribute/translation.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/appdaemon.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/include.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/integration.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/start.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/theme.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/use/data.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/use/download/download.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/include.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/contribute/translation.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/contribute/translation.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/docs/publish/python_script.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- source/docs/contribute/documentation.md | 4 ++-- source/docs/contribute/maintainer.md | 14 +++++++------- source/docs/contribute/translation.md | 4 ++-- source/docs/faq/addons.md | 4 ++-- source/docs/faq/download.md | 4 ++-- source/docs/faq/private_repositories.md | 2 +- source/docs/help/issues.md | 2 +- source/docs/publish/action.md | 14 +++++++------- source/docs/publish/appdaemon.md | 7 +++---- source/docs/publish/include.md | 14 +++++++------- source/docs/publish/integration.md | 6 +++--- source/docs/publish/plugin.md | 10 +++++----- source/docs/publish/python_script.md | 10 +++++----- source/docs/publish/remove.md | 4 ++-- source/docs/publish/start.md | 6 +++--- source/docs/publish/template.md | 8 ++++---- source/docs/publish/theme.md | 6 +++--- source/docs/use/configuration/basic.md | 2 +- source/docs/use/data.md | 4 ++-- source/docs/use/download/download.md | 4 ++-- source/docs/use/download/prerequisites.md | 2 +- source/docs/use/remove.md | 4 ++-- source/docs/use/repositories/dashboard.md | 12 ++++++------ source/docs/use/repositories/type/appdaemon.md | 2 +- source/docs/use/repositories/type/dashboard.md | 2 +- source/docs/use/repositories/type/theme.md | 2 +- source/docs/use/troubleshooting/diagnostics.md | 2 +- .../troubleshooting/hacs_update_broke_my_hacs.md | 2 +- source/docs/use/troubleshooting/logs.md | 2 +- source/docs/use/update.md | 4 ++-- 30 files changed, 81 insertions(+), 82 deletions(-) diff --git a/source/docs/contribute/documentation.md b/source/docs/contribute/documentation.md index 4fe2b16e..999bb903 100644 --- a/source/docs/contribute/documentation.md +++ b/source/docs/contribute/documentation.md @@ -10,7 +10,7 @@ The documentation site for HACS is using [Markdown](https://daringfireball.net/p There are two ways of contributing to the documentation: - Using the **Edit this page on GitHub** link at the bottom of every page. -- Building the documentation locally, using a devcontainer. +- Building the documentation locally using a devcontainer. _All changes to the documentation should go against the `{{ config.remote_branch }}` branch._ The repository for the documentation is hosted @ https://github.com/hacs/documentation @@ -80,7 +80,7 @@ When adding a new screenshot to the documentation, follow these guidelines: - `name_of_the_screenshot/light.png` - `name_of_the_screenshot/dark.png` - Use underscores `_` to separate words - - Use lower case characters + - Use lowercase characters ## Creating links diff --git a/source/docs/contribute/maintainer.md b/source/docs/contribute/maintainer.md index 645d26ac..607d871d 100644 --- a/source/docs/contribute/maintainer.md +++ b/source/docs/contribute/maintainer.md @@ -8,7 +8,7 @@ This page should contain: - information about CI/bots/services. - How releases are handled. -- How versions is handled. +- How versions are handled. @@ -26,16 +26,16 @@ This applies to repositories that fall into these categories: HACS is prepared to handle those, and this is the flow of it: -1. The repository is marked as dangerous/have security issues, by someone opening an issue in https://github.com/hacs/default repository using the "Flag" issue template. -2. The issue is reviewed, if the repository is considered to be of a critical character: +1. The repository is marked as dangerous/has security issues, by someone opening an issue in [the HACS repository](https://github.com/hacs/default) using the "Flag" issue template. +2. The issue is reviewed if the repository is considered to be of a critical character: 1. A PR is opened to add the repository to https://github.com/hacs/default/blob/master/critical 2. That PR will have a description of why, and extra steps you need to take. 3. When it's merged, HACS will know about it during the next scan (30min or Home Assistant restart.) 3. HACS receives an updated [critical file](https://github.com/hacs/default/blob/master/critical). -### If the repository is download with HACS +### If the repository is downloaded with HACS -1. The repository files is removed. +1. The repository files are removed. 2. The repository is removed from HACS. 3. Home Assistant is restarted to make sure it's not loaded anymore. 4. When Home Assistant starts up, you will have a `critical` log entry, and a persistent notification telling you to open the HACS panel. @@ -47,8 +47,8 @@ If you click the "More info about this incident" button you will be taken to the If you click the "Acknowledge" button, you will not see that message anymore. -### If the repository is not download with HACS +### If the repository is not downloaded with HACS 1. The repository is removed from HACS. -_That's it, since it was not download, no further action from HACS is necessary_ \ No newline at end of file +_That's it, since it was not downloaded, no further action from HACS is necessary_ diff --git a/source/docs/contribute/translation.md b/source/docs/contribute/translation.md index 1feb7e40..bdebc27f 100644 --- a/source/docs/contribute/translation.md +++ b/source/docs/contribute/translation.md @@ -12,8 +12,8 @@ To help out with the translation of HACS you need an account on Lokalise, the ea When you have created your account [click here to join the HACS project on Lokalise](https://lokalise.com/public/854515055f679055040b37.42677693/). -If you are unsure on how to proceed their documentation is really good, and you can [find that here](https:/.lokalise.com/en/). Or send me a message @ [discord](https://discord.gg/apgchf8) (username: `ludeeus#4212`) +If you are unsure of how to proceed, their documentation is really good, and you can [find that here](https://lokalise.com/en/). Or send me a message @ [discord](https://discord.gg/apgchf8) (username: `ludeeus#4212`) Before each release new translations are pulled from Lokalise, so if you have added something look for it in the next version of HACS. -If you add elements to the UI of HACS that needs translations, update the [`en.json`](https://github.com/hacs/frontend/blob/master/src/localize/languages/en.json) file, when your PR are merged those new keys will be added to Lokalise ready to be translated. +If you add elements to the UI of HACS that need translations, update the [`en.json`](https://github.com/hacs/frontend/blob/master/src/localize/languages/en.json) file, when your PR is merged, those new keys will be added to Lokalise, ready to be translated. diff --git a/source/docs/faq/addons.md b/source/docs/faq/addons.md index b69e278b..4da6b1da 100644 --- a/source/docs/faq/addons.md +++ b/source/docs/faq/addons.md @@ -11,6 +11,6 @@ description: 'NO, no, nope, this is not an add-on, and does not handle add-ons' ## The exception -With all rules, there will at sompoint exist exceptions. +With all rules, there will be exceptions at some point. -For HACS and add-ons that is now the [Get HACS add-on](https://github.com/hacs/addons) that was made for Home Assistatnt Operating System and Supervised to simplify the initial download of HACS itself. +For HACS and add-ons that is now the [Get HACS add-on](https://github.com/hacs/addons) that was made for Home Assistant Operating System and Supervised to simplify the initial download of HACS itself. diff --git a/source/docs/faq/download.md b/source/docs/faq/download.md index 414a6aba..a9dea009 100644 --- a/source/docs/faq/download.md +++ b/source/docs/faq/download.md @@ -3,9 +3,9 @@ id: download title: "How does it work: Download" description: "How does it work: Download" --- -When you download an element, this is what's happening: +When you download an element, this is what happens: 1. The local target directory (folder) is deleted. 1. A new local target directory is created. 1. All expected files are downloaded to that directory. -1. What kind of files are downloaded depends on the element type (integration, dashboard, template, etc.). \ No newline at end of file +1. What kind of files are downloaded depends on the element type (integration, dashboard, template, etc.). diff --git a/source/docs/faq/private_repositories.md b/source/docs/faq/private_repositories.md index ac93e3be..070186ee 100644 --- a/source/docs/faq/private_repositories.md +++ b/source/docs/faq/private_repositories.md @@ -5,4 +5,4 @@ title: Private GitHub Repositories Private GitHub repositories can not be used with HACS at all. -HACS can only get information that is public. +HACS can only get publicly available information. diff --git a/source/docs/help/issues.md b/source/docs/help/issues.md index 1acf1a9e..a2c11384 100644 --- a/source/docs/help/issues.md +++ b/source/docs/help/issues.md @@ -87,7 +87,7 @@ even replaced the whole hacs folder with a fresh download ### Examples of good issues -_Good issues have too much text to extract it (some also have screenshots), but a few are linked below:_ +_Good issues have too much text to extract (some also have screenshots), but a few are linked below:_ - [https://github.com/hacs/integration/issues/452](https://github.com/hacs/integration/issues/452) - [https://github.com/hacs/integration/issues/470](https://github.com/hacs/integration/issues/470) diff --git a/source/docs/publish/action.md b/source/docs/publish/action.md index bf477256..51880e65 100644 --- a/source/docs/publish/action.md +++ b/source/docs/publish/action.md @@ -7,14 +7,14 @@ description: "Use GitHub Actions to validate your repository with HACS" You can use GitHub actions to validate your repository with HACS. This will make sure that your repository can be validated in HACS after changes to your repository or HACS itself. -This action uses the exact same code as HACS to validate a repository. +This action uses the same code as HACS to validate a repository. -The action have 3 run types: +The action has 3 run types: - For the [hacs/default repo](https://github.com/hacs/default) it is used to validate new default repositories. - If you use releases the latest release will be checked, if not the default branch will be checked. -- If you have it set up for PR's in your repository, it will run against the fork/branch that made the PR. -- If you have it set up for pushes, if will run against the branch you push to. +- If you have it set up for PRs in your repository, it will run against the fork/branch that made the PR. +- If you have it set up for pushes, it will run against the branch you push to. The action itself lives [here](https://github.com/hacs/action) and you are free to inspect the code and/or make a PR to add changes. @@ -22,9 +22,9 @@ To use it, follow these steps: 1. Go to your repository on GitHub 1. Click on "Create new file" -1. For filename, paste .github/workflows/validate.yaml +1. For the filename, paste .github/workflows/validate.yaml 1. Paste the following contents: -1. Change the value of `category` key, this needs to be one of: `appdaemon`, `integration`, `plugin`:material-information-outline:{ title="Plugin is the old name for dashboard but it is still used in the backend" }, `python_script`, `template`, `theme` +1. Change the value of the `category` key, this needs to be one of: `appdaemon`, `integration`, `plugin`:material-information-outline:{ title="Plugin is the old name for dashboard but it is still used in the backend" }, `python_script`, `template`, `theme` ```yaml title=".github/workflows/validate.yml" name: Validate @@ -46,7 +46,7 @@ jobs: category: "CHANGE_ME!" ``` -This will run on every PR and push, and at midnight every day. And `workflow_dispatch` allows you to run the action on demand from the Actions tab. +This will run on every PR and push and at midnight every day. And `workflow_dispatch` allows you to run the action on demand from the Actions tab. !!! tip If you maintain an integration, you can also validate your integration with [hassfest](https://developers.home-assistant.io/blog/2020/04/16/hassfest). diff --git a/source/docs/publish/appdaemon.md b/source/docs/publish/appdaemon.md index dd8d71d0..3aedabdb 100644 --- a/source/docs/publish/appdaemon.md +++ b/source/docs/publish/appdaemon.md @@ -8,13 +8,12 @@ A template to use as a reference is [ad-hacs](https://github.com/ludeeus/ad-hacs ## Requirements -For an AppDaemon app repository to be valid these are the requirements: +For an AppDaemon app repository to be valid, these are the requirements: ### Repository structure - There is only one app (one directory under `ROOT_OF_THE_REPO/apps/`) pr. repository (if you have more, only the first one will be managed.) -- The app (all the python files for it) are located under `ROOT_OF_THE_REPO/apps/APP_NAME/` -- The app and all the python files for it are located under `ROOT_OF_THE_REPO/apps/APP_NAME/` +- The app (all the Python files for it) are located under `ROOT_OF_THE_REPO/apps/APP_NAME/` #### OK example: @@ -43,7 +42,7 @@ README.md When downloading/upgrading it will scan the content in the latest release. -If there are multiple releases in the repository the user have some options to download a specific version. +If there are multiple releases in the repository, the user has some options to download a specific version. The choices will be the last 5 releases and the default branch. #### If there are no releases diff --git a/source/docs/publish/include.md b/source/docs/publish/include.md index b8019e89..a78fdf70 100644 --- a/source/docs/publish/include.md +++ b/source/docs/publish/include.md @@ -4,7 +4,7 @@ title: Include default repositories description: 'Include default repositories' --- -As a developer you can now add your repository to be included in as a default repository in the store. +As a developer, you can now add your repository to be included as a default repository in the store. Only the owner of the repository or a major contributor to it can submit a PR to have it included as a default. @@ -19,9 +19,9 @@ Add both these actions to your own repository and make sure they pass: - https://github.com/home-assistant/actions#hassfest (only for integrations) - https://github.com/hacs/action -When all of this is covered, you can add it to repository type files in https://github.com/hacs/default +When all of this is covered, you can add it to repository type files at [https://github.com/hacs/default](https://github.com/hacs/default) -In your fork of `hacs/default`, create a new branch for your changes from the `master`branch. Do **not** use the`master` branch directly for your changes. +In your fork of `hacs/default`, create a new branch for your changes from the `master` branch. Do **not** use the `master` branch directly for your changes. Your PR needs to be editable, so you can not submit it from an organization. @@ -34,13 +34,13 @@ When a PR for this is merged, it will show up in HACS after the first scheduled ## CI Checks When submitting a repository for the default repository a suite of CI checks will be run to ensure that the repository follows the requirements. -All checks needs to pass for the repository to be included (unless something else are agreed on). +All checks need to pass for the repository to be included (unless something else is agreed on). ### Check Brands _Only applies to integrations._ -This checks that the repository are added to https://github.com/home-assistant/brands +This checks that the repository is added to [https://github.com/home-assistant/brands](https://github.com/home-assistant/brands) ### Check Manifest @@ -88,11 +88,11 @@ This checks general things about the repository like: ### Lint [jq] -This make sure that the files still are valid JSON. +This makes sure that the files still are valid JSON. ### Lint [sorted] -This make sure that the files still are sorted correctly. +This makes sure that the files still are sorted correctly. ## After Submitting diff --git a/source/docs/publish/integration.md b/source/docs/publish/integration.md index 4ef0fb9a..278105dc 100644 --- a/source/docs/publish/integration.md +++ b/source/docs/publish/integration.md @@ -6,7 +6,7 @@ description: "Integrations" ## Requirements -For an integration repository to be valid it must meet the requirements below. +For an integration repository to be valid, it must meet the requirements below. ### Repository structure @@ -60,7 +60,7 @@ Check the official Home Assistant [documentation](https://developers.home-assist ### Home Assistant Brands -You must have added your integration to [home-assistant/brands](https://github.com/home-assistant/brands) conform to the UI standards in Home Assistant. +You must have added your integration to [home-assistant/brands](https://github.com/home-assistant/brands) to conform to the UI standards in Home Assistant. ### GitHub releases (optional) @@ -73,4 +73,4 @@ It is preferred but not required to publish releases in your repository. ### References and examples -A good template to use as a reference is [blueprint](https://github.com/custom-components/blueprint). You can generate a template similar to blueprint and customized to your context by using [cookiecutter-homeassistant-custom-component](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component). +A good template to use as a reference is [blueprint](https://github.com/custom-components/blueprint). You can generate a template similar to blueprint and customize it to your context by using [cookiecutter-homeassistant-custom-component](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component). diff --git a/source/docs/publish/plugin.md b/source/docs/publish/plugin.md index f5da56ff..3b3479be 100644 --- a/source/docs/publish/plugin.md +++ b/source/docs/publish/plugin.md @@ -10,13 +10,13 @@ A good template to use as a reference is [boilerplate-card](https://github.com/c ## Requirements -For a plugin repository to be valid these are the requirements: +For a plugin repository to be valid, these are the requirements: ### Repository structure - There are `.js` files under `ROOT_OF_THE_REPO/dist/` or directly in the root of the repository. -- One of the `.js` files have the same name as the repository. - - With every rule there is an exception, if the repository's name starts with `"lovelace-"`, there can be a `.js` file in the repository matching the repository name with `"lovelace-"` striped from the name, example: +- One of the `.js` files has the same name as the repository. + - With every rule, there is an exception, if the repository's name starts with `"lovelace-"`, there can be a `.js` file in the repository matching the repository name with `"lovelace-"` striped from the name, for example: #### Example @@ -33,7 +33,7 @@ When searching for accepted files HACS will look in this order: All `.js` files it finds in the first location it finds one that matches the name will be downloaded. -If your plugin require files that are not `js` files, place all files (including the card file) in the `dist` directory. +If your plugin requires files that are not `js` files, place all files (including the card file) in the `dist` directory. ### GitHub releases (optional) @@ -41,7 +41,7 @@ If your plugin require files that are not `js` files, place all files (including When downloading/upgrading it will scan the content in the latest release. -If there are multiple releases in the repository the user have some options to download a specific version. +If there are multiple releases in the repository the user has some options to download a specific version. The choices will be the last 5 releases and the default branch. #### If there are no releases diff --git a/source/docs/publish/python_script.md b/source/docs/publish/python_script.md index ab1b9459..36f95a31 100644 --- a/source/docs/publish/python_script.md +++ b/source/docs/publish/python_script.md @@ -10,12 +10,12 @@ This is for the [`python_script` integration in Home Assistant](https://www.home ## Requirements -For a python_script repository to be valid these are the requirements: +For a python_script repository to be valid, these are the requirements: ### Repository structure -- The python script are located here `ROOT_OF_THE_REPO/python_scripts/SCRIPT_NAME.py` -- There is only one python file (one directory under `ROOT_OF_THE_REPO/python_scripts/`) per repository (if you have more, only the first one will be managed.) +- The Python script is located here `ROOT_OF_THE_REPO/python_scripts/SCRIPT_NAME.py` +- There is only one Python file (one directory under `ROOT_OF_THE_REPO/python_scripts/`) per repository (if you have more, only the first one will be managed.) #### OK example: @@ -37,9 +37,9 @@ README.md When downloading/upgrading it will scan the content in the latest release. -If there are multiple releases in the repository the user have some options to download a specific version. +If there are multiple releases in the repository, the user has some options to download a specific version. The choices will be the last 5 releases and the default branch. #### If there are no releases -It will scan files in the branch marked as default. \ No newline at end of file +It will scan files in the branch marked as default. diff --git a/source/docs/publish/remove.md b/source/docs/publish/remove.md index 2a8dea85..c0fc26ea 100644 --- a/source/docs/publish/remove.md +++ b/source/docs/publish/remove.md @@ -6,10 +6,10 @@ description: "Remove default repositories" Repositories can be removed from the default pool of repositories for any number of reasons, some examples: -- It's abandoned +- It has been abandoned - It breaks Home Assistant - It steals credentials -- It's deleted/removed +- It has been deleted or removed !!! warning If you as a maintainer delete/remove the GitHub repository that is added to HACS as a default repository, all your default repositories will be removed from HACS and you will not be able to add any more in the future. diff --git a/source/docs/publish/start.md b/source/docs/publish/start.md index 3c4186bf..44d9e2d7 100644 --- a/source/docs/publish/start.md +++ b/source/docs/publish/start.md @@ -4,7 +4,7 @@ title: General description: 'General' --- -For your repository to be added there are several criteria that need to be met. +For your repository to be added, several criteria need to be met. - [General requirements](#general-requirements) - [Integration requirements](/docs/publish/integration.md) for integrations. @@ -32,7 +32,7 @@ Your repository needs to have a [readme](https://github.com/matiassingers/awesom ### hacs.json -This is a special manifest file that both defines the information that HACS shows in the UI and what files/paths that HACS should use. _This file must be located in the root of your repository._ +This is a special manifest file that defines the information that HACS shows in the UI and what files/paths that HACS should use. _This file must be located in the root of your repository._ The following keys are supported: @@ -87,7 +87,7 @@ Allow Home Assistant beta versions by appending `b0`. Without `b0`, only officia ### Versions -If the repository uses GitHub releases, the tagname from the latest release is used to set the remote version. _Just publishing tags is not enough, you need to publish releases._ +If the repository uses GitHub releases, the tag name from the latest release is used to set the remote version. _Just publishing tags is not enough, you need to publish releases._ If the repository does not use tags, the 7 first characters of the last commit will be used. diff --git a/source/docs/publish/template.md b/source/docs/publish/template.md index 772cd169..e7d9fa5c 100644 --- a/source/docs/publish/template.md +++ b/source/docs/publish/template.md @@ -5,13 +5,13 @@ description: "Publish custom templates with HACS" --- ## Requirements -For a custom template repository to be valid these are the requirements: +For a custom template repository to be valid, these are the requirements: ### Repository structure -- A `README.md` file exist in the root of the repository -- A `hacs.json` file exist in the root of the repository -- A `.jinja` file exist in the root of the repository +- A `README.md` file exists in the root of the repository +- A `hacs.json` file exists in the root of the repository +- A `.jinja` file exists in the root of the repository - The `filename` key of the `hacs.json` file matches a `.jinja` file in the root of the repository - The repository is using GitHub releases diff --git a/source/docs/publish/theme.md b/source/docs/publish/theme.md index 95fe7735..c47e4505 100644 --- a/source/docs/publish/theme.md +++ b/source/docs/publish/theme.md @@ -10,11 +10,11 @@ This is for the [`frontend` integration in Home Assistant](https://www.home-assi ## Requirements -For a theme repository to be valid these are the requirements: +For a theme repository to be valid, these are the requirements: ### Repository structure -- The theme configuration file are located here `ROOT_OF_THE_REPO/themes/SCRIPT_NAME.yaml` +- The theme configuration file is located here `ROOT_OF_THE_REPO/themes/SCRIPT_NAME.yaml` - There is only one theme configuration file (one directory under `ROOT_OF_THE_REPO/themes/`) per repository (if you have more, only the first one will be managed.) #### OK example: @@ -37,7 +37,7 @@ README.md When downloading/upgrading it will scan the content in the latest release. -If there are multiple releases in the repository the user have some options to download a specific version. +If there are multiple releases in the repository, the user has some options to download a specific version. The choices will be the last 5 releases and the default branch. #### If there are no releases diff --git a/source/docs/use/configuration/basic.md b/source/docs/use/configuration/basic.md index da74f5f1..187196a9 100644 --- a/source/docs/use/configuration/basic.md +++ b/source/docs/use/configuration/basic.md @@ -19,7 +19,7 @@ This guide assumes that you have completed the following steps: 1. In Home Assistant, go to . 2. Clear your browser cache. - - HACS won't show up in the list unless you clear your browser cache or perform a hard-refresh. + - HACS won't show up in the list unless you clear your browser cache or perform a hard refresh. 3. In the bottom right corner, select **+ {{coreui('ui.panel.config.integrations.add_integration')}}**. diff --git a/source/docs/use/data.md b/source/docs/use/data.md index a5419bf1..c617c681 100644 --- a/source/docs/use/data.md +++ b/source/docs/use/data.md @@ -9,7 +9,7 @@ All repository data is saved in Home Assistant to files under `.storage` (hidden ## Creating a backup -All HACS data is part of the regular Home Assistant backup. Make sure to regularly backup Home Assistant and store the backup files somewhere safe and outside of your Home Assistant instance. So that you can restore from backup if needed. +All HACS data is part of the regular Home Assistant backup. Make sure to regularly backup Home Assistant and store the backup files somewhere safe outside your Home Assistant instance. So that you can restore from the backup if needed. For instructions on creating a backup, select the link below corresponding to your installation type. @@ -19,4 +19,4 @@ For instructions on creating a backup, select the link below corresponding to yo ## Restoring from a backup -To restore your installation from a backup, follow the steps on [restoring a backup](https://www.home-assistant.io/integrations/backup/#restoring-a-backup) in the Home Assistant documentation. \ No newline at end of file +To restore your installation from a backup, follow the steps on [restoring a backup](https://www.home-assistant.io/integrations/backup/#restoring-a-backup) in the Home Assistant documentation. diff --git a/source/docs/use/download/download.md b/source/docs/use/download/download.md index 146f04bd..94a2d22c 100644 --- a/source/docs/use/download/download.md +++ b/source/docs/use/download/download.md @@ -29,7 +29,7 @@ How you download HACS depends on your Home Assistant installation type. In the i To set up HACS, you can use the [HACS download script](https://github.com/hacs/get). 1. Open a terminal. - 2. Go inside the container with `docker exec -it bash`. + 2. Go inside the container with `docker exec -it bash`. 3. Run the HACS download script. ```bash @@ -56,7 +56,7 @@ How you download HACS depends on your Home Assistant installation type. In the i ## Troubleshooting -- ++ctrl+v++ not working for you? +- Is ++ctrl+v++ not working for you? - Try ++ctrl+shift+v++ instead - Try ++ctrl+ins++ `SHIFT+INS(insert)` instead - Try `Right-click` instead diff --git a/source/docs/use/download/prerequisites.md b/source/docs/use/download/prerequisites.md index ffc0d44d..874ef26d 100644 --- a/source/docs/use/download/prerequisites.md +++ b/source/docs/use/download/prerequisites.md @@ -12,6 +12,6 @@ Before you start using HACS, make sure the following requirements are met: - You know how to access the Home Assistant log file. - You know how to [enable debug logging](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics). - You are aware that although you can use an add-on to download HACS, HACS itself is not an add-on, and does not contain any [add-ons](https://www.home-assistant.io/docs/glossary/#add-on). -- You have a stable internet connection with sufficient available bandwidth and no data caps. +- You have a stable internet connection, sufficient bandwidth, and no data caps. - You are not blocking outgoing requests to GitHub or Cloudflare. - For more information, refer to the documentation under [**FAQ** > **Data sources**](/docs/faq/data_sources.md). diff --git a/source/docs/use/remove.md b/source/docs/use/remove.md index 2c128755..38857d61 100644 --- a/source/docs/use/remove.md +++ b/source/docs/use/remove.md @@ -8,7 +8,7 @@ If you are not planning on using HACS anymore, you can remove HACS. ## Removing HACS 1. In Home Assistant, go to . -2. Select the HACS integration and in the three dot menu (:material-dots-vertical:), select **Delete**. +2. Select the HACS integration and in the three-dot menu (:material-dots-vertical:), select **Delete**. 3. [Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-the-configuration-to-apply-changes). 4. Restart Home Assistant again (yes, this needs to be done twice). @@ -20,5 +20,5 @@ If you are not planning on using HACS anymore, you can remove HACS. # Revoking OAuth access 1. Navigate to https://github.com/settings/applications. -2. In the list of apps, find HACS and select the three dots menu. +2. In the list of apps, find HACS and select the three-dot menu. 3. Select **Revoke**. diff --git a/source/docs/use/repositories/dashboard.md b/source/docs/use/repositories/dashboard.md index 3a5dca65..ea5ca5c7 100644 --- a/source/docs/use/repositories/dashboard.md +++ b/source/docs/use/repositories/dashboard.md @@ -14,9 +14,9 @@ This section shows you how to use the HACS dashboard. 2. To browse the repositories, use the [search](#search-repositories) and [filter](#filtering-repositories) functions. - The HACS dashboard uses the same [table features](https://www.home-assistant.io/docs/organizing/filtering) used elsewhere in Home Assistant. - By default, the dashboard shows the repositories you have downloaded with HACS on top of the list. -3. To view the repository documentation, the select the 3 dots :material-dots-vertical: menu, then select **Show details**. +3. To view the repository documentation, select the 3 dots :material-dots-vertical: menu, then select **Show details**. - To view the source code, select **Repository**. -4. Once you found the custom element you want to use in Home Assistant, [download the repository](#downloading-a-repository). +4. Once you have found the custom element you want to use in Home Assistant, [download the repository](#downloading-a-repository). ## {{coreui("ui.components.data-table.search")}} repositories @@ -76,9 +76,9 @@ HACS [regularly checks the repositories for updates](/docs/faq/data_sources.md/# To use the functionality provided by a repository, you need to download it to Home Assistant. 1. In Home Assistant, open HACS and find the repository of interest. -2. Select the repository and view it's overview page. +2. Select the repository and view its overview page. - The main section of this view renders the README file of the repository. - - The **badges** on top provide some key information, such as author, [GitHub](https://github.com) stars, and number of open issues and pull requests. + - The **badges** on top provide some key information, such as author, [GitHub](https://github.com) stars, and the number of open issues and pull requests. - This page should also contain the documentation on how to use it. - The content depends on the repository [type](/docs/use/repositories/type/index.md) and on the information the author provides. @@ -127,7 +127,7 @@ If you're experiencing an issue with a particular custom element, always report ## Using the HACS Menu -At the top-right corner you will find the 3 dots (:material-dots-vertical:) menu. +At the top-right corner, you will find the 3 dots (:material-dots-vertical:) menu. ![nav_overview](/assets/images/screenshots/overview/menu/light.png#only-light) ![nav_overview](/assets/images/screenshots/overview/menu/dark.png#only-dark) @@ -144,4 +144,4 @@ Here you can: ## Dismissing new repositories Any addition to HACS that you have not yet seen will show the status **New**. -If you are sorting by status, they will show on top by default. If you want, you can dismiss these, so that they are no longer shown as **new**. This is similar to marking mails as *read* in your inbox. \ No newline at end of file +If you are sorting by status, they will show on top by default. If you want, you can dismiss these, so that they are no longer shown as **new**. This is similar to marking emails as *read* in your inbox. diff --git a/source/docs/use/repositories/type/appdaemon.md b/source/docs/use/repositories/type/appdaemon.md index c52a2fc7..6cb22880 100644 --- a/source/docs/use/repositories/type/appdaemon.md +++ b/source/docs/use/repositories/type/appdaemon.md @@ -4,7 +4,7 @@ title: AppDaemon apps AppDaemon apps are apps for [AppDaemon](https://appdaemon.readthedocs.io/en/stable/). -!!! abscract "Not enabled by default" +!!! abstract "Not enabled by default" By default, AppDaemon apps are **not** visible in HACS because they are used only by a small subset of users. To see them, you need to enable discovery in the configuration options. diff --git a/source/docs/use/repositories/type/dashboard.md b/source/docs/use/repositories/type/dashboard.md index c396be8c..bc7e5cd9 100644 --- a/source/docs/use/repositories/type/dashboard.md +++ b/source/docs/use/repositories/type/dashboard.md @@ -17,7 +17,7 @@ Any dashboard element you download with HACS is stored in your [Home Assistant c ## About downloaded dashboard elements -Typically, a dashboard element is a `.js` file. When a `.js` file is downloaded, HACS creates a compressed `.gz` version of it. This file is then served to the requester (instead of the .js file) to reduce size and and transfer time. +Typically, a dashboard element is a `.js` file. When a `.js` file is downloaded, HACS creates a compressed `.gz` version of it. This file is then served to the requester (instead of the .js file) to reduce the size and transfer time. If you made local changes to a dashboard element in the `.js` file, delete the `.gz` variant. The `.gz` variant does not contain your changes. diff --git a/source/docs/use/repositories/type/theme.md b/source/docs/use/repositories/type/theme.md index 4dd256a9..a03e27df 100644 --- a/source/docs/use/repositories/type/theme.md +++ b/source/docs/use/repositories/type/theme.md @@ -7,7 +7,7 @@ layout: type ## Enable themes in Home Assistant -Themes are automagically enabled in HACS if you have them enabled in Home Assistant. +Themes are automatically enabled in HACS if you have them enabled in Home Assistant. To enable themes in Home Assistant, add the following line to your [`configuration.yaml` file](https://www.home-assistant.io/docs/configuration/: diff --git a/source/docs/use/troubleshooting/diagnostics.md b/source/docs/use/troubleshooting/diagnostics.md index fcf67bba..d118ffbc 100644 --- a/source/docs/use/troubleshooting/diagnostics.md +++ b/source/docs/use/troubleshooting/diagnostics.md @@ -3,7 +3,7 @@ title: Diagnostics description: 'How to get HACS diagnostics' --- -The diagnostics file is a JSON file with information about your instance. This file is particularly helpful when you want to report a HACS issue via issue tracker on GitHub. The diagnostics file provides context and helps people understand your setup. +The diagnostics file is a JSON file with information about your instance. This file is particularly helpful when you want to report a HACS issue via the issue tracker on GitHub. The diagnostics file provides context and helps people understand your setup. To get the diagnostics file for HACS, follow these steps: diff --git a/source/docs/use/troubleshooting/hacs_update_broke_my_hacs.md b/source/docs/use/troubleshooting/hacs_update_broke_my_hacs.md index a86ba54a..d06e96f9 100644 --- a/source/docs/use/troubleshooting/hacs_update_broke_my_hacs.md +++ b/source/docs/use/troubleshooting/hacs_update_broke_my_hacs.md @@ -5,7 +5,7 @@ description: "How to recover from a HACS update" ## Symptom -You updated to a newer version of HACS, be it manually or because you had previously set up an update automation, and now HACS does not seems to work as expected anymore. +You updated to a newer version of HACS, be it manually or because you had previously set up an update automation, and now HACS does not seem to work as expected anymore. ## Remedy diff --git a/source/docs/use/troubleshooting/logs.md b/source/docs/use/troubleshooting/logs.md index 5990addd..200f3c00 100644 --- a/source/docs/use/troubleshooting/logs.md +++ b/source/docs/use/troubleshooting/logs.md @@ -15,5 +15,5 @@ logger: aiogithubapi: debug ``` -You might wonder why you cannot just use the [**Enable debug logging**](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) button in the Home Assistant UI. The logs created via this option only include the `custom_components.hacs` logs, but not other parts like `aiogithubapi` or logs written during start up of HACS or Home Assistant. For this reason, you need to define debug logging in your [`configuration.yaml`](https://www.home-assistant.io/docs/configuration/) file. Don't forget to remove the entry once you're done troubleshooting. +You might wonder why you cannot just use the [**Enable debug logging**](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) button in the Home Assistant UI. The logs created via this option only include the `custom_components.hacs` logs, but not other parts like `aiogithubapi` or logs written during the start-up of HACS or Home Assistant. For this reason, you need to define debug logging in your [`configuration.yaml`](https://www.home-assistant.io/docs/configuration/) file. Don't forget to remove the entry once you're done troubleshooting. diff --git a/source/docs/use/update.md b/source/docs/use/update.md index a6689649..a5413707 100644 --- a/source/docs/use/update.md +++ b/source/docs/use/update.md @@ -11,7 +11,7 @@ Follow these steps to update HACS itself. Updating HACS does not automatically u 1. [Create a backup](/docs/use/data.md/#creating-a-backup) and download that backup to another device. 2. In Home Assistant, go to . - - Select the **HACS update** notification and check the release notes for backward-incompatible changes. + - Select the **HACS update** notification and check the release notes for backwards-incompatible changes. - If you're sure you want to update, select **Install**. 3. [Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-the-configuration-to-apply-changes). @@ -32,6 +32,6 @@ These steps assume that you have already downloaded a repository. Follow these s - Open the notification and read the release notes. - Select **Install**. - **Option 2**: From the HACS dashboard. - - The repositories with updates have status **Pending update**. + - The repositories with updates have the status **Pending update**. - Select the 3 dots :material-dots-vertical: menu, then select **Redownload**. 3. If the repository is an integration, [restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-the-configuration-to-apply-changes).