diff --git a/docs-2.0/2.quick-start/1.quick-start-workflow.md b/docs-2.0/2.quick-start/1.quick-start-workflow.md index 5c9b7f0cf49..e8f358fcb3f 100644 --- a/docs-2.0/2.quick-start/1.quick-start-workflow.md +++ b/docs-2.0/2.quick-start/1.quick-start-workflow.md @@ -1,10 +1,39 @@ -# Quick start workflow +# Getting started with NebulaGraph -The quick start introduces the simplest workflow to use NebulaGraph, including deploying NebulaGraph, connecting to NebulaGraph, and doing basic CRUD. +This topic describes how to use NebulaGraph with Docker Desktop and on-premises deployment workflow to quickly get started with NebulaGraph. -## Steps +## Using NebulaGraph with Docker Desktop -Users can quickly deploy and use NebulaGraph in the following steps. +NebulaGraph is available as a [Docker Extension](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) that you can easily install and run on your Docker Desktop. You can quickly deploy NebulaGraph using Docker Desktop with just one click. + +1. Install Docker Desktop + + - [Install Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install/) + - [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/) + + !!! caution + To install Docker Desktop, you need to install [WSL 2](https://docs.docker.com/desktop/install/windows-install/#system-requirements) first. + +2. In the left sidebar of Docker Desktop, click **Extensions** or **Add Extensions**. +3. On the Extensions Marketplace, search for NebulaGraph and click **Install**. + + ![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png) + + Click **Update** to update NebulaGraph to the latest version when a new version is available. + + ![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png) + +4. Click **Open** to navigate to the NebulaGraph extension page. + +5. At the top of the page, click **Studio in Browser** to use NebulaGraph. + +For more information about how to use NebulaGraph with Docker Desktop, see the following video: + + + +## Deploying NebulaGraph on-premises workflow + +The following workflow describes how to use NebulaGraph on-premises, including deploying NebulaGraph, connecting to NebulaGraph, and running basic CRUD. 1. [Deploy NebulaGraph](2.install-nebula-graph.md) diff --git a/mkdocs.yml b/mkdocs.yml index b43be64fb12..70d968fa4ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -286,7 +286,7 @@ nav: - Storage Service: 1.introduction/3.nebula-graph-architecture/4.storage-service.md - Quick start: - - Quick start workflow: 2.quick-start/1.quick-start-workflow.md + - Getting started with NebulaGraph: 2.quick-start/1.quick-start-workflow.md - Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md - Step 2 Manage NebulaGraph Service: 2.quick-start/5.start-stop-service.md - Step 3 Connect to NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md