This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new a39f0308b6 Sync ui and add a document for adding menus to booster UI
(#9653)
a39f0308b6 is described below
commit a39f0308b6e775b88e69ababf667a35e5be1edbf
Author: Fine0830 <[email protected]>
AuthorDate: Wed Sep 21 12:37:14 2022 +0800
Sync ui and add a document for adding menus to booster UI (#9653)
Co-authored-by: 吴晟 Wu Sheng <[email protected]>
---
docs/en/changes/changes.md | 3 +++
docs/en/guides/How-to-add-menu.md | 46 +++++++++++++++++++++++++++++++++++++++
docs/en/guides/README.md | 1 +
skywalking-ui | 2 +-
4 files changed, 51 insertions(+), 1 deletion(-)
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 6946ff8fd6..4c0b8632ca 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -36,9 +36,12 @@
* Update MySQL dashboard to visualize collected slow SQLs.
* Add virtual cache dashboard
* Remove `responseCode` fields of all OAL sources, as well as examples to
avoid user's confusion.
+* Remove All from the endpoints selector.
+* Enhance menu configurations to make it easier to change.
#### Documentation
* Add `metadata-uid` setup doc about Kubernetes coordinator in the cluster
management.
+* Add a doc for adding menus to booster UI.
All issues and pull requests are
[here](https://github.com/apache/skywalking/milestone/149?closed=1)
diff --git a/docs/en/guides/How-to-add-menu.md
b/docs/en/guides/How-to-add-menu.md
new file mode 100644
index 0000000000..574cfcee20
--- /dev/null
+++ b/docs/en/guides/How-to-add-menu.md
@@ -0,0 +1,46 @@
+# How to add a new root menu or sub-menu to booster UI
+
+If you would like to add a new root menu or sub-menu, you should add data to
`src/router/data/xx` and add translation contents for the title to
`src/locales/lang/xx` in [booster
UI](https://github.com/apache/skywalking-booster-ui).
+
+1. Create a new file called `xxx.ts` in `src/router/data`.
+2. Add configurations to the `xxx.ts`, configurations should be like this.
+```ts
+export default [
+ {
+ // Add `Infrastructure` menu
+ path: "",
+ name: "Infrastructure",
+ meta: {
+ title: "infrastructure",
+ icon: "scatter_plot",
+ hasGroup: true,
+ },
+ redirect: "/linux",
+ children: [
+ // Add a sub menu of the `Infrastructure`
+ {
+ path: "/linux",
+ name: "Linux",
+ meta: {
+ title: "linux",
+ layer: "OS_LINUX",
+ },
+ },
+ // If there are Tabs widgets in your dashboards, add following extra
configuration to provide static links to the specific tab.
+ {
+ path: "/linux/tab/:activeTabIndex",
+ name: "LinuxActiveTabIndex",
+ meta: {
+ title: "linux",
+ notShow: true,
+ layer: "OS_LINUX",
+ },
+ },
+ ],
+ },
+];
+```
+3. import configurations in `src/router/data/index.ts`.
+```ts
+import name from "./xxx";
+```
diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md
index 91fb38231c..b2e321bdc3 100755
--- a/docs/en/guides/README.md
+++ b/docs/en/guides/README.md
@@ -113,6 +113,7 @@ storage implementor in addition to the official one.
- [Source and scope extension for new metrics](source-extension.md). For
analysis of a new metric which SkyWalking
hasn't yet provided, add a new receiver.
You would most likely have to add a new source and scope. To learn how to do
this, read the document.
+- If you would like to add a new root menu or sub-menu to booster UI, read the
[UI menu control document](How-to-add-menu.md).
### OAP backend dependency management
> This section is only applicable to dependencies of the backend module.
diff --git a/skywalking-ui b/skywalking-ui
index 214b34ddfd..b235929c77 160000
--- a/skywalking-ui
+++ b/skywalking-ui
@@ -1 +1 @@
-Subproject commit 214b34ddfd259dffcd343a6775c7c05c62ae788b
+Subproject commit b235929c7755f4633e6fc97877666d3f0399d73b
