From 9f7a5bd827cbdd6acb4487d5f5efe84391a30464 Mon Sep 17 00:00:00 2001 From: han Date: Thu, 5 Jan 2023 21:04:31 +0800 Subject: [PATCH] docs: fix some typo and bad links in getting-started.md Signed-off-by: han --- docs-zh/guide/getting-started.md | 12 ++++++------ docs/guide/getting-started.md | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs-zh/guide/getting-started.md b/docs-zh/guide/getting-started.md index f793981..e7679b1 100644 --- a/docs-zh/guide/getting-started.md +++ b/docs-zh/guide/getting-started.md @@ -69,9 +69,9 @@ def tensorboard(envd_port=6006, envd_dir="/home/envd/logs", ::: -⏱️ **Builtkit 原生，构建速度提高 6 倍** +⏱️ **BuildKit 原生，构建速度提高 6 倍** -[Buildkit](https://github.com/moby/buildkit) 支持并行构建和构建时的软件缓存（例如 pip 和 apt 缓存）。你可以在不用了解细节的情况下享受到它的强大之处。 +[BuildKit](https://github.com/moby/buildkit) 支持并行构建和构建时的软件缓存（例如 pip 和 apt 缓存）。你可以在不用了解细节的情况下享受到它的强大之处。 例如，PyPI 缓存是在不同的构建过程中可以被被共享。因此如果软件包以前被下载过，就会直接利用缓存安装。 @@ -217,18 +217,18 @@ envd-quick-start http://localhost:42779 envd-quick-start.envd /home/g ## 更多文档 📝 -访问[envd 文档](https://envd.tensorchord.ai/guide/getting-started.html)。 +访问 [envd 文档](../guide/getting-started)。 ## 路线图 🗂️ -我们的路线图在这里 [ROADMAP](https://envd.tensorchord.ai/community/roadmap.html)。 +我们的路线图在这里 [ROADMAP](../community/roadmap)。 ## 为 `envd` 贡献 😊 我们欢迎来自开源社区、个人和合作伙伴的各种贡献。 -- 加入我们的[Discord 社区](https://discord.gg/KqswhpVgdU)! -- 从源码构建可以阅读我们的[贡献指南](https://envd.tensorchord.ai/community/contributing.html) 和[开发教程](https://envd.tensorchord.ai/developers/development.html). +- 加入我们的 [Discord 社区](https://discord.gg/KqswhpVgdU)! +- 从源码构建可以阅读我们的[贡献指南](../community/contributing)和[开发教程](../developers/development). 利用 Gitpod 来开发：[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/tensorchord/envd) diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index ac620e1..e703030 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -68,9 +68,9 @@ def tensorboard(envd_port=6006, envd_dir="/home/envd/logs", ``` -⏱️ **Builtkit native, build up to 6x faster** +⏱️ **BuiltKit native, build up to 6x faster** -[Buildkit](https://github.com/moby/buildkit) supports parallel builds and software cache (e.g. pip index cache and apt cache). You can enjoy the benefits without knowledge of it. +[BuildKit](https://github.com/moby/buildkit) supports parallel builds and software cache (e.g. pip index cache and apt cache). You can enjoy the benefits without knowledge of it. For example, the PyPI cache is shared across builds and thus the package will be cached if it has been downloaded before. @@ -209,18 +209,18 @@ envd-quick-start http://localhost:42779 envd-quick-start.envd /home/g ## More on documentation 📝 -See [envd documentation](https://envd.tensorchord.ai/guide/getting-started.html). +See [envd documentation](../guide/getting-started). ## Roadmap 🗂️ -Please checkout [ROADMAP](https://envd.tensorchord.ai/community/roadmap.html). +Please check out [ROADMAP](../community/roadmap). ## Contribute 😊 We welcome all kinds of contributions from the open-source community, individuals, and partners. - Join our [discord community](https://discord.gg/KqswhpVgdU)! -- To build from the source, please read our [contributing documentation](https://envd.tensorchord.ai/community/contributing.html) and [development tutorial](https://envd.tensorchord.ai/developers/development.html). +- To build from the source, please read our [contributing documentation](../community/contributing) and [development tutorial](../developers/development). Develop with gitpod: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/tensorchord/envd)