docs: GreptimeDB Dashboard (#796)

GreptimeTeam · Jan 24, 2024 · 552ba0b · 552ba0b
1 parent 906895c
commit 552ba0b
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 20 deletions.
diff --git a/docs/public/db-dashboard-scripts.png b/docs/public/db-dashboard-scripts.png
diff --git a/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md b/docs/v0.6/en/getting-started/installation/greptimedb-dashboard.md
@@ -0,0 +1,12 @@
+# GreptimeDB Dashboard
+
+Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard).
+
+The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports mutiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md).
+
+We offer various chart types to choose from based on different scenarios. The charts become more informative when you have sufficient data.
+
+![line](/dashboard-line.png)
+![scatter](/dashboard-scatter.png)
+
+We are committed to the ongoing development and iteration of this open-source project, and we plan to expand the application of time series data in monitoring, analysis, and other relevant fields in the future.
diff --git a/docs/v0.6/en/getting-started/quick-start/mysql.md b/docs/v0.6/en/getting-started/quick-start/mysql.md
@@ -161,9 +161,8 @@ curl -L https://raw.githubusercontent.com/GreptimeCloudStarters/quick-start-mysq
 
 ### GreptimeDB Dashboard
 
-Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard).
-
-The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After [starting GreptimeDB](#installation), the dashboard can be visited via HTTP endpoint `http://localhost:4000/dashboard`. The current version of the dashboard supports MySQL, Python and PromQL queries.
+GreptimeDB provides a user-friendly [dashboard](../installation/greptimedb-dashboard.md) to assist users in exploring data.
+Once GreptimeDB is started as mentioned in the Prerequisites section, you can access the dashboard through the HTTP endpoint `http://localhost:4000/dashboard`.
 
 Write SQL into the command text, then click `Run All`. We'll got all data in system_metrics table.
 
@@ -173,12 +172,6 @@ SELECT * FROM system_metrics;
 
 ![dashboard-select](/dashboard-select.png)
 
-We offer various chart types to choose from based on different scenarios. The content of the charts will be richer when you have enough data.
-
-![line](/dashboard-line.png)
-![scatter](/dashboard-scatter.png)
-
-We are committed to the ongoing development and iteration of this open source project, and we plan to expand the application of time series data in monitoring, analysis, and other relevant fields in the future.
 
 ### Grafana
 

diff --git a/docs/v0.6/en/summary.yml b/docs/v0.6/en/summary.yml
@@ -4,6 +4,7 @@
     - overview
     - greptimedb-standalone
     - greptimedb-cluster
+    - greptimedb-dashboard
   - Quick-Start:
     - overview
     - mysql

diff --git a/docs/v0.6/en/user-guide/python-scripts/define-function.md b/docs/v0.6/en/user-guide/python-scripts/define-function.md
@@ -255,3 +255,13 @@ curl -XPOST -G "http://localhost:4000/v1/run-script?db=default&name=square"
 `/run-script` runs the compiled script by `db` and `name`, then returns the output which is the same as the query result in `/sql` API.
 
 `/run-script` also receives other query parameters as the user params passed into the coprocessor, refer to [Input and Output](#input-of-the-coprocessor-function).
+
+## Edit scripts in GreptimeDB Dashboard
+
+[GreptimeDB Dashboard](/getting-started/installation/greptimedb-dashboard.md) provides a convenient editor for users to edit scripts.
+
+After starting GreptimeDB, you can access the dashboard at `http://localhost:4000/dashboard`.
+Click on `Scripts` in the left sidebar to navigate to the script page.
+From there, you can create a new script, edit an existing script, or run a script.
+
+![dashboard-scripts](/db-dashboard-scripts.png)
diff --git a/docs/v0.6/zh/getting-started/installation/greptimedb-dashboard.md b/docs/v0.6/zh/getting-started/installation/greptimedb-dashboard.md
@@ -0,0 +1,12 @@
+# GreptimeDB 控制台
+
+数据可视化在时间序列数据分析时发挥着关键作用。为了帮助用户充分利用 GreptimeDB 的各种功能，GreptimeDB 提供了一个简单的[控制台](https://github.com/GreptimeTeam/dashboard)。
+
+自 GreptimeDB v0.2.0 版本以来，控制台已经默认嵌入到 GreptimeDB 的 binary 文件中。在启动 [GreptimeDB 单机版](greptimedb-standalone.md)或[分布式集群](greptimedb-cluster.md)后，可以通过 URL `http://localhost:4000/dashboard` 访问控制台。控制台支持多种查询语言，包括 [SQL 查询](/user-guide/query-data/sql.md)、[Python 脚本](/user-guide/python-scripts/overview.md)和 [PromQL 查询](/user-guide/query-data/promql.md)。
+
+我们提供不同种类的图表，可以根据不同的场景进行选择。当用户有足够的数据时，图表的内容将更加丰富。
+
+![line](/dashboard-line.png)
+![scatter](/dashboard-scatter.png)
+
+我们将持续开发和迭代这个开源项目，并计划将时间序列数据应用于监测、分析和其他相关领域的扩展。
diff --git a/docs/v0.6/zh/getting-started/quick-start/mysql.md b/docs/v0.6/zh/getting-started/quick-start/mysql.md
@@ -160,25 +160,17 @@ curl -L https://raw.githubusercontent.com/GreptimeCloudStarters/quick-start-mysq
 
 ### GreptimeDB 控制台
 
-可视化在有效利用时间序列数据方面发挥着关键作用。为了帮助用户充分利用 GreptimeDB 的各种功能，GreptimeDB 提供了一个简单的 [dashboard](https://github.com/GreptimeTeam/dashboard)。
+GreptimeDB 提供了用户友好的[控制台](../installation/greptimedb-dashboard.md)帮助用户探索数据。
+当 GreptimeDB 按照上文的[准备环节](#准备)启动后，你可以通过 URL `http://localhost:4000/dashboard` 访问控制台。
 
-Dashboard 自 GreptimeDB v0.2.0 版本以来已经嵌入到 GreptimeDB 的 binary 文件中。在[启动 GreptimeDB](#安装)后，可以通过 HTTP 端点 `http://localhost:4000/dashboard` 访问 dashboard。当前版本的 dashboard 支持 MySQL、Python 查询和 PromQL 查询。
-
-将 SQL 写入命令文本，然后单击 `RUN ALL`，我们将获取 system_metrics 中的所有数据。
+将 SQL 写入命令文本，然后单击 `RUN ALL`，就能获取 system_metrics 中的所有数据。
 
 ```
 SELECT * FROM system_metrics;
 ```
 
 ![dashboard-select](/dashboard-select.png)
 
-我们提供不同种类的图表，可以根据不同的场景进行选择。当用户有足够的数据时，图表的内容将更加丰富。
-
-![line](/dashboard-line.png)
-![scatter](/dashboard-scatter.png)
-
-我们将持续开发和迭代这个开源项目，并计划将时间序列数据应用于监测、分析和其他相关领域的扩展。
-
 ### Grafana
 
 #### 添加数据源

diff --git a/docs/v0.6/zh/user-guide/python-scripts/define-function.md b/docs/v0.6/zh/user-guide/python-scripts/define-function.md
@@ -257,3 +257,14 @@ curl -XPOST -G "http://localhost:4000/v1/run-script?db=default&name=square"
 `/run-script` 通过 `db` 和 `name` 运行编译好的脚本，然后返回输出，这与 `/sql` API 中的查询结果相同。
 
 `/run-script` 也接收其他查询参数，作为传递到协处理器的用户参数，参考[输入和输出](#协处理器函数的输入)。
+
+
+## 在 GreptimeDB 控制台中编辑脚本
+
+[GreptimeDB 控制台](/getting-started/installation/greptimedb-dashboard.md) 提供了编辑器供用户方便地编辑脚本。
+
+在启动 GreptimeDB 后，你可以通过 URL `http://localhost:4000/dashboard` 访问控制台。
+点击左侧边栏的 `Scripts` 进入脚本列表页。
+你可以创建一个新的脚本，编辑一个已有的脚本，或者从控制台运行一个脚本。
+
+![dashboard-scripts](/db-dashboard-scripts.png)