From 0927f6b4bb32505b68a9ae39a405b0fe4fc6e141 Mon Sep 17 00:00:00 2001 From: Nicholas Griffin Date: Wed, 25 Oct 2017 07:50:22 +0100 Subject: [PATCH] Cleaning up some other things in glossary (#3768) * Fixing Typo that was mentioned in #3764 * Cleaning up some other things in glossary As I was making the other commit (#3766) I noticed some other things in the glossary that could be changed. One of the main things is that each example read differently so there was a lot of jumping between how examples were written, I've made them a bit more unified. I also added a bit more explanatory text and added some links as suggested in #3764. I made this a seperate pull because I figured it might be a bit more opinionated than the typo error. * Missed discovery. * Add quotes --- source/_data/glossary.yml | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index f1c27b24443..d9e75f950af 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -1,42 +1,43 @@ - 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. + description: "[Platforms](/docs/configuration/platform_options/) make the connection to a specific software or hardware platform. For example, the `pushbullet` platform works with the service pushbullet.com to send notifications." - topic: Component - description: "The components provide the core logic for the functionality in Home Assistant. Like `notify` provides sending notifications." + description: "[Components](/docs/configuration/platform_options/) 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: "An [event](/docs/configuration/events/) is when something happens." description: When something happens. - topic: Entity - description: An entity is the representation of a single device, unit or web service. + description: An [entity](/docs/configuration/platform_options/) 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." + description: "A device is usually a physical unit which can do or observe something." - topic: hass - description: "Often used abbreviation for Home Assistant." + description: "HASS or hass is often used as an abbreviation for Home Assistant." - topic: Discovery - description: The automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. + description: Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered. - topic: Groups description: "Groups are a way to organize your entities into a single unit." - topic: Automation - description: "Capability to call a service based on a simple or complex trigger. Automation allows a condition such as sunset to cause an event, such as a light turning on." + description: "[Automations](/docs/automation/) offer the capability to call a service based on a simple or complex trigger. Automation allows a condition such as sunset to cause an event, such as a light turning on." - topic: Trigger - description: "Values or conditions of a platform that are defined to cause an automation to run." + description: "A [trigger](/docs/automation/trigger/) is a set of values or conditions of a platform that are defined to cause an automation to run." - topic: Template - description: "An automation definition can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions." + description: "A [template](/docs/automation/templating/) is an automation definition that can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions." - topic: Script - description: "A component that allows users to specify a sequence of actions to be executed by Home Assistant when turned on" + description: "[Scripts](/docs/scripts/) are components that allow users to specify a sequence of actions to be executed by Home Assistant when turned on" - topic: Scene - description: "You can create scenes that capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." + description: "Scenes capture the states you want certain entities to be. For example a scene can specify that light A should be turned on and light B should be bright red." - topic: hassio - description: "An operating system to manage Home Assistant easily using various HASS.io add-ons" + description: see Hass.io - topic: HADashboard - description: "HADashboard is a modular, skinnable dashboard for Home Assistant that is intended to be wall mounted, and is optimized for distance viewing." + description: "[HADashboard](/docs/ecosystem/hadashboard/) is a modular, skinnable dashboard for Home Assistant that is intended to be wall mounted, and is optimized for distance viewing." - topic: Hass.io - description: "Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration and can easily be extended" + description: "Hass.io is an operating system that will take care of installing and updating Home Assistant, is managed from the Home Assistant UI, allows creating/restoring snapshots of your configuration, and can easily be extended" - topic: Cookbook - description: "Home Assistant configuration examples of the community" + description: "The [Cookbook](/cookbook/) contains a set of configuration examples of Home Assistant from the community" - topic: Packages - description: "Packages allow to bundle different component configuations together." + description: "Packages allow you to bundle different component configuations together." - topic: Customizing - description: "Customization allows overwriting default parameter of the devices in the configuration." + description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameter of your devices in the configuration." - topic: Zones - description: "Area used for presence detection." + description: "Zones are areas that can be used for presence detection."