Move studio docs (en) (#203)

* Initial commit

* Merge request for docker (#1)

* feat: first version init

* mod: docs

* fix: docs (#3)

* feat: update docs && web image (#4)

* nebula graph studio user guide (#5)

* user-guide

* details about host ip

* feat: add nginx import file download (#6)

* docs: update (#7)

* feat: release web image to 0.0.7 (#8)

* mod: change relative image always use latest (#9)

* docs: update (#10)

* docs: fix (#11)

* Update README.md (#12)

* mod: changelog (#13)

* en version and cn minor updates (#15)

* Update README.md (#14)

* [doc] links updated (#16)

* en version and cn minor updates

* links updated

* minor update

* [doc]add readme (#17)

* add readme

* address comments

* address comments

* fix typo (#18)

* fix changelog links (#20)

* [doc] minor updates (#19)

* minor updates

* notes added

* minor updates

* [doc] figures added  (#24)

* figures added

* minor updates

* updated

* nGQL

* docs: update changelog (#31)

* docs: update changelog (#34)

* mod: upload to server (#42)

* mod: upload to server

* mod: http client max size

* fix: file download

* docs: fix

* mod: docker image name

Co-authored-by: NicolaCage <37568394+NicolaCage@users.noreply.github.com>

* mod: CHANGELOG (#64)

* docs: update changelog (#66)

* docs: release 1.0.4-beta (#68)

* update-doc (#96)

* update-changelog (#97)

* update-changelog

* update

* docs: add 1.0.5-beta changelog (#98)

* docs: add 1.0.5-beta changelog

* docs: fix typo

* docs: fix typo (#99)

* Release V1.0.6-beta (#102)

* docs: add 1.0.5-beta changelog

* docs: fix typo

* docs: release v1.0.6-beta

* update-doc (#105)

* add-example (#106)

* add-video-link (#110)

* docs: update release (#111)

* chore: release 1.0.8-beta (#116)

* show-edge-doc (#119)

* chore: release 1.0.9-beta (#132)

* update USE (#136)

* docs: release 1.0.10-beta (#142)

* docs: release 1.0.10-beta

* mod: doc review

* docs: release 1.1.0-beta (#143)

* docs: release 1.1.0-beta

* docs: update

* docs: changelog update (#144)

* docs: changelog update

* docs: update

* New user guide (#148)

* added new files for user guide

* deleted doc

* updated on whitewum's comments

* corrected links

* updated what-is-studio

* updated docs

* updated

* corrected links

* updated plan-schema

* updated

* removed uuid

* fixed links and corrected description (#150)

* fixed image links (#151)

* fixed image links

* fixed format

* added schema management (#152)

* fix conflict

* modified st-ug-crud-index.md

* updated

* fixed

* updated toc.md

* fixed format errors

* fixed punctuation errors

* docs: changelog update (#155)

* fixed typo (#154)

* Update readme (#157)

* updated readme.md and re-organized folder

* updated

* added schema management (english) (#159)

* added manage schema (english)

* updated toc.md

* removed company name from docs (#160)

* Update limitations (#161)

* updated limitations

* updated limitations

* updated limitations

* added a link to studio video (#162)

* added a link to studio video

* updated

* added video link for the English README.md

* docs: update  version (#163)

* docs: update  version

* mod: changelog update

* mod: code review

* mod: max size of upload files update (#164)

* added open-in-explorer & updated toc (#165)

* added open-in-explorer & updated toc

* updated

* updated

* Add version info && update limitations (#166)

* added version info into operation docs and fixed errors

* updated

* added version info into operation docs and fixed errors

* updated

* updated

* added view subgraph (#169)

* add English quick start && polish some docs of chinese version (#167)

* added manage schema (english)

* added english quick start && polished the chinese version

* updated toc

* updated

* fixed comments

* Add version info && update limitations (#166)

* added version info into operation docs and fixed errors

* updated

* added version info into operation docs and fixed errors

* updated

* updated

* fixed comments

* added view subgraph (#169)

* added manage schema (english)

* added english quick start && polished the chinese version

* updated toc

* updated

* fixed comments

* fixed comments

* open in explore (english) (#168)

* added Open-in-Explore (en)

* updated

* rename

* added Open-in-Explore (en)

* updated

* rename

* edited toc

* updated version

* fixed typo

* fixed comments

* updated UI description

* fixed comments

Co-authored-by: dutor <440396+dutor@users.noreply.github.com>
Co-authored-by: Jerry <8124783+nianiaJR@users.noreply.github.com>
Co-authored-by: wilsonyou <40747875+wilsonyou@users.noreply.github.com>
Co-authored-by: min.wu <50101159+whitewum@users.noreply.github.com>
Co-authored-by: Amber Zhang <42762957+Amber1990Zhang@users.noreply.github.com>
Co-authored-by: NicolaCage <37568394+NicolaCage@users.noreply.github.com>
Co-authored-by: hetao <hetao.daily@gmail.com>
Co-authored-by: He Nut <18328704+hetao92@users.noreply.github.com>

nebula-studio/manage-schema/st-ug-crud-edge-type.md

@@ -0,0 +1,98 @@
+# Operate edge types
+
+After a graph space is created in Nebula Graph, you can create edge types. With Studio, you can choose to use the **Console** tab page or the **Schema** tab page to create, retrieve, update, or delete edge types. This article only introduces how to use the **Schema** tab page to operate edge types in a graph space.
+
+## Studio version
+
+Studio of v1.2.0-beta or later versions supports this function. To update the version, run this command.
+
+```bash
+docker-compose pull && docker-compose up
+```
+
+## Prerequisites
+
+To operate an edge type on Studio, you must do a check of these:
+
+- The version of Studio is v1.2.0-beta or later.
+- Studio is connected to Nebula Graph.
+- A graph space is created.
+- Your account has the authority of GOD, ADMIN, or DBA.
+
+## Create an edge type
+
+To create an edge type on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In the **Graph Space List** page, find a graph space and then click its name or click the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Edge Type** tab and click the **+ Create** button.
+
+5. On the **Create** page, do these settings:
+
+   a. **Name**: Specify an appropriate name for the edge type. In this example, `action` is used.
+
+   b. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:
+
+   - To define a property: Enter a property name, a data type, and a default value.
+
+   - To add multiple properties: Click the **Add Property** button and define more properties.
+
+   - To cancel a defined property: Besides the **Defaults** column, click the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel") icon.
+
+   c. (Optional) If no index is set for the edge type, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel, and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL/> "Click to go to Nebula Graph website").
+
+6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings.
+
+   ![Define properties of the `action` edge type](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-027.png "Define an edge type")
+
+7. Confirm the settings and then click the **+ Create** button.
+
+When the edge type is created successfully, the **Define Properties** panel shows all its properties on the list.
+
+## Edit an edge type
+
+To edit an edge type on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In the **Graph Space List** page, find a graph space and then click its name or click the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Edge Type** tab, find an edge type and then click the ![Icon of edit](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-021.png "Edit") icon in the **Operations** column.
+
+5. On the **Edit** page, do these operations:
+
+   - To edit a property: On the **Define Properties** panel, find a property, click **Edit**, and then change the data type or the default value.
+
+   - To delete a property: On the **Define Properties** panel, find a property, click **Delete**.
+
+   - To add more properties: On the **Define Properties** panel, click the **Add Property** button to add a new property.
+
+   - To set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box and then set TTL.
+
+   - To edit the TTL configuration: On the **Set TTL** panel, click **Edit** and then change the configuration of `TTL_COL` and `TTL_DURATION`.
+
+   - To delete the TTL configuration: When the **Set TTL** panel is expanded, in the upper left corner of the panel, click the check box to delete the configuration.
+
+6. When the configuration is done, in the **Equivalent to the following nGQL statement** panel, you can see the equivalent `ALTER EDGE` statement.
+
+## Delete an edge type
+
+To delete an edge type on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In **Graph Space List**, find a graph space and then click its name or click the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Edge Type** tab, find an edge type and then click the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "Delete") icon in the **Operations** column.
+
+## Next to do
+
+After the edge type is created, you can use the **Console** tab page to insert edge data one by one manually or use the **Import** tab page to bulk import edge data.

nebula-studio/manage-schema/st-ug-crud-index.md

@@ -0,0 +1,66 @@
+# Operate Indexes
+
+You can create an index for a tag and/or an edge type. An index lets traversal start from vertices or edges with the same property and it can make a query more efficient. You can create two index types: Tag Index and Edge Type Index. With Studio, you can use the **Console** tab page or the **Schema** tab page to create, retrieve, and delete indexes. This article only introduces how to use the **Schema** tab page to operate an index.
+
+> **NOTE**: You can create an index when a tag or an edge type is created. But an index can decrease the write speed during data import. We recommend that you import data firstly and then create and rebuild an index. For more information, see [nGQL Manual](https://docs.nebula-graph.io/manual-EN/2.query-language/4.statement-syntax/1.data-definition-statements/ "Click to go to the Nebula Graph website").
+
+## Studio version
+
+Studio of v1.2.0-beta or later versions supports this function. To update the version, run this command.
+
+```bash
+docker-compose pull && docker-compose up
+```
+
+## Prerequisites
+
+To operate an index on Studio, you must do a check of these:
+
+- The version of Studio is v1.2.0-beta or later.
+- Studio is connected to Nebula Graph.
+- A graph space, tags, and edge types are created.
+- Your account has the authority of GOD, ADMIN, or DBA.
+
+## Create an index
+
+To create an index on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+2. On the **Graph Space List** page, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+4. Click the **Index** tab and then click the **+ Create** button.
+5. On the **Create** page, do these settings:
+
+   a. **Index Type**: Choose to create an index for a tag or for an edge type. In this example, **Edge Type** is chosen.
+
+   b. **Name**: Choose a tag name or an edge type name. In this example, **action** is chosen.
+
+   c. **Index Name**: Specify a name for the new index. In this example, **action_index** is used.
+
+   d. **Indexed Properties**: Click **Add**, and then, in the dialog box, choose a property. If necessary, repeat this step to choose more properties. You can drag the properties to sort them. In this example, `actionId` and `label` are chosen.
+   > **NOTE**: The order of the indexed properties has an effect on the result of the `LOOKUP` statement. For more information, see [nGQL Manual](https://docs.nebula-graph.io/manual-EN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/lookup-syntax/#error_code_411 "Click to go to the Nebula Graph website").
+
+   When the settings are done, the **Equivalent to the following nGQL statement** panel shows the statement equivalent to the settings.  
+![A page for index creation](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-030.png "Create an index")
+
+6. Confirm the settings and then click the **+ Create** button.  
+   When an index is created, the index list shows the new index.
+
+## View indexes
+
+To view indexes on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+2. In the graph space list, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+4. Click the **Index** tab, in the upper left corner, choose an index type, **Tag** or **Edge Type**.
+5. In the list, find an index and click its row. All its details are shown in the expanded row.
+
+## Delete an index
+
+To delete an index on **Schema**, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+2. In the graph space list, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+4. Click the **Index** tab, find an index and then the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "Delete") icon in the **Operations** column.

nebula-studio/manage-schema/st-ug-crud-space.md

@@ -0,0 +1,58 @@
+# Operate graph spaces
+
+When Studio is connected to Nebula Graph, you can create or delete a graph space. You can use the **Console** tab page or the **Schema** tab page to do these operations. This article only introduces how to use the **Schema** tab page to operate graph spaces in Nebula Graph.
+
+## Studio version
+
+Studio of v1.2.0-beta or later versions supports this function. To update the version, run this command.
+
+```bash
+docker-compose pull && docker-compose up
+```
+
+## Prerequisites
+
+To operate a graph space on Studio, you must do a check of these:
+
+- The version of Studio is v1.2.0-beta or later.
+- Studio is connected to Nebula Graph.
+- Your account has the authority of GOD. It means that:
+  - If the authentication is enabled in Nebula Graph, you can use `user` and `password` to sign in to Studio.
+  - If the authentication is disabled in Nebula Graph, you must use `root` and its password to sign in to Studio.
+
+## Create a graph space
+
+To create a graph space on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+2. On the **Graph Space List** page, click the **+ Create** button.
+3. On the **Create** page, do these settings:
+
+   a. **Name**: Specify a name to the new graph space. In this example, `mooc_actions` is used. The name must be distinct in the database.
+
+   b. **Optional Parameters**: Set `partition_num`, `replica_factor`, `charset`, or `collate`. In this example, these parameters are set to `10`, `1`, `utf8`, and `utf8_bin` separately. For more information, see [`CREATE SPACE` syntax](https://docs.nebula-graph.io/manual-EN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax/ "Click to go to the Nebula Graph website").
+
+   In the **Equivalent to the following nGQL statement** panel, you can see the statement equivalent to the preceding settings.
+
+4. Confirm the settings and then click the **+ Create** button. If the graph space is created successfully, you can see it on the graph space list.
+
+![The Create page with settings for a graph space](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-026.png "Create a graph space")
+
+## Delete a graph space
+
+To delete a graph space on the **Schema** page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+2. In the graph space list, find a graph space and then the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "Delete") icon in the **Operations** column.
+
+   ![Graph space list with the graph space to be deleted](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-029.png "Delete a graph space")
+3. On the dialog box, confirm the information and then click the **OK** button.  
+   When the graph space is deleted successfully, it is removed from the graph space list.
+
+## Next to do
+
+After a graph space is created, you can create or edit a schema, including:
+
+- [Operate tags](st-ug-crud-tag.md)
+- [Operate edge types](st-ug-crud-edge-type.md)
+- [Operate indexes](st-ug-crud-index.md)

nebula-studio/manage-schema/st-ug-crud-tag.md

@@ -0,0 +1,98 @@
+# Operate tags
+
+After a graph space is created in Nebula Graph, you can create tags. With Studio, you can use the **Console** tab page or the **Schema** tab page to create, retrieve, update, or delete tags. This article only introduces how to use the **Schema** tab page to operate tags in a graph space.
+
+## Studio version
+
+Studio of v1.2.0-beta or later versions supports this function. To update the version, run this command.
+
+```bash
+docker-compose pull && docker-compose up
+```
+
+## Prerequisites
+
+To operate a tag on Studio, you must do a check of these:
+
+- The version of Studio is v1.2.0-beta or later.
+- Studio is connected to Nebula Graph.
+- A graph space is created.
+- Your account has the authority of GOD, ADMIN, or DBA.
+
+## Create a tag
+
+To create a tag on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In the **Graph Space List** page, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Settings") icon in the **Operations** column.
+
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Tag** tab and click the **+ Create** button.
+
+5. On the **Create** page, do these settings:
+
+   a. **Name**: Specify an appropriate name for the tag. In this example, `course` is specified.
+
+   b. (Optional) If necessary, in the upper left corner of the **Define Properties** panel, click the check box to expand the panel and do these settings:
+
+   - To define a property: Enter a property name, a data type, and a default value.
+
+   - To add multiple properties: Click the **Add Property** button and define more properties.
+
+   - To cancel a defined property: Besides the **Defaults** column, click the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "Cancel") icon.
+
+   c. (Optional) If no index is set for the tag, you can set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box to expand the panel and configure `TTL_COL` and `TTL_ DURATION`. For more information about both parameters, see [TTL configuration](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL/> "Click to go to Nebula Graph website").
+
+6. When the preceding settings are completed, in the **Equivalent to the following nGQL statement** panel, you can see the nGQL statement equivalent to these settings.
+
+   ![Define properties of the `course` tag](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-028.png "Define a tag")
+
+7. Confirm the settings and then click the **+ Create** button.
+
+When the tag is created successfully, the **Define Properties** panel shows all its properties on the list.
+
+## Edit a tag
+
+To edit a tag on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In the **Graph Space List** page, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Set") icon in the **Operations** column.
+
+3. In **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Tag** tab, find a tag and then the ![Icon of edit](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-021.png "Edit") icon in the **Operations** column.
+
+5. On the **Edit** page, do these settings:
+
+   - To edit a property: On the **Define Properties** panel, find a property, click **Edit**, and then change the data type or the default value.
+
+   - To delete a property: On the **Define Properties** panel, find a property and then click **Delete**.
+
+   - To add more properties: On the **Define Properties** panel, click the **Add Property** button to add a new property.
+
+   - To set the TTL configuration: In the upper left corner of the **Set TTL** panel, click the check box and then set the TTL configuration.
+
+   - To edit the TTL configuration: On the **Set TTL** panel, click **Edit** and then change the configuration of `TTL_COL` and `TTL_DURATION`.
+
+   - To delete the TTL configuration: When the **Set TTL** panel is expanded, in the upper left corner of the panel, click the check box to delete the configuration.
+
+6. When the configuration is done, in the **Equivalent to the following nGQL statement** panel, you can see the equivalent `ALTER TAG` statement.
+
+## Delete a tag
+
+To delete a tag on the **Schema** tab page, follow these steps:
+
+1. In the toolbar, click the **Schema** tab.
+
+2. In **Graph Space List**, find a graph space, and then click its name or the ![Icon of setting](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "Settings") icon in the **Operations** column.
+
+3. In the **Current Graph Space** field, confirm the name of the graph space. If necessary, you can choose another name to change the graph space.
+
+4. Click the **Tag** tab, find a tag and then the ![Icon of deletion](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png) icon in the **Operations** column.
+
+## Next to do
+
+After the tag is created, you can use the **Console** tab page to insert vertex data one by one manually or use the **Import** tab page to bulk import vertex data.