From a415970586cb29ff7fecfb4c3e97b22c102c3656 Mon Sep 17 00:00:00 2001 From: David De Sloovere Date: Sat, 26 Sep 2020 19:16:16 +0200 Subject: [PATCH] Fix typo in add-on publishing (#652) --- docs/add-ons/publishing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/add-ons/publishing.md b/docs/add-ons/publishing.md index d158918d..50ad22b2 100644 --- a/docs/add-ons/publishing.md +++ b/docs/add-ons/publishing.md @@ -2,17 +2,17 @@ title: "Publishing your add-on" --- -There are two different ways of publishing add-ons. One is to publish pre-build containers to Docker Hub and the other option is to have users build the containers locally on their Home Assistant instance. +There are two different ways of publishing add-ons. One is to publish pre-built containers to Docker Hub and the other option is to have users build the containers locally on their Home Assistant instance. -#### Pre-build containers +#### Pre-built containers -With pre-build containers, the developer is responsible for building the images for each architecture on their machine and push the results out to Docker Hub. This has a lot of advantages for the user. As a user it will only have to download the final container and be up and running once the download finishes. This makes the installation process fast and almost no chance of failure. This is the preferred method. +With pre-built containers, the developer is responsible for building the images for each architecture on their machine and push the results out to Docker Hub. This has a lot of advantages for the user. As a user it will only have to download the final container and be up and running once the download finishes. This makes the installation process fast and almost no chance of failure. This is the preferred method. We have automated the process of building and publishing add-ons. See below for the instructions. #### Locally build containers -Starting Supervisor 26, it is possible to distribute add-ons that will be built on the users machine. The advantage is that as a developer it is easy to test an idea and see if people are interested in your add-ons. This method includes installing and potentially compiling code. This means that installing such an add-on is slow and adds more wear and tear to users SD card/hard drive than the above mentioned pre-build solution. It also has a higher chance of failure if one of the dependencies of the container has changed or is no longer available. +Starting with Supervisor 26, it is possible to distribute add-ons that will be built on the users machine. The advantage is that as a developer it is easy to test an idea and see if people are interested in your add-ons. This method includes installing and potentially compiling code. This means that installing such an add-on is slow and adds more wear and tear to users SD card/hard drive than the above mentioned pre-built solution. It also has a higher chance of failure if one of the dependencies of the container has changed or is no longer available. Use this option when you are playing with add-ons and seeing if someone is interested in your work. Once you're an established repository, please migrate to pushing builds to Docker Hub as it greatly improves the user experience. In the future we will mark locally built add-ons in the add-on store to warn users.