Skip to content

Commit 4f36d61

Browse files
LucilleHLucilleH
committed
change discord links
1 parent 567706a commit 4f36d61

File tree

3 files changed

+113
-114
lines changed

3 files changed

+113
-114
lines changed

‎README.md‎

Lines changed: 38 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88

99
### Instant, easy, and predictable development environments
1010

11-
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/agbskCJXk2) ![License: Apache 2.0](https://img.shields.io/github/license/jetify-com/devbox) [![version](https://img.shields.io/github/v/release/jetify-com/devbox?color=green&label=version&sort=semver)](https://github.com/jetify-com/devbox/releases) [![tests](https://github.com/jetify-com/devbox/actions/workflows/cli-post-release.yml/badge.svg)](https://github.com/jetify-com/devbox/actions/workflows/cli-release.yml?branch=main) [![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
11+
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/jetify) ![License: Apache 2.0](https://img.shields.io/github/license/jetify-com/devbox) [![version](https://img.shields.io/github/v/release/jetify-com/devbox?color=green&label=version&sort=semver)](https://github.com/jetify-com/devbox/releases) [![tests](https://github.com/jetify-com/devbox/actions/workflows/cli-post-release.yml/badge.svg)](https://github.com/jetify-com/devbox/actions/workflows/cli-release.yml?branch=main) [![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
1212

1313
## What is it?
1414

1515
[Devbox](https://www.jetify.com/devbox/) is a command-line tool that lets you easily create isolated shells for development. You start by defining the list of packages required by your development environment, and devbox uses that definition to create an isolated environment just for your application.
1616

1717
In practice, Devbox works similar to a package manager like `yarn` – except the packages it manages are at the operating-system level (the sort of thing you would normally install with `brew` or `apt-get`). With Devbox, you can install over [400,000 package versions](https://www.nixhub.io) from the Nix Package Registry
1818

19-
Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`.
19+
Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`.
2020

2121
## Demo
2222

@@ -61,11 +61,11 @@ Are you working on multiple projects, all of which need different versions of th
6161
Devbox's dev environments are _portable_. We make it possible to declare your
6262
environment exactly once, and use that single definition in several different ways, including:
6363

64-
+ A local shell created through `devbox shell`
65-
+ A devcontainer you can use with VSCode
66-
+ A Dockerfile so you can build a production image with the exact same tools you
67-
used for development.
68-
+ A remote development environment in the cloud that mirrors your local environment.
64+
- A local shell created through `devbox shell`
65+
- A devcontainer you can use with VSCode
66+
- A Dockerfile so you can build a production image with the exact same tools you
67+
used for development.
68+
- A remote development environment in the cloud that mirrors your local environment.
6969

7070
## Quickstart: Fast, Deterministic Shell
7171

@@ -75,57 +75,55 @@ In this quickstart we’ll create a development shell with specific tools instal
7575

7676
2. Initialize Devbox:
7777

78-
```bash
79-
devbox init
80-
```
78+
```bash
79+
devbox init
80+
```
8181

82-
This creates a `devbox.json` file in the current directory. You should commit it to source control.
82+
This creates a `devbox.json` file in the current directory. You should commit it to source control.
8383

8484
3. Add command-line tools from Nix. For example, to add Python 3.10:
8585

86-
```bash
87-
devbox add python@3.10
88-
```
86+
```bash
87+
devbox add python@3.10
88+
```
8989

90-
Search for more packages on [Nixhub.io](https://www.nixhub.io)
90+
Search for more packages on [Nixhub.io](https://www.nixhub.io)
9191

9292
4. Your `devbox.json` file keeps track of the packages you've added, it should now look like this:
9393
94-
```json
95-
{
96-
"packages": [
97-
"python@3.10"
98-
]
99-
}
100-
```
94+
```json
95+
{
96+
"packages": ["python@3.10"]
97+
}
98+
```
10199
102100
5. Start a new shell that has these tools installed:
103101
104-
```bash
105-
devbox shell
106-
```
102+
```bash
103+
devbox shell
104+
```
107105
108-
You can tell you’re in a Devbox shell (and not your regular terminal) because the shell prompt changed.
106+
You can tell you’re in a Devbox shell (and not your regular terminal) because the shell prompt changed.
109107
110108
6. Use your favorite tools.
111109
112-
In this example we installed Python 3.10, so let’s use it.
110+
In this example we installed Python 3.10, so let’s use it.
113111
114-
```bash
115-
python --version
116-
```
112+
```bash
113+
python --version
114+
```
117115
118116
7. Your regular tools are also available including environment variables and config settings.
119117
120-
```bash
121-
git config --get user.name
122-
```
118+
```bash
119+
git config --get user.name
120+
```
123121
124122
8. To exit the Devbox shell and return to your regular shell:
125123
126-
```bash
127-
exit
128-
```
124+
```bash
125+
exit
126+
```
129127
130128
Read more on the [Devbox docs Quickstart](https://www.jetify.com/devbox/docs/quickstart/).
131129
@@ -137,9 +135,9 @@ See the [CLI Reference](https://www.jetify.com/devbox/docs/cli_reference/devbox/
137135
138136
## Join our Developer Community
139137
140-
+ Chat with us by joining the [Jetify Discord Server](https://discord.gg/jetify) – we have a #devbox channel dedicated to this project.
141-
+ File bug reports and feature requests using [Github Issues](https://github.com/jetify-com/devbox/issues)
142-
+ Follow us on [Jetify's Twitter](https://twitter.com/jetify_com) for product updates
138+
- Chat with us by joining the [Jetify Discord Server](https://discord.gg/jetify) – we have a #devbox channel dedicated to this project.
139+
- File bug reports and feature requests using [Github Issues](https://github.com/jetify-com/devbox/issues)
140+
- Follow us on [Jetify's Twitter](https://twitter.com/jetify_com) for product updates
143141

144142
## Contributing
145143

@@ -153,7 +151,7 @@ Thanks to [Nix](https://nixos.org/) for providing isolated shells.
153151

154152
## Translation
155153

156-
+ [Chinese](./docs/translation/README-zh-CN.md)
154+
- [Chinese](./docs/translation/README-zh-CN.md)
157155

158156
## License
159157

‎docs/app/docusaurus.config.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ const config = {
7676
label: "Docs"
7777
},
7878
{
79-
href: 'https://discord.gg/agbskCJXk2',
79+
href: 'https://discord.gg/jetify',
8080
// label: 'Discord',
8181
className: 'header-discord-link',
8282
position: 'right',
@@ -128,7 +128,7 @@ const config = {
128128
href: "https://twitter.com/jetify_com"
129129
},
130130
{
131-
href: 'https://discord.gg/agbskCJXk2',
131+
href: 'https://discord.gg/jetify',
132132
label: 'Discord',
133133
},
134134
{

‎docs/translation/README-zh-CN.md‎

Lines changed: 73 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,164 +1,165 @@
11
# Devbox 📦
22

3-
### 即时、简单、可预测地创建Shell与Container
3+
### 即时、简单、可预测地创建 Shell 与 Container
44

5-
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/agbskCJXk2) ![License: Apache 2.0](https://img.shields.io/github/license/jetify-com/devbox) [![version](https://img.shields.io/github/v/release/jetify-com/devbox?color=green&label=version&sort=semver)](https://github.com/jetify-com/devbox/releases) [![tests](https://github.com/jetify-com/devbox/actions/workflows/tests.yaml/badge.svg)](https://github.com/jetify-com/devbox/actions/workflows/tests.yaml)
5+
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/jetify) ![License: Apache 2.0](https://img.shields.io/github/license/jetify-com/devbox) [![version](https://img.shields.io/github/v/release/jetify-com/devbox?color=green&label=version&sort=semver)](https://github.com/jetify-com/devbox/releases) [![tests](https://github.com/jetify-com/devbox/actions/workflows/tests.yaml/badge.svg)](https://github.com/jetify-com/devbox/actions/workflows/tests.yaml)
66

77
---
88

99
## 它是什么?
1010

11-
Devbox是一个可以让你轻松地创建隔离环境的shell与container的命令行工具。首先定义你开发环境中所需的软件包列表，随后Devbox使用该定义来为你的应用程序创建一个隔离的环境。
11+
Devbox 是一个可以让你轻松地创建隔离环境的 shell 与 container 的命令行工具。首先定义你开发环境中所需的软件包列表，随后 Devbox 使用该定义来为你的应用程序创建一个隔离的环境。
1212

13-
在实践中，Devbox的工作方式类似于像`yarn`这样的软件包管理器--只不过它所管理的软件包是操作系统级别的。（这些包你通常会通过`brew`和`apt-get`来进行安装）。
13+
在实践中，Devbox 的工作方式类似于像`yarn`这样的软件包管理器--只不过它所管理的软件包是操作系统级别的。（这些包你通常会通过`brew`和`apt-get`来进行安装）。
1414

15-
Devbox最初由[Jetify](https://www.jetify.com)进行开发，其内部由`nix`驱动。
15+
Devbox 最初由[Jetify](https://www.jetify.com)进行开发，其内部由`nix`驱动。
1616

1717
## 示例
18+
1819
下面的例子创建了一个带有`python 2.7`和`go 1.18`的开发环境，尽管这些包并没有在底层机器中被安装。
1920

2021
![screen cast](https://user-images.githubusercontent.com/279789/186491771-6b910175-18ec-4c65-92b0-ed1a91bb15ed.svg)
2122

22-
2323
## 好处
2424

25-
### 为团队中的每一个人提供一个统一的Shell
25+
### 为团队中的每一个人提供一个统一的 Shell
2626

27-
通过`devbox.json`文件来声明项目中所需要的工具列表，并运行`devbox shell`。这样，参与项目工作的每一个人都会获得一个与这些工具完全版本的shell环境。
27+
通过`devbox.json`文件来声明项目中所需要的工具列表，并运行`devbox shell`。这样，参与项目工作的每一个人都会获得一个与这些工具完全版本的 shell 环境。
2828

2929
### 尝试新工具而不污染原先配置的环境
3030

31-
由Devbox创建的开发环境与你的笔记本电脑中的其他东西是隔离的。有什么工具你想尝试，却又不想把环境弄得一团糟？可以把这个工具添加到Devbox的shell中，而当你不再需要它的时候，就可以把它删除--同时保持你的笔记本电脑始终是原始的状态。
31+
由 Devbox 创建的开发环境与你的笔记本电脑中的其他东西是隔离的。有什么工具你想尝试，却又不想把环境弄得一团糟？可以把这个工具添加到 Devbox 的 shell 中，而当你不再需要它的时候，就可以把它删除--同时保持你的笔记本电脑始终是原始的状态。
3232

3333
### 不以牺牲速度为代价
3434

35-
Devbox可以在你的笔记本电脑上直接创建隔离环境，而不需要额外的虚拟化以至于使得你的文件系统或每个命令都变得缓慢。当你准备打包时，就可以把它变成一个等效的container。
35+
Devbox 可以在你的笔记本电脑上直接创建隔离环境，而不需要额外的虚拟化以至于使得你的文件系统或每个命令都变得缓慢。当你准备打包时，就可以把它变成一个等效的 container。
3636

3737
### 同版本冲突说再见
3838

3939
你是否正在处理多个项目，而所有这些项目都需要同一个二进制文件的不同版本？与其尝试在你的笔记本电脑上安装同一二进制文件的冲突版本，不如为每个项目创建一个隔离环境，并为每个项目使用你想要的任何版本。
4040

4141
### 瞬间将你的应用程序变成一个容器
4242

43-
Devbox分析你的源代码并立即将其转化为可以部署到任何云中、并符合OCI标准的镜像。该镜像在速度、大小、安全和缓存方面都进行了优化......而且不需要编写`Dockerfile`。而且与[buildpacks](https://buildpacks.io/)不同的是，devbox处理起来更快。
43+
Devbox 分析你的源代码并立即将其转化为可以部署到任何云中、并符合 OCI 标准的镜像。该镜像在速度、大小、安全和缓存方面都进行了优化......而且不需要编写`Dockerfile`。而且与[buildpacks](https://buildpacks.io/)不同的是，devbox 处理起来更快。
4444

4545
### 不要再重复声明依赖关系
4646

47-
当你在笔记本电脑上开发时，以及当你把它打包成一个容器准备部署到云端时，你的应用程序往往需要相同的依赖关系集。Devbox的开发环境是同构的：这意味着我们可以把它们变成本地的Shell环境或云端的container，所有这些都不需要重复完成。
47+
当你在笔记本电脑上开发时，以及当你把它打包成一个容器准备部署到云端时，你的应用程序往往需要相同的依赖关系集。Devbox 的开发环境是同构的：这意味着我们可以把它们变成本地的 Shell 环境或云端的 container，所有这些都不需要重复完成。
4848

49-
## 安装Devbox
49+
## 安装 Devbox
5050

51-
除了安装Devbox本身之外，你还需要安装`nix`和`docker`，因为Devbox依赖于它们。
51+
除了安装 Devbox 本身之外，你还需要安装`nix`和`docker`，因为 Devbox 依赖于它们。
5252

53-
1. 安装 [Nix Package Manager](https://nixos.org/download.html)。(别担心，你不需要学习Nix。)
53+
1. 安装 [Nix Package Manager](https://nixos.org/download.html)。(别担心，你不需要学习 Nix。)
5454

55-
2. 安装[Docker Engine](https://docs.docker.com/engine/install/)或[Docker Desktop](https://www.docker.com/get-started/)。注意，只有当你想创建容器时才需要docker--如果没有它，shell功能也能工作。
55+
2. 安装[Docker Engine](https://docs.docker.com/engine/install/)或[Docker Desktop](https://www.docker.com/get-started/)。注意，只有当你想创建容器时才需要 docker--如果没有它，shell 功能也能工作。
5656

57-
3. 安装Devbox:
57+
3. 安装 Devbox:
5858

59-
```sh
60-
curl -fsSL https://get.jetify.com/devbox | bash
61-
```
59+
```sh
60+
curl -fsSL https://get.jetify.com/devbox | bash
61+
```
6262

63-
## 快速入门：快速又确定的shell
63+
## 快速入门：快速又确定的 shell
6464

65-
在这个快速入门中，我们将创建一个安装了特定工具的开发shell。这些工具只有在使用这个Devbox shell时才能使用，以确保我们不会污染你的机器。
65+
在这个快速入门中，我们将创建一个安装了特定工具的开发 shell。这些工具只有在使用这个 Devbox shell 时才能使用，以确保我们不会污染你的机器。
6666

6767
1. 在一个新的空文件夹中打开一个终端。
6868

69-
2. 初始化Devbox:
69+
2. 初始化 Devbox:
70+
71+
```bash
72+
devbox init
73+
```
7074

71-
```bash
72-
devbox init
73-
```
75+
这将在当前目录下创建一个`devbox.json`文件。你应该把它提交到源码控制里。
7476

75-
这将在当前目录下创建一个`devbox.json`文件。你应该把它提交到源码控制里。
77+
3. 从[Nix Packages](https://search.nixos.org/packages)添加命令行工具。例如，要添加 Python 3.10：
7678

77-
3. 从[Nix Packages](https://search.nixos.org/packages)添加命令行工具。例如，要添加Python 3.10：
79+
```bash
80+
devbox add python310
81+
```
7882

79-
```bash
80-
devbox add python310
81-
```
8283
4. 你的`devbox.json`文件记录了你所添加的软件包，它现在应该看起来是这样的：
8384

84-
```json
85-
{
86-
"packages": [
87-
"python310"
88-
]
89-
}
90-
```
85+
```json
86+
{
87+
"packages": ["python310"]
88+
}
89+
```
9190

92-
5. 启动一个安装了这些工具的新shell：
91+
5. 启动一个安装了这些工具的新 shell：
9392

94-
```bash
95-
devbox shell
96-
```
93+
```bash
94+
devbox shell
95+
```
9796

98-
你可以看出你是在Devbox shell中（而不是你的普通终端），因为shell的提示和目录已经改变。
97+
你可以看出你是在 Devbox shell 中（而不是你的普通终端），因为 shell 的提示和目录已经改变。
9998

10099
6. 使用你喜欢的工具。
101100

102-
In this example we installed Python 3.10, so let’s use it.
101+
In this example we installed Python 3.10, so let’s use it.
103102

104-
```bash
105-
python --version
106-
```
103+
```bash
104+
python --version
105+
```
107106

108107
7. 你的常规工具也是可用的，包括环境变量和配置设置。
109108

110-
```bash
111-
git config --get user.name
112-
```
109+
```bash
110+
git config --get user.name
111+
```
113112

114-
8. 要退出Devbox shell并返回到你的常规shell：
113+
8. 要退出 Devbox shell 并返回到你的常规 shell：
115114

116-
```bash
117-
exit
118-
```
115+
```bash
116+
exit
117+
```
119118

120-
## 快速入门：迅速的Docker镜像
119+
## 快速入门：迅速的 Docker 镜像
121120

122-
Devbox使得将你的应用程序打包成一个符合OCI标准的容器镜像变得很容易。Devbox会分析你的代码，自动识别你的项目所需的正确工具链，并将其构建为一个docker镜像。
121+
Devbox 使得将你的应用程序打包成一个符合 OCI 标准的容器镜像变得很容易。Devbox 会分析你的代码，自动识别你的项目所需的正确工具链，并将其构建为一个 docker 镜像。
123122

124123
1. 使用`devbox init`来初始化你的项目，如果还未初始化的话。
125124

126125
2. 构建镜像:
127126

128-
```bash
129-
devbox build
130-
```
127+
```bash
128+
devbox build
129+
```
131130

132-
生成的镜像名叫 `devbox`.
131+
生成的镜像名叫 `devbox`.
133132

134133
3. 用一个更具体的名称来标记该镜像：
135134

136-
```bash
137-
docker tag devbox my-image:v0.1
138-
```
135+
```bash
136+
docker tag devbox my-image:v0.1
137+
```
138+
139139
### 自动检测的语言
140-
Devbox目前支持检测以下两种语言：
141140

142-
- Go
143-
- Python (Poetry)
141+
Devbox 目前支持检测以下两种语言：
142+
143+
- Go
144+
- Python (Poetry)
144145

145-
想要支持更多的语言？[Ask for a new Language](https://github.com/jetify-com/devbox/issues) 或通过Pull Request贡献一个。
146+
想要支持更多的语言？[Ask for a new Language](https://github.com/jetify-com/devbox/issues) 或通过 Pull Request 贡献一个。
146147

147148
## 额外命令
148149

149150
`devbox help` - 用来查看所有的命令
150151

151-
`devbox plan` - 用来查看Devbox在生成container时的配置与步骤
152+
`devbox plan` - 用来查看 Devbox 在生成 container 时的配置与步骤
152153

153154
## 加入我们的开发者社区
154155

155-
+ 通过加入[Jetify Discord Server](https://discord.gg/agbskCJXk2)来与我们聊天 - 我们有一个#devbox频道专门用于这个项目。
156-
+ 使用[Github Issues](https://github.com/jetify-com/devbox/issues)提交错误报告和功能请求。
157-
+ 在[Jetify’s Twitter](https://twitter.com/jetify_com)上关注我们的产品更新。
156+
- 通过加入[Jetify Discord Server](https://discord.gg/jetify)来与我们聊天 - 我们有一个#devbox 频道专门用于这个项目。
157+
- 使用[Github Issues](https://github.com/jetify-com/devbox/issues)提交错误报告和功能请求。
158+
- 在[Jetify’s Twitter](https://twitter.com/jetify_com)上关注我们的产品更新。
158159

159160
## 相关工作
160161

161-
感谢[Nix](https://nixos.org/)所提供的独立的shell。
162+
感谢[Nix](https://nixos.org/)所提供的独立的 shell。
162163

163164
## License
164165

0 commit comments

Comments
 (0)