Skip to content

Commit

Permalink
Merge 3.1.0 into master (#1474)
Browse files Browse the repository at this point in the history
* publish 3.1.0 (#1282)

* link fix (#1283)

* Update mkdocs.yml (#1285)

* Update st-ug-release-note.md

* Update load-balance.md (#1284)

* Update load-balance.md

* Update load-balance.md

* Update load-balance.md

* Update docs-2.0/8.service-tuning/load-balance.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* add one more note (#1286)

* Update mkdocs.yml (#1287)

* add limits for using Operator (#1288)

* pic error fix (#1289)

* Update mkdocs.yml (#1290)

* Update nebula-algorithm.md (#1291)

* error fix (#1292)

* Update 1.get-subgraph.md (#1293)

* Update 1.create-native-index.md

* change theme color to red (#1294)

* Update 2.find-path.md

* Update 1.explain-and-profile.md

* Update mkdocs.yml

* Update mkdocs.yml

* fix release

* Update source_manage-service.md

* Update 1.configurations.md

* Update 1.configurations.md

* Update 3.graph-config.md

* Update 4.storage-config.md

* fix release

* Update 2.compile-br.md

* Update mkdocs.yml (#1297)

* Update 2.deploy-connect-dashboard-ent.md (#1298)

* Update 2.deploy-connect-dashboard-ent.md

* Update 2.deploy-connect-dashboard-ent.md

* fix tag

* switch sync data (#1299)

* fix punctuation

* mike set default for 3.1.0 (#1295)

* fix gateway

* mix nebula.tag

* fix tag

* macro fix (#1300)

* macro fix (#1300)

* Update 3.manage-snapshot.md

* Update 2.1.show-create-index.md

* merge

* Update 4.delete-edge.md (#1301)

* Optimization for ngql overview (#1302)

* Update 1.overview.md

* Update 1.overview.md

* Update 1.resource-preparations.md (#1303)

* add cloud (#1304)

* Update 1.resource-preparations.md

* Update 1.install-nebula-graph-by-compiling-the-source-code.md

* Update 6.clear-space.md (#1305)

* Update 1.install-nebula-graph-by-compiling-the-source-code.md

* Update nebula-bench.md

* Update learning-path.md

* Update learning-path.md

* Update source_install-nebula-graph-by-rpm-or-deb.md

* Update 6.eco-tool-version.md

* Update ex-ug-deploy.md (#1306)

* Update deploy-nebula-graph-cluster.md

* Update standalone-deployment.md

* Update source_connect-to-nebula-graph.md

* Update manage-storage-host.md

* Update 1.configurations.md

* Update 1.configurations.md

* Update mkdocs.yml (#1307)

rename release note url path

* Update audit-log.md

* modify typo (#1308)

* Update 4.ldap.md

* Update 4.ldap.md

* Update load-balance.md

* Update mkdocs.yml (#1309)

* Update practice.md

* Update nebula-console.md

* Update use-importer.md (#1311)

* Update 10.geography.md (#1312)

* Add note for dashboard exposure (#1310)

* add note for dashboard exposure

* Update 1.resource-preparations.md

* fix pdf admonition

* add doc for better exposure of peripherals (#1313)

* Update 0-2.relates.md

* unify release-note

* Update use-importer.md

modify release linked macro name

* Update 2.deploy-dashboard.md

* Update 1.resource-preparations.md

* Update disk space requirement in upgrade doc (#1315)

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update 1.resource-preparations.md

* result-changes-for-status-all-before-adding-hosts (#1319)

* systemd note available for nebula-ent created by dashboard (#1318)

* comment sed (#1316)

* Update 18.show-queries.md (#1324)

* Update 4.install-nebula-graph-from-tar.md (#1323)

* Update 17.show-sessions.md (#1322)

* Config changes for quick start (#1321)

* Update 4.show-create-space.md (#1320)

* Update 14.geo.md (#1317)

* Update 6.cheatsheet-for-ngql.md (#1325)

* Update 1.comparison.md (#1326)

* Update with.md (#1335)

* Update yield.md (#1334)

* Update where.md (#1333)

* Update limit.md (#1332)

* Update return.md (#1331)

* Update order-by.md (#1330)

* Update limit.md (#1329)

* translate the benchmark report of v3.1.0 (#1342)

* translate the benchmark report of v3.1.0

* Update translation/310-performance-report.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Create 2.plato_doc.md (#1343)

* Sub  and superscripts test (#1341)

* formatting fix test

* Update 1.math.md

* Update mkdocs.yml

* Update 2.string.md (#1340)

* Update 2.drop-edge.md (#1339)

* Update 1.create-edge.md (#1338)

* Update 2.drop-tag.md (#1337)

* Update 4.describe-space.md (#1336)

* update explorer (#1344)

* Update st-ug-release-note.md (#1347)

* Update 4.date-and-time.md

* Update st-ug-release-note.md

* Update mkdocs.yml

* Update st-ug-deploy.md

* Fix a few typos (#1346)

* Update mkdocs.yml (#1350)

* rename studio (#1351)

* Update mkdocs.yml (#1353)

* Update st-ug-release-note.md (#1348)

* Delete cluster with helm (#1355)

* Update mkdocs.yml

* Update 3.2create-cluster-with-helm.md

* Update 1.create-space.md (#1349)

* Update 3.graph-service.md (#1356)

* Update ex-ug-import-from-mysql.md (#1360)

* Update ex-ug-parameter.md (#1361)

* Update 0-1-graph-database.md (#1362)

* Update 3.nebula-cpp-client.md (#1357)

* Update 3.1create-cluster-with-kubectl.md (#1359)

* Update 3.1create-cluster-with-kubectl.md

* Update 3.1create-cluster-with-kubectl.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* optimize explorer (#1352)

* optimize explorer

* Update docs-2.0/nebula-explorer/ex-ug-query-exploration.md

* Update docs-2.0/nebula-explorer/node-filtering.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* update docker (#1328)

* update docker

* Update docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md

* Update docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update mkdocs.yml (#1363)

* fixes (#1364)

* Update the way to keep THP disabled (#1366)

* Update the way to keep THP disabled

* Update 6.kernel-config.md

* optimize explorer (#1365)

* optimize explorer

* Update docs-2.0/nebula-explorer/12.query-visually.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-explorer/12.query-visually.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-explorer/12.query-visually.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-explorer/12.query-visually.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-explorer/12.query-visually.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-explorer/ex-ug-graph-exploration.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* error code (#1367)

* Update 12.query-visually.md (#1368)

* update error code (#1369)

* Update 2.graph-modeling.md (#1373)

Add a description

* fixed URL to tck features (#1382)

* Add CLEAR SPACE in cheatsheet (#1384)

* Update nebula-analytics.md (#1379)

* Update nebula-analytics.md

* Update nebula-analytics.md

* update studio v3.3.2 (#1385)

* update studio v3.3.2

* Update docs-2.0/nebula-studio/about-studio/st-ug-release-note.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Optimize replication-between-clusters (#1389)

* Update replication-between-clusters.md (#1391)

* Add toString in type convertion function table (#1394)

* display error fix (#1400)

* add-dashboard-community-1.1.1-for-master (#1402)

* yield clause required in go and fetch (#1388)

* yield clause required in go and fetch

* Update ngql-style-guide.md

* metric updates (#1396)

* Property filerting not supported for setting multi tags for310 (#1398)

* Update 12.query-visually.md

* property-filerting-not-supported-for-setting-multi-tags/edge types

* Update 1.overview.md (#1410)

* Update 1.nebula-client.md (#1408)

* Update 9.alerts.md (#1419)

* Update 2.monitor.md (#1417)

* Update ex-ug-parameter.md (#1414)

* Update ex-ug-parameter.md

* Update ex-ug-parameter.md

* Update 2.deploy-connect-dashboard-ent.md (#1420)

* Update ex-ug-what-is-explorer.md (#1411)

* fix ga issue (#1429)

* fix ga issue

* Update 404.html

* Update overrides/404.html

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update overrides/404.html

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update overrides/404.html

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update overrides/404.html

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>

* Update ttl-options.md (#1435)

* Update nebula-algorithm.md (#1437)

* Update learning-path.md (#1444)

* Update learning-path.md

* update playground

* only-provide-nebula-ent-package-in-Dashboard3.0.4 (#1448)

* Update learning-path.md (#1450)

* error-link-fix (#1452)

* Update README.md

* Update 2.deploy-dashboard.md

* Update 2.deploy-dashboard.md

* update monitoring metrics (#1466)

* Update 6.cheatsheet-for-ngql.md

* update deploy.yml

* fix a typo

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>
Co-authored-by: foesa <35463247+foesa-yang@users.noreply.github.com>
Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>
Co-authored-by: min.wu <50101159+whitewum@users.noreply.github.com>
Co-authored-by: whitewum <min.wu@vesoft.com>
Co-authored-by: Steam <evaz1879@gmail.com>
Co-authored-by: jamie.liu <57335825+jamieliu1023@users.noreply.github.com>
Co-authored-by: Liuxue-Yang <50105172+Liuxue-Yang@users.noreply.github.com>
Co-authored-by: Wey Gu <weyl.gu@gmail.com>
  • Loading branch information
10 people committed Jun 30, 2022
1 parent 704e9ca commit 6161ef2
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 24 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: Publish docs via GitHub Pages
on:
push:
branches:
# Remember to add v before the following version number unless the version is master.
- master

jobs:
Expand Down
13 changes: 13 additions & 0 deletions docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ This topic is for anyone interested in learning more about Nebula Graph. You can
| ------------------------------------------------------------ |
|[Create snapshots](../backup-and-restore/3.manage-snapshot.md)|

- Backup & Restore

| Document |
| ------------------------------------------------------------ |
|[Backup&Restore](../backup-and-restore/nebula-br/1.what-is-br.md)|
<!--
- Resource isolation
Expand Down Expand Up @@ -240,3 +245,11 @@ You can check if you have mastered Nebula Graph by completing the following prac
| Load test Nebula Graph with K6 | [Nebula Bench](../nebula-bench.md) |
| Query LDBC data (such as queries for vertices, paths, or subgraphs.) | [LDBC](chrome-extension://gfbliohnnapiefjpjlpjnehglfpaknnc/pages/pdf_viewer.html?r=http://ldbcouncil.org/ldbc_snb_docs/ldbc-snb-specification.pdf) and [interactive-short-1.cypher](https://github.com/ldbc/ldbc_snb_interactive/blob/main/cypher/queries/interactive-short-1.cypher) |


## 8. Get Nebula Graph Certifications

Now you could get Nebula Graph Certifications from [Nebula Academy](https://academic.nebula-graph.io).

- Nebula Graph Certified Insider(NGCI): The NGCI certification provides a birdview to graph databases and the Nebula Graph database. Passing NGCI shows that you have a good understanding of Nebula Graph.

- Nebula Graph Certified Professional(NGCP): The NGCP certification drives you deep into the Nebula Graph database and its ecosystem, providing a 360-degree view of the leading-edge graph database. Passing NGCP proves that you are a professional with a profound understanding of Nebula Graph.
6 changes: 0 additions & 6 deletions docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,3 @@ curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"
{% include "/source-monitoring-metrics.md" %}

<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->






1 change: 1 addition & 0 deletions docs-2.0/8.service-tuning/2.graph-modeling.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ nebula> MATCH (v1:player)-[e:temp]->() return collect(e.tmp);
| [1, 2, 3] |
+----------------+
```
Operations on loops are not encapsulated with any syntactic sugars and you can use them just like those on normal edges.

### About dangling edges

Expand Down
4 changes: 4 additions & 0 deletions docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Nebula Dashboard Enterprise Edition (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in Nebula Graph clusters. This topic introduces Dashboard Enterprise Edition. For more information, see [What is Nebula Dashboard Community Edition](../nebula-dashboard/1.what-is-dashboard.md).

!!! Note

You can also try some [functions online](https://dashboard.nebula-graph.io/clusters) in Dashboard.

![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview-2022-4-14_en.gif)

## Features
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ At the top of the Dashboard page, click **Cluster Management**, and then click *

## Overview

The **Overview** page has five parts:
The **Overview** page has the following parts:

- Cluster survey
- Alert
Expand Down
2 changes: 0 additions & 2 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ Click **Monitoring**->**TV Dashboard** to enter the TV Dashboard page.
| Left side of the area | 1. QPS (Query Per Second) of your cluster.<br/>2. The monitoring information of 2 Storage service metrics at different periods. The two metrics are: add_edges_latency_us,add_vertices_latency_us. |
| Right side of the area | The node-related metrics information at different periods. Metrics include: <br/>1. cpu_utilization<br/>2. memory_utilization<br/>3. load_1m<br/>4. disk_readbytes<br/>5. disk_writebytes |


For more information about the monitoring metrics, see [Metrics](../7.monitor-parameter.md).

!!! note
Expand All @@ -75,4 +74,3 @@ For more information about the monitoring metrics, see [Metrics](../7.monitor-pa
- When 100≥Health Degree≥80, the score is blue; When 80>Health Degree≥60, the score is yellow; When Health Degree<60, the score is yellow.
- Algorithm: (1-number of abnormal services/total number of services)*100%.
- Except for the appearance of the first `emergency` level alert that deducts 40 points, 10 points are deducted for each of the other `emergency` level alerts and other levels of alerts.

2 changes: 1 addition & 1 deletion docs-2.0/nebula-dashboard-ent/7.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ The period is the time range of counting metrics. It currently supports 5 second

{% include "/source-monitoring-metrics.md" %}

<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
2 changes: 1 addition & 1 deletion docs-2.0/nebula-dashboard/2.deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ After the service is started, you can enter `<IP>:8090` in the browser to check
prometheus:
target: "127.0.0.1:9090" // The IP address and port of the prometheus service.
nebulaServer:
ip: "192.168.8.143" // The IP of the machine where your Nebula Graph is deployed.
ip: "192.168.8.143" // The IP address of any Graph service.
port: 9669 // The port of the Nebula Graph.
...
```
Expand Down
2 changes: 0 additions & 2 deletions docs-2.0/nebula-dashboard/6.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,3 @@ The period is the time range of counting metrics. It currently supports 5 second
{% include "/source-monitoring-metrics.md" %}

<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->


Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,9 @@ Explorer has these features:
Authentication is not enabled in Nebula Graph by default. Users can log into Studio with the `root` account and any password.

When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md).

## Video

- [Nebula Explorer Intro Demo](https://www.youtube.com/watch?v=1Hj5puN9jeg)(5 minutes 22 seconds)

<iframe width="560" height="315" src="https://www.youtube.com/embed/1Hj5puN9jeg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
6 changes: 5 additions & 1 deletion docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## v3.3.2(2022.05.19)

- Fix
- Fix the rendering bug when a path has only one source vertex.

## v3.3.1(2022.05.07)

- Fix
Expand All @@ -20,4 +25,3 @@
- Support favorite historical statements.
- Support the display of historical statements results.
- Add graph exploration to the console.

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Nebula Studio (Studio in short) is a browser-based visualization tool to manage Nebula Graph. It provides you with a graphical user interface to manipulate graph schemas, import data, and run nGQL statements to retrieve data. With Studio, you can quickly become a graph exploration expert from scratch. You can view the latest source code in the Nebula Graph GitHub repository, see [nebula-studio](https://github.com/vesoft-inc/nebula-studio) for details.

!!! Note

You can also try some functions [online](https://playground.nebula-graph.io/explorer) in Studio.

## Released versions

You can deploy Studio using the following methods:
Expand Down
4 changes: 0 additions & 4 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ Studio on Cloud can be used on Nebula Graph Cloud Service. When you create a Neb

This topic describes how to deploy Studio locally by RPM, DEB, tar package and Docker.

!!! Note

You can also try some [functions online](https://playground.nebula-graph.io/explorer) in Studio.

## RPM-based Studio

### Prerequisites
Expand Down
6 changes: 1 addition & 5 deletions mkdocs.yml
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,11 @@ theme:
logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png'
favicon: 'assets/images/favicon.ico'
palette:
- scheme: default
primary: teal
accent: green
- scheme: nebula
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: deep orange
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
Expand Down
2 changes: 1 addition & 1 deletion overrides/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ <h2>Sorry, the page is invalid...</h2>
<p>Return to <a href="javascript:history.back(-1)">the previous page</a>.</p>
<p>Return to <a href="/">the home page</a>.</p>
{% endblock %}
{% block disqus %}{% endblock %}
{% block disqus %}{% endblock %}

0 comments on commit 6161ef2

Please sign in to comment.