jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move redirect to standards

Browse Source
This commit is contained in:
Fabian Affolter 2017-10-16 10:24:13 +02:00
parent 0f3266b844
commit 1cc983eedd
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/developers/documentation/create_page.markdown
View File

@ -98,16 +98,6 @@ The direct usage of HTML is supported but not recommended. The note boxes are an
</p>
```
### {% linkable_title Redirects %}
If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.
```text
---
...
redirect_from: /getting-started/android/
---
```
### {% linkable_title Images, icons, and logos %}
The images which are displayed on the pages are stored in various directories according to their purpose. If you want to use a logo and placed `logo:` in the file header then this image should be stored in `source/images/supported_brands`. The background must be transparent.

12
source/developers/documentation/standards.markdown
View File

@ -55,3 +55,15 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
* `condition`
* `service`
## {% linkable_title Renaming Pages %}
It can happen that a component or platform is renamed, in this case the documentation needs to be updated as well. If you rename a page, add `redirect_from:` to the file header and let it point to the old location/name of the page. Please consider to add details, like release number or old component/platform name, to the page in a [note](/developers/documentation/create_page/#html).
```text
---
...
redirect_from: /getting-started/android/
---
```
Adding a redirect also applies if you move content around in the [documention](/docs/).