From 13c980fbcce3d8524f2f13b968004c83f0a46a2d Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 11 Feb 2022 14:10:08 +0800 Subject: [PATCH 1/2] deploy&connect updates for dashboard community --- .../nebula-dashboard/2.deploy-dashboard.md | 12 ++-- .../nebula-dashboard/3.connect-dashboard.md | 6 +- docs-2.0/nebula-dashboard/4.use-dashboard.md | 4 +- mkdocs.yml | 66 +++++++++---------- 4 files changed, 46 insertions(+), 42 deletions(-) diff --git a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md index a388e79968a..5f9c680afe0 100644 --- a/docs-2.0/nebula-dashboard/2.deploy-dashboard.md +++ b/docs-2.0/nebula-dashboard/2.deploy-dashboard.md @@ -28,11 +28,11 @@ | Dashboard 安装包 | Nebula Graph 版本 | | :----- | :----- | -| [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.1~3.0.0 | +| [nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-dashboard/{{ dashboard.release }}/nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz) | 2.5.1~3.0.0 | ## 目录结构说明 -执行命令`tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz`解压缩，目录`nebula-dashboard/vendors`内一共有 5 个子目录，说明如下。 +执行命令`tar -xvf nebula-dashboard-{{ dashboard.release }}.x86_64.tar.gz`解压缩，目录`nebula-dashboard/vendors`内一共有 4 个子目录，说明如下。 |目录名称|说明|端口号| |:---|:---|:---| @@ -177,12 +177,12 @@ $ nohup ./nebula-httpd & port: 7003 proxy: gateway: - target: "127.0.0.1:8080" // change gateway service proxy + target: "127.0.0.1:8090" // nebula-http-gateway 服务的 IP 和端口号。 prometheus: - target: "127.0.0.1:9090" // change prometheus service proxy + target: "127.0.0.1:9090" // Prometheus 服务的 IP 和端口号。 nebulaServer: - ip: "192.168.8.143" // change to nebula graph service ip - port: 9669 // change to nebula graph service port + ip: "192.168.8.143" // 部署 Graph 服务的机器 IP。 + port: 9669 // Graph 服务的端口号。 ... ``` diff --git a/docs-2.0/nebula-dashboard/3.connect-dashboard.md b/docs-2.0/nebula-dashboard/3.connect-dashboard.md index ca20f94d0ea..16d87cd1318 100644 --- a/docs-2.0/nebula-dashboard/3.connect-dashboard.md +++ b/docs-2.0/nebula-dashboard/3.connect-dashboard.md @@ -10,10 +10,14 @@ Dashboard 部署完成后，可以通过浏览器登录使用 Dashboard。 ## 操作步骤 -1. 确认`nebula-graph-dashboard`服务所在机器的 IP 地址，在浏览器中输入`:7003`打开登录页面。 +1. 确认`nebula-dashboard`服务所在机器的 IP 地址，在浏览器中输入`:7003`打开登录页面。 2. 输入 Nebula Graph 数据库的账号和密码，单击登录。 + !!! note + + 输入 Nebula Graph 数据库的账号和密码前，确保在`config.json`文件中配置了部署 Graph 服务的机器 IP。更多信息，参见[部署 Dashboard](2.deploy-dashboard.md)。 + - 如果 Nebula Graph 已经启用身份验证，用户可以使用已创建的账号连接 Dashboard。 - 如果 Nebula Graph 未启用身份验证，用户只能使用默认用户`root`和任意密码连接 Dashboard。 diff --git a/docs-2.0/nebula-dashboard/4.use-dashboard.md b/docs-2.0/nebula-dashboard/4.use-dashboard.md index 93e514621c4..0355bbfe7bc 100644 --- a/docs-2.0/nebula-dashboard/4.use-dashboard.md +++ b/docs-2.0/nebula-dashboard/4.use-dashboard.md @@ -14,7 +14,7 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 可以查看最近一天的 CPU、内存、负载、磁盘和上下行流量变化情况。 - 如果需要查看某一项更详细的监控指标，可以单击模块右上角的！[眼睛](eye.png) 按钮，或者在左侧单击监控项。 + 如果需要查看某一项更详细的监控指标，可以单击模块右上角的![眼睛](eye.png) 按钮，或者在左侧单击监控项。 - CPU、内存、负载、磁盘、流量 @@ -36,7 +36,7 @@ Dashboard 页面主要分为机器、服务、管理三个部分，本文将详 可以查看最近一天各种服务的监控指标变化情况，右上角还可以切换到**版本**页面查看所有服务的 IP 地址和版本。 - 如果需要查看某一种服务更详细的监控指标，可以单击模块右上角的 ![眼睛](eye.png) 按钮，或者在左侧单击具体服务。 + 如果需要查看某一种服务更详细的监控指标，可以单击模块右上角的![眼睛](eye.png)按钮，或者在左侧单击具体服务。 !!! note diff --git a/mkdocs.yml b/mkdocs.yml index b2ea36f5b23..4c657b7a305 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -533,39 +533,39 @@ markdown_extensions: - pymdownx.arithmatex: generic: true -# Plugins -plugins: - - search - - macros: - include_dir: docs-2.0/reuse/ - - git-revision-date-localized - - - exclude: -# Exclude files with unix-style wildcards (globs) - glob: -# Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. - - 7.data-security/2.backup-restore/* - - nebula-flink/* - - CHANGELOG.md - - spark-connector/* - - nebula-operator/* - - 4.deployment-and-installation/5.zone.md - - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - - nebula-cloud/* -# Exclude the file with the following file name. -# - abc.md -# Exclude files with regular expressions (regexes) -# regex: -# - '.*\.(tmp|bin|tar)$' - - - with-pdf: - copyright: 2022 vesoft Inc. - cover_subtitle: v3.0.0 - author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 - cover: true - back_cover: true - cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' - output_path: pdf/NebulaGraph-CN.pdf +# # Plugins +# plugins: +# - search +# - macros: +# include_dir: docs-2.0/reuse/ +# - git-revision-date-localized + +# - exclude: +# # Exclude files with unix-style wildcards (globs) +# glob: +# # Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. +# - 7.data-security/2.backup-restore/* +# - nebula-flink/* +# - CHANGELOG.md +# - spark-connector/* +# - nebula-operator/* +# - 4.deployment-and-installation/5.zone.md +# - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md +# - nebula-cloud/* +# # Exclude the file with the following file name. +# # - abc.md +# # Exclude files with regular expressions (regexes) +# # regex: +# # - '.*\.(tmp|bin|tar)$' + +# - with-pdf: +# copyright: 2022 vesoft Inc. +# cover_subtitle: v3.0.0 +# author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 +# cover: true +# back_cover: true +# cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' +# output_path: pdf/NebulaGraph-CN.pdf extra_javascript: - js/version-select.js From 1f88163a9d965511daea9e4e3203104adae7e547 Mon Sep 17 00:00:00 2001 From: Abby <78209557+abby-cyber@users.noreply.github.com> Date: Fri, 11 Feb 2022 14:10:57 +0800 Subject: [PATCH 2/2] Update mkdocs.yml --- mkdocs.yml | 66 +++++++++++++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4c657b7a305..b2ea36f5b23 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -533,39 +533,39 @@ markdown_extensions: - pymdownx.arithmatex: generic: true -# # Plugins -# plugins: -# - search -# - macros: -# include_dir: docs-2.0/reuse/ -# - git-revision-date-localized - -# - exclude: -# # Exclude files with unix-style wildcards (globs) -# glob: -# # Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. -# - 7.data-security/2.backup-restore/* -# - nebula-flink/* -# - CHANGELOG.md -# - spark-connector/* -# - nebula-operator/* -# - 4.deployment-and-installation/5.zone.md -# - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md -# - nebula-cloud/* -# # Exclude the file with the following file name. -# # - abc.md -# # Exclude files with regular expressions (regexes) -# # regex: -# # - '.*\.(tmp|bin|tar)$' - -# - with-pdf: -# copyright: 2022 vesoft Inc. -# cover_subtitle: v3.0.0 -# author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 -# cover: true -# back_cover: true -# cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' -# output_path: pdf/NebulaGraph-CN.pdf +# Plugins +plugins: + - search + - macros: + include_dir: docs-2.0/reuse/ + - git-revision-date-localized + + - exclude: +# Exclude files with unix-style wildcards (globs) + glob: +# Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. + - 7.data-security/2.backup-restore/* + - nebula-flink/* + - CHANGELOG.md + - spark-connector/* + - nebula-operator/* + - 4.deployment-and-installation/5.zone.md + - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md + - nebula-cloud/* +# Exclude the file with the following file name. +# - abc.md +# Exclude files with regular expressions (regexes) +# regex: +# - '.*\.(tmp|bin|tar)$' + + - with-pdf: + copyright: 2022 vesoft Inc. + cover_subtitle: v3.0.0 + author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙 + cover: true + back_cover: true + cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png' + output_path: pdf/NebulaGraph-CN.pdf extra_javascript: - js/version-select.js