Doc updates #1980
Draft
Doc updates #1980
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davet2001
requested changes
Apr 6, 2024
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Dave T <17680170+davet2001@users.noreply.github.com>
Co-authored-by: Dave T <17680170+davet2001@users.noreply.github.com>
|
I've made those changes, thanks for having a look! |
davet2001
requested changes
Apr 30, 2024
| @@ -57,6 +57,8 @@ then there will be a variable `TARGET` containing `beer` in the environment of y | |||
|
|
|||
| All add-ons are based on the latest Alpine Linux image. Home Assistant will automatically substitute the right base image based on the machine architecture. Add `tzdata` if you need to run in a different timezone. `tzdata` Is is already added to our base images. | |||
|
|
|||
| Images can be found [here](https://github.com/home-assistant/docker-base/blob/master/README.md). To test your add-on, you can build with these locally, e.g. on a 64-bit desktop `docker build --build-arg BUILD_FROM=ghcr.io/home-assistant/amd64-base` | |||
There was a problem hiding this comment.
I think what you are adding is already covered by an existing page.
https://developers.home-assistant.io/docs/add-ons/testing#local-build
So it might be better to link to it, or at least make reference to it.
| @@ -61,7 +61,7 @@ arch: | |||
|
|
|||
| ### The `run.sh` file | |||
|
|
|||
| This is the script that will run when your add-on starts. | |||
| This is the script that will run when your add-on starts. It runs in `bashio` which is a Home Assistant shell that adds a few features. Build from the base Home Assistant images to run your containers locally. | |||
There was a problem hiding this comment.
Suggested change
| This is the script that will run when your add-on starts. It runs in `bashio` which is a Home Assistant shell that adds a few features. Build from the base Home Assistant images to run your containers locally. | |
| This is the script that will run when your add-on starts. It runs in `bashio` which is a Home Assistant shell that adds a few features. |
Is the last part of the addition necessary?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Add more information to documentation
Type of change
I've just been through the process of creating my own addon, and these are some things I've learnt and I think would help newcomers. Please check that what I have written is correct!
Additional information