jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 18:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add 'ha_qa_scale'

Browse Source
This commit is contained in:
Fabian Affolter 2018-09-28 00:07:37 +02:00
parent 7e3c5c355b
commit 5ba111f59a
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/documentation_create_page.md
View File

@ -20,6 +20,8 @@ sharing: true
footer: true footer: true
ha_release: "0.38" ha_release: "0.38"
ha_category: Sensor ha_category: Sensor
ha_iot_class: "Local Polling"
ha_qa_scale: silver
--- ---
Content...Written in markdown. Content...Written in markdown.
@ -28,13 +30,23 @@ Content...Written in markdown.
... ...
``` ```
Please keep in mind that if the `date:` entry is in the future then the page will not show up.
Additional keys for the file header:
- `logo`: Please check the separate section below.
- `ha_release`: The release when the intregration was included, e.g., "0.38". If the current release is 0.37, make `ha_release` 0.38. If it's 0.30 or 0.40 please quote it with `" "`.
- `ha_category`: This entry is used to group the integration on the [Components overview](https://www.home-assistant.io/components/).
- `ha_iot_class`: [IoT class(/blog/2016/02/12/classifying-the-internet-of-things) is the classifier for the device's behavior.
- `ha_qa_scale`: [Quality scale](https://www.home-assistant.io/docs/quality_scale/) is the representation of the integration's quality.
There are [pre-definied variables](https://jekyllrb.com/docs/variables/) available but usually, it's not necessary to use them when writing documentation. There are [pre-definied variables](https://jekyllrb.com/docs/variables/) available but usually, it's not necessary to use them when writing documentation.
A couple of points to remember: A couple of points to remember:
- Document the needed steps to retrieve API keys or access token for the third party service or device if needed. - Document the needed steps to retrieve API keys or access token for the third party service or device if needed.
- If you're adding a new component, for the `ha_release` part of the header, just increment of the current release. If the current release is 0.37, make `ha_release` 0.38. If it's 0.30 or 0.40 please quote it with `" "`. - Add screenshot to support the user where it make sense.
- `ha_category:` is needed to list the platform or component in the appropriate category on the website. - Add the type of the device(s) (incl. firmware) you have tested when you know that there are multiple out there.
### Configuration ### Configuration