From 82dea4410966f2c22c1a565d716feca50037e8e9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 9 Oct 2017 19:18:39 +0200 Subject: [PATCH] Initial glossary (#3568) * Initial glossary * Allow markdown in the description --- source/_data/glossary.yml | 17 +++++++++++++++++ source/_docs/glossary.markdown | 20 ++++++++++++++++++++ source/_includes/asides/docs_navigation.html | 3 ++- 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 source/_data/glossary.yml create mode 100644 source/_docs/glossary.markdown diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml new file mode 100644 index 00000000000..a0edf13014e --- /dev/null +++ b/source/_data/glossary.yml @@ -0,0 +1,17 @@ +- topic: Platform + description: A platform makes the connection to a specific software or hardware platform. The `pushbullet` platform works with the service from pushbullet.com. +- topic: Component + description: "The components provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications." +- topic: Service + description: "[Services](/docs/scripts/service-calls/) are called to perform actions." +- topic: Event + description: When somethings happen. +- topic: Entity + description: An entity is the representation of a single device, unit or web service. +- topic: Device + description: "Usually this is a physical unit which can do or observe something." +- topic: hass + description: "Often used abbreviation for Home Assistant." +- topic: Discovery + description: The automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. + diff --git a/source/_docs/glossary.markdown b/source/_docs/glossary.markdown new file mode 100644 index 00000000000..7f7437b49ed --- /dev/null +++ b/source/_docs/glossary.markdown @@ -0,0 +1,20 @@ +--- +layout: page +title: "Glossary" +description: "Home Assistant's Glossary." +date: 2017-10-08 08:30 +sidebar: true +comments: false +sharing: true +footer: true +--- + +{% assign entries = site.data.glossary | sort: 'topic' %} + + diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index c113f371a5a..cd1fb5c0601 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -3,7 +3,8 @@

Topics