Skip to content

Fixed typos in some of the pages #1270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 20, 2016
4 changes: 2 additions & 2 deletions source/developers/architecture.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Before we dive into the Home Assistant architecture, let's get a clear overview
For more information about each part in this overview, <a href='/blog/2014/12/26/home-control-home-automation-and-the-smart-home/'>check out our blog</a>. Here's the tl;dr version of the blog:

* Home Control is responsible for collecting information and controlling devices.
* Home Automation triggers commands based on user configurations.
* Smart Home triggers commands based on previous behavior.
* Home Automation triggers command based on user configurations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should actually be commands

* Smart Home triggers commands based on previous behaviour.

<p class='img'>
<a href='{{site_root}}/images/architecture/home_automation_landscape.png' name='landscape'>
Expand Down
2 changes: 1 addition & 1 deletion source/developers/component_discovery.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Home Assistant has a discovery service running in the background to discover new

Device discovery for Home Assistant has been extracted into an external library called [NetDisco](https://github.com/home-assistant/netdisco). This library is integrated using [the `discovery` component](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/discovery.py) and scans the network in intervals for uPnP and zeroconf/mDNS services.

To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. [See the repository for examples of existing discoverables.](https://github.com/home-assistant/netdisco/tree/master/netdisco/discoverables)
To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. [See the repository for examples of existing discoverable.](https://github.com/home-assistant/netdisco/tree/master/netdisco/discoverables)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be discoverables since it's possible to find multiple.


### {% linkable_title Listening to `SERVICE_DISCOVERED` events %}

Expand Down
2 changes: 1 addition & 1 deletion source/developers/development_validation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ footer: true

The `configuration.yaml` file contains the configuration options for components and platforms. We use [voluptuous](https://pypi.python.org/pypi/voluptuous) to make sure that the configuration provided by the user is valid. Some entries are optional or could be required to set up a platform or a component. Others must be a defined type or from an already-defined list.

We test the configuration to ensure that users have a great experience and minimize notifications if something is wrong with a platform or component setup before Home Assistant runs.
We test the configuration to ensure that users have a great experience and minimise notifications if something is wrong with a platform or component setup before Home Assistant runs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling is with z not s.


Besides [voluptuous](https://pypi.python.org/pypi/voluptuous) default types, many custom types are available. For an overview, take a look at the [config_validation.py](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/helpers/config_validation.py) helper.

Expand Down
4 changes: 2 additions & 2 deletions source/developers/frontend.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
---

Home Assistant uses [Polymer](https://www.polymer-project.org/) for the UI and [NuclearJS](http://optimizely.github.io/nuclear-js/) for maintaing the app state.
Home Assistant uses [Polymer](https://www.polymer-project.org/) for the UI and [NuclearJS](http://optimizely.github.io/nuclear-js/) for maintaining the app state.

* Polymer allows building encapsulated custom HTML elements.
[Home-Assistant-Polymer source code on GitHub.](https://github.com/home-assistant/home-assistant-polymer)
Expand All @@ -29,7 +29,7 @@ http:
development: 1
```

As everything is compiled into the file `frontend.html` you do not want to work with the compiled version but with the seperate files during development.
As everything is compiled into the file `frontend.html` you do not want to work with the compiled version but with the separate files during development.

Next step is to get the frontend code. When you clone the Home Assistant repository, the frontend repository is not cloned by default. You can setup the frontend development environment by running:

Expand Down
2 changes: 1 addition & 1 deletion source/developers/maintenance.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ find homeassistant -name "*.py" -exec file {} \; | grep BOM
$ find homeassistant -name "*.py" -exec file {} \; | grep CRLF
```

To fix the line spearator, use `dos2unix` or `sed`.
To fix the line separator, use `dos2unix` or `sed`.

```bash
$ dos2unix homeassistant/components/notify/kodi.py
Expand Down
2 changes: 1 addition & 1 deletion source/developers/multiple_instances.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
---

Home Assistant supports running multiple synchronized instances using a master-slave model. Whenever `events.fire` or `states.set` is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.
Home Assistant supports running multiple synchronised instances using a master-slave model. Whenever `events.fire` or `states.set` is called on the slave it will forward it to the master. The master will replicate all events and changed states to its slaves.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Synchronized is correct.


<p class='img'>
<a href='/images/architecture/architecture-remote.png'>
Expand Down
10 changes: 5 additions & 5 deletions source/developers/python_api.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In the package [`homeassistant.remote`](https://github.com/home-assistant/home-a

This page is not a full documentation it's more a collection of some example. A simple way to get all current entities is to visit the "Set State" page in the "Developer Tools". For the examples below just choose one from the available entries. Here the sensor `sensor.office_temperature` and the switch `switch.livingroom_pin_2` are used.

First import the module and setup the basics.
First, import the module and setup the basics.

```python
import homeassistant.remote as remote
Expand All @@ -22,7 +22,7 @@ api = remote.API('127.0.0.1', 'password')
print(remote.validate_api(api))
```

This snippets shows how to use the `homeassistant.remote` package in another way.
This snippet shows how to use the `homeassistant.remote` package in another way.

```python
import homeassistant.remote as remote
Expand All @@ -35,7 +35,7 @@ living_room = hass.states.get('group.living_room')

### {% linkable_title Get configuration %}

Get the current configuration of a Home Asssitant instance.
Get the current configuration of a Home Assistant instance.

```python
import homeassistant.remote as remote
Expand Down Expand Up @@ -120,7 +120,7 @@ remote.set_state(api, 'switch.livingroom_pin_2', new_state=STATE_ON)

The state will be set to those value until the next update occurs.

### {% linkable_title Blinking all entites of a domain %}
### {% linkable_title Blinking all entities of a domain %}

If you want to turn on all entities of a domain, just use a service which was retrieved by `get_services`.

Expand All @@ -139,7 +139,7 @@ remote.call_service(api, domain, 'turn_off')

### {% linkable_title Control a single entity %}

To turn on or off a single switch. The ID of the entity is needed as attribute.
To turn on or off a single switch. The ID of the entity is needed as an attribute.

```python
import time
Expand Down
16 changes: 8 additions & 8 deletions source/developers/releasing.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Releasing"
description: "Steps involved to publish a new Home Assistant release."
description: "Steps involved publishing a new Home Assistant release."
date: 2016-07-13 17:00
sidebar: true
comments: false
Expand All @@ -13,20 +13,20 @@ This page describes the steps for publishing a new Home Assistant release.

### {% linkable_title GitHub %}

1. Create a pull request from `dev` to `master` with the upcoming release number as title.
2. Merge `master` into `dev` to make the PR mergable. PR message contains intro, highlighting major changes, and an overview of all changes tagging each author.
3. Update `homeassistant/const.py` with the correct version number (remove the the `dev` tag) and push that commit.
1. Create a pull request from `dev` to `master` with the upcoming release number as the title.
2. Merge `master` into `dev` to make the PR mergeable. PR message contains intro, highlighting major changes, and an overview of all changes tagging each author.
3. Update `homeassistant/const.py` with the correct version number (remove the `dev` tag) and push that commit.
4. Merge pull request (DO NOT SQUASH!).
5. Then, after merged, push another update to `dev` of `homeassistant/const.py` that includes the next version with the `dev` tag. Add a meaningful commit message like "Version bump to X". This commit acts as marker for the next release.
5. Then, after merged, push another update to `dev` of `homeassistant/const.py` that includes the next version with the `dev` tag. Add a meaningful commit message like "Version bump to X". This commit acts as a marker for the next release.
6. Go to [releases](https://github.com/home-assistant/home-assistant/releases) and tag a new release on the `master` branch. "Tag version" and "Release title" are the version number (`O.x` for major version, `0.x.y` for minor and bug fix releases). Release description is the text from PR. Press "Publish release" to finish the process.

### {% linkable_title Website %}

1. Create a blog post in `next` and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in message to documentation.
1. Create a blog post in `next` and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in a message to documentation.
2. Create missing documentation as stumbs in `next`.
3. Update the link on the frontpage (`source/index.html`) to link to the new release blog post and version number.
4. Create a pull request from `next` to `current` with the upcoming release number as title.
5. Merge `current` into `next` (`$ git checkout next && git merge current`) to make the PR mergable.
4. Create a pull request from `next` to `current` with the upcoming release number as the title.
5. Merge `current` into `next` (`$ git checkout next && git merge current`) to make the PR mergeable.
6. Merge pull request (blog post, updated frontpage, and all new documentation) to `current`.

### {% linkable_title Python Package Index %}
Expand Down
4 changes: 2 additions & 2 deletions source/developers/rest_api.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ Expects a JSON object that has at least a state attribute:
}
```

Return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the url of the new resource. The response body will contain a JSON encoded State object.
The return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the URL of the new resource. The response body will contain a JSON encoded State object.

```json
{
Expand Down Expand Up @@ -476,7 +476,7 @@ Requires a JSON object that represents the API to cancel forwarding to.
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some change in this page has broken the rending. Did you test this locally?


It will return a message if event forwarding was cancelled successful.
It will return a message if event forwarding was cancelled successfully.

```json
{
Expand Down
4 changes: 2 additions & 2 deletions source/developers/server_sent_events.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ The [home-assistant-sse](https://github.com/fabaff/home-assistant-sse) repositor

### {% linkable_title Python %}

If you want test the server-sent events without creating a website then the Python module [`sseclient` ](https://pypi.python.org/pypi/sseclient/) can help. Install it first:
If you want to test the server-sent events without creating a website then the Python module [`sseclient` ](https://pypi.python.org/pypi/sseclient/) can help. Install it first:

```bash
$ pip3 install sseclient
```

The simplest script to consume the SSE looks like the following snipplet.
The simplest script to consume the SSE looks like the following snippet.

```python
from sseclient import SSEClient
Expand Down
10 changes: 5 additions & 5 deletions source/developers/website.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Then you can work on the documentation:
- Fork home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.github.io).
- Create/edit/update a page in the directory `source/_components/` for your platform/component.
- Test your changes to home-assistant.io locally: run `rake preview` and navigate to [http://127.0.0.1:4000](http://127.0.0.1:4000)
- Create a Pull Request (PR) against the **next** branch of home-assistant.github.io if your documentation is for a new feature, platform, or component.
- Create a Pull Request (PR) against the **next** branch of home-assistant.github.io if your documentation is a new feature, platform, or component.
- Create a Pull Request (PR) against the **current** branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation.

<p class='note'>
Expand All @@ -39,7 +39,7 @@ It could be necessary that you run `rake generate` prior to `rake preview` for t

For a platform page, the fastest way is to make a copy of an existing page and edit it. The [Component overview](/components/) and the [Examples section](/cookbook/) are generated automatically, so there is no need to add a link to those pages.

If you start from scratch with a page, you need to add a header. Different sections of the doumentation may need different headers.
If you start from scratch with a page, you need to add a header. Different sections of the documentation may need different headers.

```text
---
Expand All @@ -59,11 +59,11 @@ Content...Written in markdown.
...
```

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.

### {% linkable_title Embedding Code %}

You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in \`. For multi line syntax wrap your code as shown below.
You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in \`. For multi-line, syntax wrap your code as shown below.

```text
{% raw %} ```yaml
Expand All @@ -72,7 +72,7 @@ You can use the default markdown syntax to generate syntax highlighted code. For
```{% endraw %}
```

If you are using templates then those parts needs to be [escaped](http://stackoverflow.com/a/24102537). Otherwise they will be rendered and appear blank on the website.
If you are using templates then those parts need to be [escaped](http://stackoverflow.com/a/24102537). Otherwise, they will be rendered and appear blank on the website.

Note that you can replace `yaml` next to \`\`\` with the language that is within the block.

Expand Down