Move, rename, or remove a page
Pages get linked from everywhere. Here is how to change them without breaking those links.
Documentation pages are linked from forum posts, blog posts, other websites, and Home Assistant itself. When a URL changes, those links should keep working.
Add a redirect from the old URL to the new one in source/_redirects:
/integrations/old_name /integrations/new_name 301The same applies when you move a section to another page: send the old address to where the content lives now.
When an integration is removed from Home Assistant, or the whole integration is deprecated, its documentation goes too:
-
Delete the page from
source/_integrations, together with its triggers, conditions, and actions insource/_triggers,source/_conditions, andsource/_actions, if it has any. -
Remove its icon and logo from the brands repository.
-
Remove its entry from the
CODEOWNERSfile. -
Add a redirect in
source/_redirects, in the section for removed integrations. Removed integrations all point to the same page, which explains to visitors what happened:/integrations/old_name /more-info/removed-integration 301
Do not wait until a feature is removed. The rule in the documentation repository is: "When a feature is deprecated or an integration is removed from Home Assistant, remove its documentation."
- If a feature is deprecated, remove its section from the integration page.
- Do not add a deprecation notice to the documentation.
- If an entire integration is deprecated, remove its page as described in Remove an integration page.