add documentation for Radius Dashboard #1047
Conversation
Signed-off-by: Will Tsai <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
Co-authored-by: Will Smith <[email protected]> Signed-off-by: Will <[email protected]>
| <br /><br /> | ||
| <br> | ||
|
|
||
| Access your Radius Dashboard by opening [http://localhost:7007](http://localhost:7007) in a browser. In your browser, you should see the Radius Dashboard, which includes visualizations of the application graph, environments, and recipes: |
There was a problem hiding this comment.
For the getting started guide, the environment name and application name are well known. Can we deep-link directly into the application graph page to drop the user directly into the application graph, so that they instantly go from authoring their app to seeing their app without needing to pause and navigate the UI?
There was a problem hiding this comment.
great idea, i've modified the link here to be deep-linked
| tags: ["dashboard"] | ||
| --- | ||
|
|
||
| Radius Dashboard is the frontend experience for Radius and built on [Backstage](https://backstage.io/), an open-source platform for building developer portals that provides a rich set of components to accelerate UI development. The Radius Dashboard is a skinned deployment of Backstage that includes a set of plugins that provide the Radius experience. The components that make up the dashboard are built with extensibility in mind so that they can be used in other contexts beyond Backstage in the future. |
There was a problem hiding this comment.
Small nit: do we want to call this "Radius Dashboard", or "The Radius Dashboard"? The latter seems more natural to me, but overall I'm good with both
There was a problem hiding this comment.
This first paragraph goes straight into implementation details which end-users may not necessarily care about. Instead, maybe the first paragraph should focus on why the Dashboard is useful to users, and then we have a dedicated section on implementation?
There was a problem hiding this comment.
I like it, updated to reflect your suggestion.
| - _Application graph visualization_: A visualization of the [application graph]({{< ref "guides/author-apps/application/overview#query-and-understand-your-application-with-the-radius-application-graph" >}}) that shows how resources within an application are connected to each other and the underlying infrastructure. | ||
| - _Resource overview and details_: Detailed information about resources within Radius, including [applications]({{< ref "guides/author-apps/application/overview" >}}), [environments]({{< ref "guides/deploy-apps/environments/overview" >}}), and infrastructure. | ||
| - _Recipes directory_: A listing of all the Radius [Recipes]({{< ref "guides/recipes/overview" >}}) available to the user for a given environment. |
There was a problem hiding this comment.
Instead of italics for the main points, I think bold text would look better here.
There was a problem hiding this comment.
good suggestion, updated
| - _Recipes directory_: A listing of all the Radius [Recipes]({{< ref "guides/recipes/overview" >}}) available to the user for a given environment. | ||
|
|
||
| {{< alert title="Dashboard installation" color="warning" >}} | ||
| The Radius Dashboard is installed by default as a part of your Radius initialization and deployment. To opt-out of installing the dashboard, you can use the `--set dashboard.enabled=false` flag when running `rad install kubernetes`. See more instructions in the [CLI reference documentation]({{< ref "/reference/cli" >}}). |
There was a problem hiding this comment.
Do we want to point to the CLI reference here? Would the installation docs make more sense?
| The Radius Dashboard is installed by default as a part of your Radius initialization and deployment. To opt-out of installing the dashboard, you can use the `--set dashboard.enabled=false` flag when running `rad install kubernetes`. See more instructions in the [CLI reference documentation]({{< ref "/reference/cli" >}}). | ||
| {{< /alert >}} | ||
|
|
||
| When you run your application with the `rad run` command, Radius creates a port-forward from `localhost` to port `7007` inside the container that you may use to access your Radius Dashboard. |
There was a problem hiding this comment.
Can we add some headers to break up this page into sections? Looks like we have Overview, Key Features, Usage, and Reference documentation. Will help break up large chunks of text.
There was a problem hiding this comment.
good suggestion, updated
Signed-off-by: Will Tsai <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
Thank you for helping make the Radius documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Add documentation for new Radius Dashboard feature
Issue reference
Fixes: #1028