diff --git a/source/developers/documentation/create_page.markdown b/source/developers/documentation/create_page.markdown index 6f363393e3f..56860767516 100644 --- a/source/developers/documentation/create_page.markdown +++ b/source/developers/documentation/create_page.markdown @@ -98,16 +98,6 @@ The direct usage of HTML is supported but not recommended. The note boxes are an

``` -### {% 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. diff --git a/source/developers/documentation/standards.markdown b/source/developers/documentation/standards.markdown index 5445e7cd5ac..c859c4db6ab 100644 --- a/source/developers/documentation/standards.markdown +++ b/source/developers/documentation/standards.markdown @@ -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/).