You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2022/10/03 09:44:35 UTC

[skywalking] branch wu-sheng-patch-1 created (now 76019524d1)

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a change to branch wu-sheng-patch-1
in repository https://gitbox.apache.org/repos/asf/skywalking.git


      at 76019524d1 Polish UI setup doc

This branch includes the following new commits:

     new 76019524d1 Polish UI setup doc

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[skywalking] 01/01: Polish UI setup doc

Posted by wu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch wu-sheng-patch-1
in repository https://gitbox.apache.org/repos/asf/skywalking.git

commit 76019524d1a24e8bc62702e4349f1ec78064f49e
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Oct 3 17:44:22 2022 +0800

    Polish UI setup doc
---
 docs/en/ui/README.md | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/docs/en/ui/README.md b/docs/en/ui/README.md
index fb5d537b01..d8be87ff67 100644
--- a/docs/en/ui/README.md
+++ b/docs/en/ui/README.md
@@ -24,13 +24,20 @@ so).
 **Notice, dashboard editable is disabled on release; set system env(**SW_ENABLE_UPDATE_UI_TEMPLATE=true**) to activate
 them.** Before you save the edited dashboard, it is just stored in memory. Closing a tab would **LOSE** the change permanently.
 
-### Widget
+A new dashboard should be added through `New Dashboard` in the `Dashboards` menu. 
+Meanwhile, there are two ways to edit an existing dashboard.
+1. `Dashboard List` in the `Dashboard` menu provides edit/delete/set-as-root features to manage existing dashboards.
+2. In every dashboard page, click the right top `V` toggle, and turn to `E`(representing **Edit**) mode.
+
+## Widget
+
+A dashoard consists of various widget. In the `Edit` mode, widgets could be added/moved/removed/edit according to the Layer.(Every widget declares its suitable layer.)
 
 The widget provides the ability to visualize the metrics, generated through [OAL](../concepts-and-designs/mal.md), [MAL](../concepts-and-designs/mal.md), or [LAL](../concepts-and-designs/lal.md) scripts.
 
 <img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-configuration.png" />
 
-#### Metrics
+### Metrics
 
 To display one or more metrics in a graph, the following information is required:
 1. **Name**: The name of the metric.
@@ -39,7 +46,7 @@ To display one or more metrics in a graph, the following information is required
 4. **Unit**: The unit of the metrics data.
 5. **Calculation**: The calculation formula for the metric. The available formulas are [here](#calculations).
 
-##### Common Graphs
+#### Common Graphs
 
 |Metrics Data Type|Visualization|Demo|
 |----|-------------|----|
@@ -49,7 +56,7 @@ To display one or more metrics in a graph, the following information is required
 |read all values in the duration|Area|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-area.png" />|
 |read all values in the duration|Service/Instance/Endpoint List|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-entity-table.png" />|
 
-##### Calculations
+#### Calculations
 
 |Label|Calculation|
 |----|----|
@@ -67,11 +74,11 @@ To display one or more metrics in a graph, the following information is required
 |Milliseconds to seconds|Value / 1000|
 |Seconds to days|Value / 86400|
 
-#### Graph styles
+### Graph styles
 
 Graph advanced style options.
 
-#### Widget options
+### Widget options
 
 <img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-options.png" />
 
@@ -80,7 +87,7 @@ Define the following properties of the widget:
 2. **Title**: The title name of the widget. 
 3. **Tooltip Content**: Additional explanation of the widget. 
 
-#### Association Options
+### Association Options
 
 <img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-association.png" />