Skip to content

Commit

Permalink
feedback on docker desktop (#2518)
Browse files Browse the repository at this point in the history
* feedback on docker desktop

* comment fix

* comment
  • Loading branch information
abby-cyber authored Mar 26, 2024
1 parent 6f39355 commit d2fccc7
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 16 deletions.
11 changes: 4 additions & 7 deletions docs-2.0-en/2.quick-start/1.quick-start-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,15 @@

You can quickly get started with NebulaGraph by deploying NebulaGraph with Docker Desktop or Docker Compose.


=== "Using Docker Desktop"

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

1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/).

!!! caution
To install Docker Desktop, you need to install [WSL 2](https://docs.docker.com/desktop/install/windows-install/#system-requirements) first.

We do not recommend you deploy {{nebula.name}} on Docker Desktop for Windows due to its subpar performance. For details, see [#12401](https://github.com/docker/for-win/issues/12401). If you must use Docker Desktop for Windows, 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**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ NebulaGraph is designed and implemented for NVMe SSD. All default parameters are
- Use local SSD devices, or AWS Provisioned IOPS SSD equivalence.

## About CPU architecture
!!! note

Starting with 3.0.2, you can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers.
Starting with 3.0.2, you can run containerized NebulaGraph databases on Docker Desktop for ARM macOS or on ARM Linux servers.

!!! caution

We do not recommend you deploy {{nebula.name}} on Docker Desktop for Windows due to its subpar performance. For details, see [#12401](https://github.com/docker/for-win/issues/12401).


## Requirements for compiling the source code
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-zh/2.quick-start/1.quick-start-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

!!! caution

如果在 Windows 端安装 Docker Desktop 需[安装 WSL 2](https://docs.docker.com/desktop/install/windows-install/)。
不建议在 Windows 上使用 Docker Desktop,因为 Windows 上的 Docker Desktop 性能较差。详情请参见 [#12401](https://github.com/docker/for-win/issues/12401)。如果在 Windows 端安装 Docker Desktop 需[安装 WSL 2](https://docs.docker.com/desktop/install/windows-install/)。

2. 在仪表盘中单击`Extensions`或`Add Extensions`打开Extensions Marketplace 搜索 {{nebula.name}} ,也可以点击 [{{nebula.name}} ](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) 在 Docker Desktop 打开。
3. 导航到 {{nebula.name}} 的扩展市场。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@

## 关于 CPU 架构

从 3.0.2 开始,{{nebula.name}} 在 Docker Hub 上的 Docker 支持 ARM64 架构。社区用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 {{nebula.name}} 。

!!! caution

!!! note

从 3.0.2 开始,{{nebula.name}} 在 Docker Hub 上的 Docker 支持 ARM64 架构。社区用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 {{nebula.name}} 。


不建议在 Windows 上使用 Docker Desktop,因为 Windows 上的 Docker Desktop 性能较差。详情请参见 [#12401](https://github.com/docker/for-win/issues/12401)。


## 编译源码要求
Expand Down

0 comments on commit d2fccc7

Please sign in to comment.