paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

Redirect: Add documentation. Cleanup (#26041)

Browse Source 
* Add documentation. Cleanup. Add guardrail not to redirect to current url.
---------

Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
This commit is contained in:
Sydney Achinger
2024-08-15 14:34:15 -04:00
committed by GitHub
parent c47c82fd1b
commit 4490d733b5
8 changed files with 115 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/how-to-guides.md
+5
View File
@@ -841,3 +841,8 @@ metadata:
annotations:
backstage.io/techdocs-entity: system:default/example
```
## How to resolve broken links from moved or renamed pages in your documentation site
TechDocs supports using the [mkdocs-redirects](https://github.com/mkdocs/mkdocs-redirects/tree/master) plugin to create a redirect map for any TechDocs site. This allows broken links from renamed or moved pages in your site to be redirected to their specified replacement.
TechDocs will notify the user that the page they are trying to access is no longer maintained. Then, they will be redirected. External site redirects are not supported. If an external redirect is provided, the user will instead be redirected to the index page of the documentation site.