radius-project / radius

Radius is a cloud-native, portable application platform that makes app development easier for teams building cloud-native apps.
https://radapp.io
Apache License 2.0
1.48k stars 94 forks source link

Support deep linking to documentation from tools + RP #3026

Open rynowak opened 2 years ago

rynowak commented 2 years ago

It would be really helpful for us to have the capability to "deep link" from tools and error strings into the docs. Usually this is done with some kind of link shortener. We can't key this purely on our error codes because we're encouraged to reuse some "common" ones from ARM. eg: we can't guarantee that every error code maps to a single help topic.

As soon as we have this capability we can start using it, which will cause us to think very holistically about how we're explaining problems to users.

AB#6952

AaronCrawfis commented 2 years ago

We could use aliases to add easy to read words to specific pages. For example, we could add "environments" as an alias of https://edge.radapp.dev/operations/managing-envs/, and then https://radapp.dev/environments would link to that page