documentation update for the release of the new UI (#15359)
* initial commit to open draft PR * initial review of the docs for the new UI release * repositionining * missed one comment * reworded the callout based on suggestion * Update docs/category-overview-pages/accessing-netdata-dashboards.md Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> * edits after review comments * updates after some more review comments --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Hugo Valente committed
Jul 19, 2023 at 13:12 UTC
79600d73dd68aa8232848e593acd49f930e20f5e
2 files changed
+28
-1
docs/category-overview-pages/accessing-netdata-dashboards.md
+25
-1
@@ -1,3 +1,27 @@
1
# Accessing Netdata Dashboards
2
3
-This section contains documentation on how you can access the Netdata Agent's dashboards, and the Netdata Cloud's dashboards.
\ No newline at end of file
3
+This section contains documentation on how you can access the Netdata dashboard, which are the same both for the Agent and Cloud.
4
+
5
+A user accessing the Netdata dashboard **from the Cloud** will always be presented with the latest Netdata dashboard version.
6
+
7
+A user accessing the Netdata dashboard **from the Agent** will, by default, be presented with the latest Netdata dashboard version (the same as Netdata Cloud) except in the following scenarios:
8
+* Agent doesn't have Internet access, and is unable to get the latest Netdata dashboards, as a result it falls back to the Netdata dashboard version that
9
+was shipped with the agent.
10
+* Users have defined, e.g. through URL bookmark, that they wants to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).
11
+
12
+## Main sections
13
+
14
+The Netdata dashboard consists of the following main sections:
15
+* [Netdata charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
16
+* [Infrastructure Overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md)
17
+* [Nodes view](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
18
+* [Custom dashboards](https://learn.netdata.cloud/docs/visualizations/custom-dashboards)
19
+* [Alerts](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md)
20
+* [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md)
21
+* [Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md)
22
+* [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
23
+
24
+> ⚠️ Some sections of the dashboard, when accessed through the agent, may require the user to be signed-in to Netdata Cloud or having the Agent claimed to Netdata Cloud for their full functionality. Examples include saving visualization settings on charts or custom dashboards, claiming the node to Netdata Cloud, or executing functions on an Agent.
25
+
26
+
27
+Documentation for previous Agent dashboard can still be found [here](https://github.com/netdata/netdata/blob/master/web/gui/README.md).
\ No newline at end of file
web/gui/README.md
+3
@@ -9,6 +9,9 @@ learn_rel_path: "Operations"
9
10
# Local Agent dashboard
11
12
+> ⚠️ You're checking the documentation for the legacy Agent dashboard. For the current version please check [Accessing Netdata Dashboards](https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/accessing-netdata-dashboards.md).
13
+
14
+
15
The local Netdata Agent dashboard is the heart of Netdata's performance troubleshooting toolkit. You've probably seen it
16
before:
17