Skip to content

Commit 82dea44

Browse files
authored
Initial glossary (home-assistant#3568)
* Initial glossary * Allow markdown in the description
1 parent 53185d3 commit 82dea44

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

source/_data/glossary.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
- topic: Platform
2+
description: A platform makes the connection to a specific software or hardware platform. The `pushbullet` platform works with the service from pushbullet.com.
3+
- topic: Component
4+
description: "The components provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications."
5+
- topic: Service
6+
description: "[Services](/docs/scripts/service-calls/) are called to perform actions."
7+
- topic: Event
8+
description: When somethings happen.
9+
- topic: Entity
10+
description: An entity is the representation of a single device, unit or web service.
11+
- topic: Device
12+
description: "Usually this is a physical unit which can do or observe something."
13+
- topic: hass
14+
description: "Often used abbreviation for Home Assistant."
15+
- topic: Discovery
16+
description: The automatic setup of zeroconf/mDNS and uPnP devices after they are discovered.
17+

source/_docs/glossary.markdown

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: page
3+
title: "Glossary"
4+
description: "Home Assistant's Glossary."
5+
date: 2017-10-08 08:30
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
---
11+
12+
{% assign entries = site.data.glossary | sort: 'topic' %}
13+
14+
<ul>
15+
{% for entry in entries %}
16+
<li>
17+
<b>{{ entry.topic }}</b>: {{ entry.description | markdownify }}
18+
</li>
19+
{% endfor %}
20+
</ul>

source/_includes/asides/docs_navigation.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
<h1 class="title delta">Topics</h1>
44
<ul class='divided sidebar-menu'>
55
<li>
6-
<b>{% active_link /faq/ FAQ %}</b>
6+
<b>{% active_link /faq/ FAQ %}</b> |
7+
<b>{% active_link /docs/glossary/ Glossary %}</b>
78
</li>
89
<li>
910
<b>{% active_link /docs/installation/ Installation %}</b>

0 commit comments

Comments
 (0)