backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
83 stars 61 forks source link

feat(redirects): add support for redirects #100

Closed matchaxnb closed 10 months ago

matchaxnb commented 1 year ago

Updated text:

This adds the mkdocs-redirects plug-in to the TechDocs image so it may be leveraged by the TechDocsRedirect backstage add-on.

This also adds a few fixtures to test it. See https://github.com/backstage/backstage/pull/14730 for the backstage PR.

REVISED

original version This adds redirect stances to the techdocs_metadata.json file so they can be leveraged by Backstage at runtime to perform the redirections on the frontend.

This will be completed by an add-on contribution to backstage itself.

byan1197 commented 10 months ago

Closing due to the other PR no longer being considered. This redirection functionality has been scoped out as a future feature and is a part of our backlog.