Skip to content

Commit

Permalink
studio-docs: Update (#143)
Browse files Browse the repository at this point in the history
* updated studio user guide

* updated toc

* updated figure url
  • Loading branch information
oldLady344 committed Jan 4, 2021
1 parent 08b5261 commit 97f8e30
Show file tree
Hide file tree
Showing 21 changed files with 78 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/nebula-studio/about-studio/st-ug-check-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Studio 处于持续开发状态中。您可以通过 [Studio 的版本更新记

成功连接 Docker 版 Studio 后,您可以在页面右上角点击版本号,再点击 **新发布**,前往查看 Studio 的版本更新记录。

![在页面右上角点击版本号,并在弹出菜单里点击“新发布”](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-014.png "查看 Studio 版本更新记录")
![在页面右上角点击版本号,并在弹出菜单里点击“新发布”](../figs/st-ug-014.png "查看 Studio 版本更新记录")
9 changes: 9 additions & 0 deletions docs/nebula-studio/about-studio/st-ug-shortcuts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 快捷键

本文列出了 Studio 支持的快捷键。

| 要完成的任务 | 操作 |
| :-- | :--|
|**控制台** 页面运行 nGQL 语句 | 按 Shift + Enter 键 |
|**图探索** 页面选中多个点 | 按 Shift 键 + 鼠标单击 |
|**图探索** 页面对某个点快速拓展 | 鼠标双击。从 v1.2.4-beta 版本开始支持。 |
4 changes: 2 additions & 2 deletions docs/nebula-studio/deploy-connect/st-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@
- 如果已启用身份验证,但是未创建账号信息,您只能以 GOD 角色登录,必须填写 `root` 及对应的密码 `nebula`
- 如果已启用身份验证,同时又创建了不同的用户并分配了角色,不同角色的用户使用自己的账号和密码登录。

![Nebula Graph Studio 的登录页面](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-002.png "配置数据库")
![Nebula Graph Studio 的登录页面](../figs/st-ug-002.png "配置数据库")

2. 完成设置后,点击 **连接** 按钮。
如果您能看到如下图所示的界面,表示您已经成功连接到 Nebula Graph 数据库。

![Studio 进入控制台页面,表示成功连接到 Nebula Graph](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-003.png "Nebula Graph 连接成功")
![Studio 进入控制台页面,表示成功连接到 Nebula Graph](../figs/st-ug-003.png "Nebula Graph 连接成功")

一次连接会话持续 30 分钟。如果您超过 30 分钟没有操作,会话即断开,您需要重新登录数据库。

Expand Down
2 changes: 1 addition & 1 deletion docs/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
如果您在浏览器窗口中能看到以下登录界面,表示您已经成功部署并启动 Studio。

![Nebula Graph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-001.png "Nebula Graph Studio 登录界面")
![Nebula Graph Studio 登录界面](../figs/st-ug-001.png "Nebula Graph Studio 登录界面")

## 后续操作

Expand Down
Binary file added docs/nebula-studio/figs/st-ug-055.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nebula-studio/figs/st-ug-056.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/nebula-studio/figs/st-ug-057.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions docs/nebula-studio/manage-schema/st-ug-crud-edge-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

Expand All @@ -35,12 +35,12 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
b. (可选)如果边类型需要属性,在 **定义属性**面板的左上角,点击勾选框,并在展开的列表中,完成以下操作:
- 输入属性名称、数据类型和默认值。
- 如果一个边类型有多个属性,可以点击 **添加属性** 按钮,并定义属性。
- 如果要删除某个属性,在该属性所在行,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "删除") 图标。
- 如果要删除某个属性,在该属性所在行,点击 ![表示删除的图标](../figs/st-ug-020.png "删除") 图标。

c. (可选)边类型未设置索引时,您可以设置 TTL:在 **设置TTL**面板的左上角,点击勾选框,并在展开的列表中设置 `TTL_COL``TTL_DURATION` 参数信息。关于这两个参数的详细信息,参考 [TTL 配置](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL/ "点击前往 Nebula Graph 网站")

6. 完成设置后,在 **对应的nGQL语句** 面板上,您能看到与上述配置等价的 nGQL 语句。
![定义边类型 action 的属性](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-022.png "定义边类型")
![定义边类型 action 的属性](../figs/st-ug-022.png "定义边类型")

7. 确认无误后,点击 **+ 创建** 按钮。
如果边类型创建成功,**定义属性**面板会显示这个边类型的属性列表。
Expand All @@ -51,11 +51,11 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称完成图空间切换。

4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示修改的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-021.png "修改") 图标。
4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。

5.**编辑** 页面,您可以选择以下操作:
- 如果要修改属性:在 **定义属性** 面板上,找到需要修改的属性,在右侧点击 **编辑**,再修改属性的数据类型或者默认值。修改完成后,点击 **确认****取消**
Expand All @@ -73,11 +73,11 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。
4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。

## 后续操作

Expand Down
10 changes: 5 additions & 5 deletions docs/nebula-studio/manage-schema/st-ug-crud-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

