From 780d7b136321e35405f84d23cccc8145f64142ce Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 11 May 2020 19:14:19 +0200 Subject: [PATCH] Small updates to add-on documentation (#517) --- docs/add-ons/configuration.md | 8 ++++---- docs/add-ons/presentation.md | 2 +- docs/add-ons/publishing.md | 14 +++++++------- docs/add-ons/tutorial.md | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index 600b119b..2fa0e204 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -27,12 +27,12 @@ All our Images have also [bashio][bashio] installed. It contains a set of common When developing your script: - `/data` is a volume for persistent storage. -- `/data/options.json` contains the user configuration. You can use Bashio or `jq` inside your shell script to parse this data. +- `/data/options.json` contains the user configuration. You can use Bashio to parse this data. ```shell CONFIG_PATH=/data/options.json -TARGET="$(jq --raw-output '.target' $CONFIG_PATH)" +TARGET="$(basio::config 'target')" ``` So if your `options` contain @@ -56,7 +56,7 @@ FROM $BUILD_FROM ENV LANG C.UTF-8 # Install requirements for add-on -RUN apk add --no-cache jq +RUN apk add --no-cache example_alpine_package # Copy data for add-on COPY run.sh / @@ -214,7 +214,7 @@ We support: ## Add-on extended build Additional build options for an add-on is stored in `build.json`. This file will be read from our build systems. -You need this only, if you not use the default images or need additionals things. +You need this only, if you not use the default images or need additional things. ```json { diff --git a/docs/add-ons/presentation.md b/docs/add-ons/presentation.md index f496c8fb..e4a29630 100644 --- a/docs/add-ons/presentation.md +++ b/docs/add-ons/presentation.md @@ -14,7 +14,7 @@ This file containing the intro is usually referred to as the "README", which is Good documentation helps the consumer of your add-on to understand its usage, explains configuration options, points users in the right direction in the case they have questions or issues, and contains the license under which the add-on was published. -This file containing the documentation is usually referred to as the "DOC", which is generally published as the `DOC.md` file. +This file containing the documentation is usually referred to as the "DOCS", which is generally published as the `DOCS.md` file. ## Add-on icon & logo diff --git a/docs/add-ons/publishing.md b/docs/add-ons/publishing.md index 30301cfb..d158918d 100644 --- a/docs/add-ons/publishing.md +++ b/docs/add-ons/publishing.md @@ -39,18 +39,18 @@ You need a Docker Hub account to make your own add-ons. You can build your Docke For a git repository: ```shell -$ docker run --rm --privileged -v \ - ~/.docker:/root/.docker homeassistant/amd64-builder \ - --all -t addon-folder -r https://github.com/xy/addons \ - -b branchname +docker run --rm --privileged -v \ + ~/.docker:/root/.docker homeassistant/amd64-builder \ + --all -t addon-folder -r https://github.com/xy/addons \ + -b branchname ``` For a local repository: ```shell -$ docker run --rm --privileged -v \ - ~/.docker:/root/.docker -v /my_addon:/data homeassistant/amd64-builder \ - --all -t /data +docker run --rm --privileged -v \ + ~/.docker:/root/.docker -v /my_addon:/data homeassistant/amd64-builder \ + --all -t /data ``` :::tip diff --git a/docs/add-ons/tutorial.md b/docs/add-ons/tutorial.md index a81d0560..acf701de 100644 --- a/docs/add-ons/tutorial.md +++ b/docs/add-ons/tutorial.md @@ -146,7 +146,7 @@ python3 -m http.server 8000 Since we updated the version number in our `config.json`, Home Assistant will show an update button when looking at the add-on details. You might have to refresh your browser or click the refresh button in the add-on store for it to show up. If you did not update the version number, you can also uninstall and install the add-on again. After installing the add-on again, make sure you start it. -Now navigate to [http://hassio.local:8000](http://hassio.local:8000) to see our server in action! +Now navigate to [http://homeassistant.local:8000](http://homeassistant.local:8000) to see our server in action! ![Screenshot of the file index served by the add-on](/img/en/hass.io/tutorial/python3-http-server.png)