Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add-using-nebula-with-docker-desktop-in-quick-start #1975

Merged
merged 3 commits into from
Feb 28, 2023
Merged

add-using-nebula-with-docker-desktop-in-quick-start #1975

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60941eb
add-using-nebula-with-docker-desktop-in-quick-start
abby-cyber Feb 28, 2023
e1a5d41
Update 1.quick-start-workflow.md
abby-cyber Feb 28, 2023
c8e3142
Update 1.quick-start-workflow.md
abby-cyber Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions docs-2.0/2.quick-start/1.quick-start-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# 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.
NebulaGraph is available as a Docker container that you can easily install and run on your system. You can quickly deploy NebulaGraph using Docker Desktop with just one click.
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

## Steps
## Using NebulaGraph with Docker Desktop

Users can quickly deploy and use NebulaGraph in the following steps.
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)

1. Click **Open** to navigate to the NebulaGraph extension page.

2. 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:

<iframe width="560" height="315" src="https://www.youtube.com/embed/8zKer-4RXEg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

## 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)

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down