Skip to content

Commit 04400a3

Browse files
frenckfrenck
authored
📚 Adds Hass.io Addon Presentation section (#4509)
1 parent 42612c1 commit 04400a3

File tree

5 files changed

+65
-11
lines changed

5 files changed

+65
-11
lines changed

‎source/_includes/asides/developers_navigation.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ <h1 class="title delta">Development Guide</h1>
9595
<li>{% active_link /developers/hassio/addon_communication/ Communication %}</li>
9696
<li>{% active_link /developers/hassio/addon_testing/ Local Testing %}</li>
9797
<li>{% active_link /developers/hassio/addon_publishing/ Publishing %}</li>
98+
<li>{% active_link /developers/hassio/addon_presentation/ Presentation %}</li>
9899
<li>{% active_link /developers/hassio/addon_repository/ Repositories %}</li>
99100
</ul>
100101
</li>

‎source/developers/hassio/addon_config.markdown

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,15 @@ redirect_from: /hassio/addon_config/
1212

1313
Each add-on is stored in a folder. The file structure looks like this:
1414

15-
```
15+
```text
1616
addon_name/
17-
Dockerfile
17+
build.json
18+
CHANGELOG.md
1819
config.json
20+
Dockerfile
21+
icon.png
22+
logo.png
23+
README.md
1924
run.sh
2025
```
2126

‎source/developers/hassio/addon_development.markdown

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ Add-ons for Hass.io allow the user to extend the functionality around Home Assis
1414

1515
Under the hood, add-ons are Docker images published in [Docker Hub](https://hub.docker.com/). Developers can create [GitHub](https://github.com) repositories that contain multiple references to add-ons for easy sharing with the community.
1616

17-
<ol>
18-
<li><a href='/developers/hassio/addon_tutorial/'>Tutorial: Making your first add-on</a></li>
19-
<li><a href='/developers/hassio/addon_config/'>Configuration</a></li>
20-
<li><a href='/developers/hassio/addon_communication/'>Communication</a></li>
21-
<li><a href='/developers/hassio/addon_testing/'>Local Testing</a></li>
22-
<li><a href='/developers/hassio/addon_publishing/'>Publishing</a></li>
23-
<li><a href='/developers/hassio/addon_repository/'>Repositories</a></li>
24-
</ol>
17+
1. [Tutorial: Making your first add-on](/developers/hassio/addon_tutorial/)
18+
1. [Configuration](/developers/hassio/addon_config/)
19+
1. [Communication](/developers/hassio/addon_communication/)
20+
1. [Local Testing](/developers/hassio/addon_testing/)
21+
1. [Publishing](/developers/hassio/addon_publishing/)
22+
1. [Presentation](/developers/hassio/addon_presentation/)
23+
1. [Repositories](/developers/hassio/addon_repository/)

‎source/developers/hassio/addon_presentation.markdown

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: page
3+
title: "Presenting your add-on"
4+
description: "Details on how to present your Hass.io add-on."
5+
date: 2018-01-24 22:15
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
If you decide to share your add-on to the public, paying attention to details is recommended. Of course, your add-on should have a proper name and description, but Hass.io also gives you some other tools to present your add-on even nicer.
13+
14+
## {% linkable_title Adding documentation %}
15+
16+
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.
17+
18+
This file containing the documentation is usually referred to as the "README", which is generally published as the `README.md` file.
19+
20+
Take a look at other projects for inspiration. For example, see the `README.md` of the [Community Hass.io Add-ons: Homebridge](https://github.com/hassio-addons/addon-homebridge/blob/master/README.md) add-on.
21+
22+
In future versions of Hass.io, the `README.md` file will be displayed in the Home Assistant frontend.
23+
24+
## {% linkable_title Add-on icon & logo %}
25+
26+
A picture is worth a thousand words. Therefore, your add-on can be improved by adding a proper image icon and logo. Those images are used when showing your add-on in the Home Assistant Hass.io panel and which will significantly improve the visual representation of your add-on.
27+
28+
Requirements for the logo of your add-on:
29+
30+
- The logo must be in the Portable Network Graphics format (`.png`).
31+
- The filename must be `logo.png`.
32+
- It is recommended to keep the logo size around 250x100px. You may choose to use a different size or aspect ratio as you seem fit for your add-on.
33+
34+
Requirements for the icon of your add-on:
35+
36+
- The icon must be in the Portable Network Graphics format (`.png`).
37+
- The filename must be `icon.png`.
38+
- The aspect ratio of the icon must be 1x1 (square).
39+
- It is recommended to use an icon size of 128x128px.
40+
41+
## {% linkable_title Keeping a changelog %}
42+
43+
It is likely you are going to release newer versions of your add-on in the future. In case that happens, the users of your add-on would see an upgrade notice and probably want to know what changes were made in the latest version.
44+
45+
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of your add-on and is generally published as the `CHANGELOG.md` file.
46+
47+
If you are in need of a guide on keeping a changelog, we would recommend checking the [keep a changelog](http://keepachangelog.com) website. They have developed a standard that is used by many opensource projects around the world.
48+
49+
In future versions of Hass.io, the `CHANGELOG.md` file will be displayed in the Home Assistant frontend.

‎source/developers/hassio/addon_repository.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ footer: true
1010
redirect_from: /hassio/addon_repository/
1111
---
1212

13-
An Add-on repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. To be indentified as a repository, the repository must contain a configuration file.
13+
An add-on repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. To be indentified as a repository, the repository must contain a configuration file.
1414

1515
Check the [Example add-on repository](https://github.com/home-assistant/hassio-addons-example) for further details.
1616

0 commit comments

Comments
 (0)