Skip to content

Commit

Permalink
add 2.0 in README (#201)
Browse files Browse the repository at this point in the history
* add 2.0 in README

* update doc links

* fix wum
  • Loading branch information
amber-moe authored Nov 13, 2020
1 parent d55c0d7 commit 2329ed4
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 36 deletions.
42 changes: 9 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,17 @@
# Nebula Graph Documentation
# Nebula Graph documentation

This repository holds all the source files of **Nebula Graph** Documentations at [Official Documentation Site](https://docs.nebula-graph.io/).
This repository holds all the source files of Nebula Graph Documentations at the [Documentation Site](https://docs.nebula-graph.io/).

## Documentation Structure
## Documentation index

The general **Nebula Graph** documentation structure is as follows:

```bash
├── Language
├── Overview
├── Introduction
├── Concepts
├── Quick Start
├── Get Started
├── ...
├── Query Language
├── Data Types
├── ...
├── Functions and Operators
├── ...
├── Language Structure
├── ...
├── Statement Syntax
├── ...
├── Build Develop and Administration
├── Build
├── ...
├── ...
...
```

Detail TOC (table of content) please refer to the following links.

- [Documentation Index](docs/manual-EN/README.md)
- Documentation index for [Nebula Graph 1.0](docs/manual-EN/README.md)
- Documentation index for Nebula Graph 2.0
- [中文文档](https://docs.nebula-graph.com.cn/)
- [Official Documentation Site](https://docs.nebula-graph.io/)
- Clients (TODO)
- [Nebula Graph Cloud](https://cloud-docs.nebula-cloud.io/en/posts/toc/dbaas-ug-toc/)
- [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-web-docker/tree/master/docs/en)

## Contributing

If you find documentation issues, feel free to create an [Issue](https://github.com/vesoft-inc/nebula-docs/issues) to let us know or directly create a [Pull Request](https://github.com/vesoft-inc/nebula-docs/pulls) to help fix or update it. See **Nebula Graph** [CONTRIBUTING](CONTRIBUTING.md) guide to get started.
If you have any questions on our documentation, feel free to raise an [Issue](https://github.com/vesoft-inc/nebula-docs/issues) or directly create a [Pull Request](https://github.com/vesoft-inc/nebula-docs/pulls) to help fix or update it. See Nebula Graph [CONTRIBUTING](CONTRIBUTING.md) guide to get started.
3 changes: 3 additions & 0 deletions docs-2.0/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Manual Changes

* 0.1.1 - Initial release Nebula Graph alpha
70 changes: 70 additions & 0 deletions docs-2.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Welcome to Nebula Graph 2.0 Documentation

Nebula Graph is a distributed, scalable, and lightning-fast graph database.

It is the optimal solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges with millisecond latency.

## Tutorial Video

* [YouTube](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw/)
* [bilibili](https://space.bilibili.com/472621355)

## Preface

* [Manual Change Log](CHANGELOG.md)

## Introduction

* [What is Nebula Graph](1.introduction/1.what-is-nebula-graph.md)

## Quick start (for beginners)

* [Quick start workflow](2.quick-start/1.quick-start-workflow.md)
* [Deploy Nebula Graph with Docker Compose](docs-2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose.md)
* [Connect to Nebula Graph](docs-2.0/2.quick-start/3.connect-to-nebula-graph.md)
* [Nebula Graph CRUD](docs-2.0/2.quick-start/4.nebula-graph-crud.md)

## nGQL guide (for all users)

* Operators
* [Comparison](docs-2.0/3.ngql-guide/5.operators/1.comparison.md)
* [Pipe](docs-2.0/3.ngql-guide/5.operators/4.pipe.md)
* [Property reference](docs-2.0/3.ngql-guide/5.operators/5.property-reference.md)
* [Set](docs-2.0/3.ngql-guide/5.operators/6.set.md)
* [String](docs-2.0/3.ngql-guide/5.operators/7.string.md)
* [Precedence](docs-2.0/3.ngql-guide/5.operators/9.precedence.md)

* Functions and expressions
* [Math](docs-2.0/3.ngql-guide/6.funtions-and-expressions/1.math.md)
* [String](docs-2.0/3.ngql-guide/6.funtions-and-expressions/2.string.md)
* [Date and time](docs-2.0/3.ngql-guide/6.funtions-and-expressions/3.date-and-time.md)
* [Schema](docs-2.0/3.ngql-guide/6.funtions-and-expressions/4.schema.md)
* [Case expressions](docs-2.0/3.ngql-guide/6.funtions-and-expressions/5.case-expressions.md)

* General query statements
* [Match](docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md)

* Space statements
* [Create space](docs-2.0/3.ngql-guide/9.space-statements.md/1.create-space.md)
* [Use space](docs-2.0/3.ngql-guide/9.space-statements.md/2.use-space.md)
* [Show spaces](docs-2.0/3.ngql-guide/9.space-statements.md/3.show-spaces.md)
* [Describe space](2.query-language/4.statement-syntax/1.data-definition-statements/create-edge-syntax.md)
* [Drop space](docs-2.0/3.ngql-guide/9.space-statements.md/5.drop-space.md)

* Vertex statements
* [Insert vertex](docs-2.0/3.ngql-guide/12.vertex-statements/1.insert-vertex.md)
* [Update vertex](docs-2.0/3.ngql-guide/12.vertex-statements/2.update-vertex.md)
* [Upsert vertex](docs-2.0/3.ngql-guide/12.vertex-statements/3.upsert-vertex.md)
* [Delete vertex](docs-2.0/3.ngql-guide/12.vertex-statements/4.delete-vertex.md)

* Subgraph and path
* [Get subgraph](docs-2.0/3.ngql-guide/15.subgraph-and-path/1.get-subgraph.md)

* Query tuning statements
* [Explain and profile](docs-2.0/3.ngql-guide/16.query-tuning-statements/1.explain-and-profile.md)

## Deployment and installation (for Developers and DBA)

* [Resource preparations](docs-2.0/4.deployment-and-installation/1.resource-preparations.md)
* Compile and install Nebula Graph
* [Install Nebula Graph by compiling the source code](docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)
4 changes: 2 additions & 2 deletions docs/manual-EN/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to the Official Nebula Graph Documentation
# Welcome to Nebula Graph 1.0 Documentation

**Nebula Graph** is a distributed, scalable, and lightning-fast graph database.

Expand Down Expand Up @@ -128,7 +128,7 @@ It is the optimal solution in the world capable of hosting graphs with dozens of
* [Storaged Configuration](3.build-develop-and-administration/3.configurations/5.storage-config.md)
* [Console Configuration](3.build-develop-and-administration/3.configurations/6.console-config.md)
* [Kernel Configuration](3.build-develop-and-administration/3.configurations/7.kernel-config.md)
* [Single Node Log](3.build-develop-and-administration/3.configurations/8.single-node-log.md)
* [Change Log Severity on a Host](3.build-develop-and-administration/3.configurations/8.single-node-log.md)
* Account Management Statement
* [Alter User Syntax](3.build-develop-and-administration/4.account-management-statements/alter-user-syntax.md)
* [Authentication](3.build-develop-and-administration/4.account-management-statements/authentication.md)
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ nav:
- Storaged Configuration: manual-EN/3.build-develop-and-administration/3.configurations/5.storage-config.md
- Console Configuration: manual-EN/3.build-develop-and-administration/3.configurations/6.console-config.md
- Kernel Configuration: manual-EN/3.build-develop-and-administration/3.configurations/7.kernel-config.md
- Single Node Log: manual-EN/3.build-develop-and-administration/3.configurations/8.single-node-log.md
- Change Log Severity on a Host: manual-EN/3.build-develop-and-administration/3.configurations/8.single-node-log.md
- Account Management Statement:
- Alter User Syntax: manual-EN/3.build-develop-and-administration/4.account-management-statements/alter-user-syntax.md
- Authentication: manual-EN/3.build-develop-and-administration/4.account-management-statements/authentication.md
Expand Down

0 comments on commit 2329ed4

Please sign in to comment.