Fix studio format (#671)

* Fix studio format * Update st-ug-deploy.md
vesoft-inc · Sep 2, 2021 · 38b7b5d · 38b7b5d
1 parent 38ac0b7
commit 38b7b5d
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 10 deletions.
diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md b/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
@@ -2,5 +2,5 @@
 
 ## v3.0.0 (2021.08.13)
 - Feature Enhancements:
-  - Compatible with Nebula Graph v2.5.0
-  - Supported adding `COMMENT` in Space, Tag, Edge Type, Index while configuration Schema
+  - Compatible with Nebula Graph v2.5.0.
+  - Supported adding `COMMENT` in Space, Tag, Edge Type, Index while configuration Schema.
diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md
@@ -6,11 +6,11 @@ Nebula Graph Studio (Studio in short) is a browser-based visualization tool to m
 
 For now, Studio has three release versions:
 
-- Docker-based. You can deploy Studio with Docker and connect it to Nebula Graph. For more information, see [Docker-based Studio](../install-configure/st-ug-deploy.md).
+- Docker-based. You can deploy Studio with Docker and connect it to Nebula Graph. For more information, see [Docker-based Studio](../deploy-connect/st-ug-deploy.md).
 
-- RPM-based. You can deploy Studio with RPM and connect it to Nebula Graph. For more information, see [RPM-based Studio](../install-configure/st-ug-deploy.md).
+- RPM-based. You can deploy Studio with RPM and connect it to Nebula Graph. For more information, see [RPM-based Studio](../deploy-connect/st-ug-deploy.md).
 
-- tar-based.You can deploy Studio with tar and connect it to Nebula Graph. For more information, see [tar-based Studio](../install-configure/st-ug-deploy.md).
+- tar-based.You can deploy Studio with tar and connect it to Nebula Graph. For more information, see [tar-based Studio](../deploy-connect/st-ug-deploy.md).
 
 The functions of the three release versions are the same and may be restricted when using Studio. For more information, see [Limitations](../about-studio/st-ug-limitations.md).
 

diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md
@@ -10,15 +10,15 @@ Before connecting to the Nebula Graph database, you need to confirm the followin
 
 - You have the local IP address and the port used by the Graph service of Nebula Graph. The default port is `9669`.  
 
-    !!! note
+  !!! note
 
         Run `ifconfig` or `ipconfig` on the machine to get the IP address.
 
 - You have a Nebula Graph account and its password.
 
-    !!! note
+  !!! note
 
-        If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/{{ nebula.release }}/).
+        If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/).
 
 
 ## Procedure
@@ -33,9 +33,12 @@ To connect Studio to Nebula Graph, follow these steps:
 
         When Nebula Graph and Studio are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field.
 
-   - **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph
+   - **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph.
+
       - If authentication is not enabled, you can use `root` and any password as the username and its password.
+
       - If authentication is enabled and no account information has been created, you can only log in as GOD role and use `root` and `nebula` as the username and its password.
+
       - If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.
 
    ![The Config Server page shows the fields to be configured for connection](../figs/st-ug-050-1.png "Config Server")

diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
@@ -217,6 +217,7 @@ Before you deploy Docker-based Studio , you must do a check of these:
 ### Install
 
 1. Select and download the tar package according to your needs. It is recommended to select the latest version. Common links are as follows:
+
    | Installation package | Studio version |
    | --- | --- |
    | [nebula-graph-studio-3.0.0-1.x86_64.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/3.0.0/nebula-graph-studio-3.0.0-1.x86_64.tar.gz) | 3.0.0 |

diff --git a/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md b/docs-2.0/nebula-studio/troubleshooting/st-ug-faq.md
@@ -1,6 +1,6 @@
 # FAQ
 
-???+ faq "Why can't I use a function?"
+!!! faq "Why can't I use a function?"
 
     If you find that a function cannot be used, it is recommended to troubleshoot the problem according to the following steps:
     1. Confirm that Nebula Graph is the latest version. If you use Docker Compose to deploy the Nebula Graph database, it is recommended to run `docker-compose pull && docker-compose up -d` to pull the latest Docker image and start the container.