Skip to content

Commit

Permalink
Lots of typo fixes and grammar tweaks (#581)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
Moohan and coderabbitai[bot] authored Oct 9, 2024
1 parent 1fe1e53 commit d63a7dc
Show file tree
Hide file tree
Showing 30 changed files with 81 additions and 82 deletions.
4 changes: 2 additions & 2 deletions source/docs/contribute/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions source/docs/contribute/maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand All @@ -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.
Expand All @@ -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_
_That's it, since it was not downloaded, no further action from HACS is necessary_
4 changes: 2 additions & 2 deletions source/docs/contribute/translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions source/docs/faq/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions source/docs/faq/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.).
1. What kind of files are downloaded depends on the element type (integration, dashboard, template, etc.).
2 changes: 1 addition & 1 deletion source/docs/faq/private_repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion source/docs/help/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 7 additions & 7 deletions source/docs/publish/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ 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.

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
Expand All @@ -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).
7 changes: 3 additions & 4 deletions source/docs/publish/appdaemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions source/docs/publish/include.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions source/docs/publish/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand All @@ -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).
10 changes: 5 additions & 5 deletions source/docs/publish/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -33,15 +33,15 @@ 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)

#### If there are releases

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
Expand Down
10 changes: 5 additions & 5 deletions source/docs/publish/python_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.
It will scan files in the branch marked as default.
4 changes: 2 additions & 2 deletions source/docs/publish/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions source/docs/publish/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions source/docs/publish/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit d63a7dc

Please sign in to comment.