Skip to content

en: translate sidebar and some user docs #127

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.

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

Merged
merged 2 commits into from
Sep 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "简介",
"label": "Introduction",
"position": 0
}
2 changes: 1 addition & 1 deletion docs/develop/build-docs/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "构建文档",
"label": "Build Doc",
"position": 2
}
2 changes: 1 addition & 1 deletion docs/develop/build-from-source/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "构建 Kusion",
"label": "Build Kusion",
"position": 2
}
2 changes: 1 addition & 1 deletion docs/develop/design/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "设计与实现",
"label": "Design and Implementation",
"position": 4
}
2 changes: 1 addition & 1 deletion docs/governance/contribute/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "贡献指南",
"label": "Contribution Guide",
"position": 4
}
2 changes: 1 addition & 1 deletion docs/governance/contribute/docs/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "文档规范",
"label": "Doc Style",
"position": 4
}
2 changes: 1 addition & 1 deletion docs/governance/intro/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "开源社区",
"label": "Community",
"position": 1
}
2 changes: 1 addition & 1 deletion docs/governance/release-policy/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "发版策略",
"label": "Release Policy",
"position": 3
}
2 changes: 1 addition & 1 deletion docs/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "参考手册",
"label": "Reference",
"position": 5
}
2 changes: 1 addition & 1 deletion docs/reference/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "命令行工具",
"label": "Command Line Tools",
"position": 1
}
2 changes: 1 addition & 1 deletion docs/reference/cli/kcl/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "KCL 语言工具",
"label": "KCL Tools",
"position": 2
}
2 changes: 1 addition & 1 deletion docs/reference/cli/kusionctl/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Kusion 工具",
"label": "Kusion Tools",
"position": 1
}
2 changes: 1 addition & 1 deletion docs/reference/cli/openapi/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "OpenAPI 工具",
"label": "OpenAPI Tools",
"position": 3
}
2 changes: 1 addition & 1 deletion docs/reference/konfig/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Konfig 配置大库",
"label": "Konfig",
"position": 4
}
2 changes: 1 addition & 1 deletion docs/reference/model/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Kusion 模型库",
"label": "Kusion Model Library",
"position": 3
}
2 changes: 1 addition & 1 deletion docs/reference/model/core/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "核心模型库",
"label": "Core Model Library",
"position": 2
}
2 changes: 1 addition & 1 deletion docs/user_docs/concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "架构 & 概念",
"label": "Architecture & Concept",
"position": 3
}
2 changes: 1 addition & 1 deletion docs/user_docs/concepts/arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 4
---

# Kusion 整体架构
# Kusion Architecture

架构图本质上反应的是 Kusion 的工作流程和工作机制。熟悉了整体架构图之后,同样能够做到纲举目张为 Kusion 的日常使用和开发提供指导。

Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/concepts/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 架构 & 概念
# Architecture & Concept

在直观体验过 Kusion 如何快速部署 Kubernetes 官方的 Guestbook 例子后,可以更深入理解 Kusion 可编程配置技术栈背后的架构和概念。其中用户界面展示了 Kusion 技术栈用户使用界面,Project & Stack 介绍了 Kusion 推荐的项目组织结构,State & Backends 则介绍了 Kusion 背后的状态管理和厚度存储设计。最后介绍了 Kusion 架构和 KCL 语言的特色和设计思路。
2 changes: 1 addition & 1 deletion docs/user_docs/concepts/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# 用户界面
# User Interface

## 1. 单 App 应用界面

Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "快速开始",
"label": "Get Started",
"position": 1
}
6 changes: 4 additions & 2 deletions docs/user_docs/getting-started/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 快速开始
# Get Started

Get started include a quick overview of the KCL configuration language, the Kusion model library and how to deploy CodeCity examples with KusionStack.


快速开始以最快流程对 [Kusion](/docs/user_docs/intro/kusion-intro) 有一个简单直观的体验,其中包含 Kusion 的快速安装、KCL 配置语言的速览、Kusion 模型库和如何通过 Kusion 工具快速部署 [Kubernetes](https://kubernetes.io) 官方的 [Guestbook](https://kubernetes.io/zh/docs/tutorials/stateless-application/guestbook) 例子。
2 changes: 1 addition & 1 deletion docs/user_docs/getting-started/install/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "下载和安装",
"label": "Download & Install",
"position": 1
}
27 changes: 13 additions & 14 deletions docs/user_docs/getting-started/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
sidebar_position: 2
---

# Kusion 的 Docker 镜像
# Docker

如果环境无法安装本地执行版本,可以选择 KusionStack 的 Docker 版本。首先在本地安装好 [Docker](https://www.docker.com/) 环境,并启动 Docker 服务。然后通过 `docker info` 命令验证本地的 Docker 服务已经正常启动。
If the environment do not supported, you can choose the Docker version of KusionStack. First install the [Docker](https://www.docker.com/) environment and start the Docker service. Then use the `docker info` command to verify that the Docker service has been started succeed.

Kusion 镜像的网址: https://hub.docker.com/r/kusionstack/kusion
KusionStack image: https://hub.docker.com/r/kusionstack/kusion

## 1. 拉取最新版本
## 1. Latest Version

通过以下命令拉取最新的版本:
Pull the latest version with the following command:

```shell
$ docker pull kusionstack/kusion
Expand All @@ -21,46 +21,45 @@ kusionstack/kusion:latest
$
```

然后通过以下命令查看 KCL 版本号:
Then use the following command to check the KCL version:

```shell
$ docker run --rm -it kusionstack/kusion kcl --version
kclvm version is 0.4.1; checksum: ***
$
```

## 2. 拉取指定版本
## 2. Custom Version

查看[镜像版本号列表](https://hub.docker.com/r/kusionstack/kusion/tags),或者通过以下命令拉取 kusion 最新镜像(Kusion镜像中包含KCL命令行工具):
Check the list of image [versions](https://hub.docker.com/r/kusionstack/kusion/tags) at first, pull the latest image of kusion with the following command (the Kusion image include the KCL command tools):

```shell
$ docker pull kusionstack/kusion
...
```

然后通过以下命令查看 KCL 版本号:
Then use the following command to check the KCL version:

```shell
$ docker run --rm -it kusionstack/kusion:v0.4.1 kcl --version
kclvm version is 0.4.1
$
```

## 3. 执行 KCL 代码
## 3. Run KCL

如果要验证执行 KCL 程序,可以先在当前目录创建一个 `hello.k` 文件,内容如下:
If you want to verify the execution of the KCL program, you can first create a `hello.k` file with the following content:

```python
hello = "world"
```

然后通过以下命令执行 `hello.k` 文件:
Then execute the `hello.k` file with the following command:

```shell
$ docker run --rm -it -v `pwd`:/root/hello.k kusionstack/kusion kcl /root/hello.k
hello: world
$
```

程序输出的YAML格式的 `hello: world` 数据,说明Docker环境的KCL已经可以正常工作了。

The output this the YAML format data, content is `hello: world`.
5 changes: 2 additions & 3 deletions docs/user_docs/getting-started/install/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# 下载和安装

可以通过 Kusionup 工具安装和管理本地 KusionStack 版本,也可以通过 KusionStack 的 Docker 镜像使用。
# Download & Install

KusionStack is installed and managed by the kusionup tool, or use KusionStack in Docker.
Loading