Expand All @@ -40,7 +40,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
> **说明**:索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息,参考 [《nGQL 用户手册》](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/lookup-syntax/#faq "点击前往 Nebula Graph 网站")
6. 完成设置后,在 **对应的 nGQL**面板,您能看到与上述配置等价的 nGQL 语句。
![为边类型 action 创建索引](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-023.png "创建索引")
![为边类型 action 创建索引](../figs/st-ug-023.png "创建索引")

7. 确认无误后,点击 **+ 创建** 按钮。
如果索引创建成功,**定义属性**面板会显示这个索引的属性列表。
Expand All @@ -51,7 +51,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

Expand All @@ -65,8 +65,8 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **索引** 页签,找到需要修改的索引,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。
4. 点击 **索引** 页签,找到需要修改的索引,并在 **操作** 列中,点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。
6 changes: 3 additions & 3 deletions docs/nebula-studio/manage-schema/st-ug-crud-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
4. 配置确认无误后,点击 **创建** 按钮。
如果页面回到 **图空间列表**,而且列表中显示刚创建的图空间信息,表示图空间创建成功。

![带有示例配置信息的图空间创建页面](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-015.png "图空间创建页面")
![带有示例配置信息的图空间创建页面](../figs/st-ug-015.png "图空间创建页面")

## 删除图空间

按以下步骤使用 **Schema** 删除图空间:

1. 在工具栏里,点击 **Schema** 页签。

2. 在图空间列表里,找到需要删除的图空间,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。
2. 在图空间列表里,找到需要删除的图空间,并在 **操作** 列中,点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。

![在图空间列表中删除指定的图空间](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-016.png "删除图空间")
![在图空间列表中删除指定的图空间](../figs/st-ug-016.png "删除图空间")

3. 在弹出对话框中,确认信息,并点击 **确认** 按钮。
删除成功后,页面回到 **图空间列表**
Expand Down
12 changes: 6 additions & 6 deletions docs/nebula-studio/manage-schema/st-ug-crud-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

Expand All @@ -33,7 +33,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
b. (可选)如果标签需要属性,在 **定义属性** 模块左上角,点击勾选框,并在展开的列表中,完成以下操作:
- 输入属性名称、数据类型和默认值。
- 如果一个标签有多个属性,可以点击 **添加属性** 按钮,并定义属性。
- 如果要删除某个属性,在该属性所在行,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "删除") 图标。
- 如果要删除某个属性,在该属性所在行,点击 ![表示删除的图标](../figs/st-ug-020.png "删除") 图标。

c. (可选)标签未设置索引时,您可以设置 TTL:在 **设置TTL** 模块左上角,点击勾选框,并在展开的列表中设置 `TTL_COL``TTL_DURATION` 参数信息。关于这两个参数的详细信息,参考 [TTL 配置](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL/ "点击前往 Nebula Graph 网站")

Expand All @@ -48,11 +48,11 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **标签** 页签,找到需要修改的标签,并在 **操作** 列中,点击 ![表示修改的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-021.png "修改") 图标。
4. 点击 **标签** 页签,找到需要修改的标签,并在 **操作** 列中,点击 ![表示修改的图标](../figs/st-ug-021.png "修改") 图标。

5.**编辑** 页面,您可以选择以下操作:
- 如果要修改属性:在 **定义属性** 面板上,找到需要修改的属性,在右侧点击 **编辑**,再修改属性的数据类型和默认值。之后,点击 **确认** 或者 **取消** 完成修改。
Expand All @@ -70,11 +70,11 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](../figs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **标签** 页签,找到需要修改的标签,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。
4. 点击 **标签** 页签,找到需要修改的标签,并在 **操作** 列中,点击 ![表示删除的图标](../figs/st-ug-017.png "删除") 图标。

## 后续操作

Expand Down
4 changes: 2 additions & 2 deletions docs/nebula-studio/quick-start/st-ug-create-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@

2.**当前Space** 中选择一个图空间。在本示例中,选择 **mooc_actions**

![在 当前Space 中选择一个图空间](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-007.png "选择图空间")
![在 当前Space 中选择一个图空间](../figs/st-ug-007.png "选择图空间")

3. 在命令行中,依次输入以下语句,并点击 ![表示运行的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-008.png "Run 图标") 图标。
3. 在命令行中,依次输入以下语句,并点击 ![表示运行的图标](../figs/st-ug-008.png "Run 图标") 图标。

```nGQL
-- 创建标签 user,带有 1 个属性
Expand Down
4 changes: 2 additions & 2 deletions docs/nebula-studio/quick-start/st-ug-explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
以查询代表“History of Chinese Women Through Time”课程的点的属性为例:

***控制台** 页面:运行 `FETCH PROP ON * hash("History of Chinese Women Through Time");`,数据库会返回这个点所有属性信息。返回结果后,点击 **导入图探索** 按钮,将点数据查询结果导入 **图探索** 进行可视化显示。
![将控制台上查询得到的点数据信息导入到图探索进行可视化](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-012.png "将点数据查询结果导入图探索")
![将控制台上查询得到的点数据信息导入到图探索进行可视化](../figs/st-ug-012.png "将点数据查询结果导入图探索")

***图探索** 页面:点击 **开始探索** 按钮,在 **指定VID** 对话框中,输入 **"History of Chinese Women Through Time"**,在 **VID预处理** 选择 **Hash**,再点击 **添加** 按钮。**图探索** 画板里会显示这个点,将鼠标移到点上,您能看到这个点所有属性信息,如下图所示。
![可视化显示 History of Chinese Women Through Time 课程的信息](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-013.png "按 VID 查询得到点的信息")
![可视化显示 History of Chinese Women Through Time 课程的信息](../figs/st-ug-013.png "按 VID 查询得到点的信息")
Loading

0 comments on commit 97f8e30

Please sign in to comment.