update docs-en (#11)

* update docs-en * update * update * Update docs-2.0-en/20.appendix/6.eco-tool-version.md * Update docs-2.0-en/7.data-security/1.authentication/3.role-list.md * Update docs-2.0-en/3.ngql-guide/9.space-statements/6.clear-space.md * Update docs-2.0-en/20.appendix/port-guide.md * Update mkdocs.yml * update --------- Co-authored-by: Chris Chen <[email protected]>
vesoft-inc · Oct 20, 2023 · 50bcd06 · 50bcd06
1 parent 69f83bc
commit 50bcd06
Show file tree

Hide file tree

Showing 117 changed files with 126 additions and 4,041 deletions.
diff --git a/docs-2.0-en/15.contribution/how-to-contribute.md b/docs-2.0-en/15.contribution/how-to-contribute.md
diff --git a/docs-2.0-en/2.quick-start/1.quick-start-workflow.md b/docs-2.0-en/2.quick-start/1.quick-start-workflow.md
@@ -83,10 +83,6 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke
         ```
 
     3. Configure License Manager address.
-
-      !!! enterpriseonly
-
-            Skip this step if you are using the community version.
       
             1. Edit the `docker-compose.yml` file.
 

diff --git a/docs-2.0-en/2.quick-start/3.1add-storage-hosts.md b/docs-2.0-en/2.quick-start/3.1add-storage-hosts.md
@@ -27,8 +27,6 @@ You have [connected to NebulaGraph](3.connect-to-nebula-graph.md).
   nebula> ADD HOSTS 192.168.10.100:9779, 192.168.10.101:9779, 192.168.10.102:9779;
   ```
 
-  {{ent.ent_begin}}
-
   If enabling the [Zone](../../4.deployment-and-installation/5.zone.md) feature, you still need to specify `INTO ZONE <zone_name>` to add Storage hosts, otherwise the Storage hosts will fail to be added. 
 
   ```ngql
@@ -40,7 +38,6 @@ You have [connected to NebulaGraph](3.connect-to-nebula-graph.md).
   ```ngql
   nebula> ADD HOSTS 192.168.8.111:9779,192.168.8.112:9779 INTO ZONE az1;
   ```
-  {{ent.ent_end}}
 
   !!! caution
 

diff --git a/docs-2.0-en/20.appendix/0.FAQ.md b/docs-2.0-en/20.appendix/0.FAQ.md
@@ -348,12 +348,6 @@ $ ./nebula-graphd --version
 
   Run `rpm -qa |grep nebula` to check the version of NebulaGraph.
 
-### "How to scale my cluster up/down or out/in?"
-
-!!! enterpriseonly
-
-    The cluster scaling function has not been officially released in the community edition. The operations involving `SUBMIT JOB BALANCE DATA REMOVE` and `SUBMIT JOB BALANCE DATA` are experimental features in the community edition and the functionality is not stable. Before using it in the community edition, make sure to back up your data first and set `enable_experimental_feature` and `enable_data_balance` to `true` in the [Graph configuration file](../5.configurations-and-logs/1.configurations/3.graph-config.md).
-
 #### Increase or decrease the number of Meta, Graph, or Storage nodes
 
 NebulaGraph {{ nebula.release }} does not provide any commands or tools to support automatic scale out/in. You can refer to the following steps:
@@ -380,11 +374,9 @@ NebulaGraph {{ nebula.release }} does not provide any commands or tools to suppo
 
 You also need to run [Balance Data and Balance leader](../8.service-tuning/load-balance.md) after scaling in/out storaged.
 
- {{ent.ent_begin}}
 You can scale Graph and Storage services with Dashboard Enterprise Edition. For details, see [Scale](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md). 
 
 You can also use NebulaGraph Operator to scale Graph and Storage services. For details, see [Deploy NebulaGraph clusters with Kubectl](../nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) and [Deploy NebulaGraph clusters with Helm](../nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md).
- {{ent.ent_end}}
 
 #### Add or remove disks in the Storage nodes
 

diff --git a/docs-2.0-en/20.appendix/6.eco-tool-version.md b/docs-2.0-en/20.appendix/6.eco-tool-version.md
@@ -2,47 +2,6 @@
 
 ![NebulaGraph birdview](https://docs-cdn.nebula-graph.com.cn/figures/architecture_map_2022-08-08_17-37-15.png)
 
-!!! compatibility
-
-    The core release number naming rule is `X.Y.Z`, which means `Major version X`, `Medium version Y`, and `Minor version Z`. The upgrade requirements for the client are:
-
-    - Upgrade the core from `X.Y.Z1` to `X.Y.Z2`: It means that the core is fully forward compatible and is usually used for bugfixes. It is recommended to upgrade the minor version of the core as soon as possible. At this time, the client can stay **not upgraded**.
-
-    - Upgrade the core from `X.Y1.*` to `X.Y2.*`: It means that there is some incompatibility of API, syntax, and return value. It is usually used to add functions, improve performance, and optimize code. The client needs to be upgraded to `X.Y2.*`.
-
-    - Upgrade the core from `X1.*.*` to `X2.*.*`: It means that there is a major incompatibility in storage formats, API, syntax, etc. You need to use tools to upgrade the core data. The client must be upgraded.
-
-    - The default core and client do not support downgrade: You cannot downgrade from `X.Y.Z2` to `X.Y.Z1`.
-
-    - The release cycle of a `Y` version is about 6 months, and its maintenance and support cycle is 6 months.
-
-    - The version released at the beginning of the year is usually named `X.0.0`, and in the middle of the year, it is named `X.5.0`.
-
-    - The file name contains `RC` to indicate an unofficial version (`Release Candidate`) that is only used for preview. Its maintenance period is only until the next RC or official version is released. Its client, data compatibility, etc. are not guaranteed.
-
-    - The files with `nightly`, `SNAPSHOT`, or date are the nightly versions. There is no quality assurance and maintenance period.
-
-## NebulaGraph Studio
-
-NebulaGraph Studio (Studio for short) is a graph database visualization tool that can be accessed through the Web. It can be used with NebulaGraph DBMS to provide one-stop services such as composition, data import, writing nGQL queries, and graph exploration. For details, see [What is NebulaGraph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md).
-
-!!! Note
-
-    The release of the Studio is independent of NebulaGraph core, and its naming method is also not the same as the core naming rules. 
-
-|NebulaGraph version|Studio version|
-|:---|:---|
-| {{ nebula.tag }} | {{studio.tag}}|
-
-## NebulaGraph Dashboard Community Edition
-
-NebulaGraph Dashboard Community Edition (Dashboard for short) is a visualization tool for monitoring the status of machines and services in the NebulaGraph cluster. For details, see [What is NebulaGraph Dashboard](../nebula-dashboard/1.what-is-dashboard.md).
-
-|NebulaGraph version|Dashboard Community version|
-|:---|:---|
-| {{ nebula.tag }} | {{dashboard.tag}}|
-
- {{ent.ent_begin}}
 ## NebulaGraph Dashboard Enterprise Edition
 
 NebulaGraph Dashboard Enterprise Edition (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in NebulaGraph cluster. For details, see [What is NebulaGraph Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md).
@@ -59,7 +18,6 @@ NebulaGraph Explorer (Explorer for short) is a graph exploration visualization t
 |:---|:---|
 | {{ nebula.tag }}  | {{explorer.tag}}|
 
-  {{ent.ent_end}}
 ## NebulaGraph Stats Exporter
 
 [Nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter) exports monitor metrics to Promethus.
@@ -72,9 +30,9 @@ NebulaGraph Explorer (Explorer for short) is a graph exploration visualization t
 
 NebulaGraph Exchange (Exchange for short) is an Apache Spark&trade application for batch migration of data in a cluster to NebulaGraph in a distributed environment. It can support the migration of batch data and streaming data in a variety of different formats. For details, see [What is NebulaGraph Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md).
 
-|NebulaGraph version|Exchange Community version|Exchange Enterprise version|
-|:---|:---|:--|
-| {{ nebula.tag }}  | {{exchange.tag}} | {{exchange_ent.tag}} |
+|NebulaGraph version|Exchange Enterprise version|
+|:---|:---|
+| {{ nebula.tag }}  |{{exchange_ent.tag}} |
 
 ## NebulaGraph Operator
 
@@ -116,9 +74,6 @@ NebulaGraph Algorithm (Algorithm for short) is a Spark application based on [Gra
 |:---|:---|
 | {{ nebula.tag }}  | {{algorithm.tag}}|
 
-
-{{ent.ent_begin}}
-
 ## NebulaGraph Analytics
 
 NebulaGraph Analytics is an application that integrates the open-source Plato Graph Computing Framework, with which NebulaGraph Analytics performs graph computations on NebulaGraph database data. For details, see [What is NebulaGraph Analytics](../graph-computing/nebula-analytics.md).
@@ -127,8 +82,6 @@ NebulaGraph Analytics is an application that integrates the open-source Plato Gr
 |:---|:---|
 | {{ nebula.tag }}  | {{plato.tag}}|
 
-{{ent.ent_end}}
-
 ## NebulaGraph Console
 
 NebulaGraph Console is the native CLI client of NebulaGraph. For how to use it, see [NebulaGraph Console](../14.client/nebula-console.md).
@@ -137,24 +90,6 @@ NebulaGraph Console is the native CLI client of NebulaGraph. For how to use it,
 |:---|:---|
 | {{ nebula.tag }}  | {{console.tag}}|
 
-## NebulaGraph Docker Compose
-
-Docker Compose can quickly deploy NebulaGraph clusters. For how to use it, please refer to [Docker Compose Deployment NebulaGraph](../2.quick-start/1.quick-start-workflow.md).
-
-|NebulaGraph version|Docker Compose version|
-|:---|:---|
-| {{ nebula.tag }}  | {{dockercompose.tag}}|
-
-## Backup & Restore
-
-[Backup&Restore](../backup-and-restore/nebula-br/1.what-is-br.md) (BR for short) is a command line interface (CLI) tool that can help back up the graph space data of NebulaGraph, or restore it through a backup file data.
-
-|NebulaGraph version|BR version|
-|:---|:---|
-| {{ nebula.tag }}  | {{br.tag}}|
-
-
-{{ent.ent_begin}}
 ## Backup & Restore Enterprise Edition
 
 Backup Restore (BR for short) Enterprise Edition is a Command-Line Interface (CLI) tool. With BR Enterprise Edition, you can back up and restore NebulaGraph Enterprise Edition data.
@@ -163,8 +98,6 @@ Backup Restore (BR for short) Enterprise Edition is a Command-Line Interface (CL
 |:---|:---|
 | {{ nebula.tag }}  | {{br_ent.tag}}|
 
-{{ent.ent_end}}
-
 ## NebulaGraph Bench
 
 [NebulaGraph Bench](https://github.com/vesoft-inc/nebula-bench/releases/tag/{{bench.tag}}) is used to test the baseline performance data of NebulaGraph. It uses the standard data set of LDBC.

diff --git a/docs-2.0-en/20.appendix/port-guide.md b/docs-2.0-en/20.appendix/port-guide.md
@@ -27,8 +27,7 @@ The following are the default ports used by NebulaGraph core and peripheral tool
 | 21 | NebulaGraph Dashboard | TCP | 9200 | Nebula Stats Exporter dependency service port. Collects cluster performance metrics, including service IP addresses, versions, and monitoring metrics (such as query count, query latency, heartbeat latency, etc.). |
 | 22 | NebulaGraph Dashboard | TCP | 9100 | Node Exporter dependency service port. Collects resource information for machines in the cluster, including CPU, memory, load, disk, and traffic. |
 | 23 | NebulaGraph Dashboard | TCP | 9091 | Prometheus service port. Time-series database for storing monitoring data. |
-| 24 | NebulaGraph Dashboard | TCP | 7003 | Dashboard Community Edition web service port. |
-| 25 | NebulaGraph Dashboard | TCP | 7005 | Dashboard Enterprise Edition web service port. |
-| 26 | NebulaGraph Dashboard | TCP | 9093 | Alertmanager service port. Receives alerts from Prometheus and sends alert notifications to Dashboard. |
-| 27 | NebulaGraph Explorer | TCP | 7002 | Explorer web service port. |
-| 28 | License Manager | TCP | 9119 | The port for the License Manager (LM) service. The LM service is used for managing licenses (only used in enterprise clusters).|
+| 24 | NebulaGraph Dashboard | TCP | 7005 | Dashboard Enterprise Edition web service port. |
+| 25 | NebulaGraph Dashboard | TCP | 9093 | Alertmanager service port. Receives alerts from Prometheus and sends alert notifications to Dashboard. |
+| 26 | NebulaGraph Explorer | TCP | 7002 | Explorer web service port. |
+| 27 | License Manager | TCP | 9119 | The port for the License Manager (LM) service. The LM service is used for managing licenses.|