Merge pull request #11 from zanyzhao/en-us

feat: 文档国际化 #10
- 先适配目录和Readme国际化

README.md

@@ -1,24 +1,24 @@
 ---
-description: BKCI 是一个免费并开源的 CI 服务，可助你自动化构建-测试-发布工作流，持续、快速、高质量地交付你的产品。
+description: a free & open source CI server, bk-ci(BlueKing Continuous Integration) helps you automate your build-test-release workflows, continuous delivery of your product faster, easier, with fewer bugs.
 ---
 
-# 首页
+# Navigation
 
 
-| 🐤 了解基本概念 | 👉 使用 BKCI | 🚀 部署 BKCI |
+| 🐤 Concepts | 👉 Use BKCI | 🚀 Deploy BKCI |
 | :--- | :--- | :--- |
-| [BKCI 是什么？](overview/what-is-bkci.md) | [创建你的第一条流水线](tutorials/create-first-pipeline.md) | [运行 BKCI 的学习环境](setup/run-bkci-in-one-docker.md) |
-| [BKCI 组件](overview/components.md) | [关联你的第一个代码库](tutorials/link-first-repo.md) | [在蓝鲸社区版中使用 BKCI](setup/run-bkci-in-prod/on-bkce.md) |
-| [快速熟悉流水线](overview/learn-pipeline-in-5-min.md) | [为你的Git工程开启CI](tutorials/enable-git-ci.md) | [BKCI 规格要求](setup/system-requirements/) |
-| [术语解释](overview/terminology/) | [示例](tutorials/examples/) |  |
+| [What is BKCI ?](overview/what-is-bkci.md) | [Create your first pipeline](tutorials/create-first-pipeline.md) | [Run bkci in docker](setup/run-bkci-in-one-docker.md) |
+| [Componets](overview/components.md) | [Link your first repository to bkci](tutorials/link-first-repo.md) | [Run bkci in blueking](setup/run-bkci-in-prod/on-bkce.md) |
+| [Learn pipeline in 5 minitues](overview/learn-pipeline-in-5-min.md) | [Run bkci in your git repository ](tutorials/enable-git-ci.md) | [System-requirments](setup/system-requirements/) |
+| [Terminology](overview/terminology/) | [Examples](tutorials/examples/) |  |
 
-| 📔 产品功能 | 🏪 研发商店 | 🤝 一起共建 BKCI |
+| 📔 Productions | 🏪 CI Store | 🤝 Contribute |
 | :--- | :--- | :--- |
-| [流水线](services/pipelines/) | [浏览研发商店](store/store-home.md) | [BKCI 架构](contribute/architecture.md) |
-| [控制台](services/console.md) | [开发一个流水线插件](store/plugins/create-plugin/) | [BKCI 代码结构](contribute/code-framework.md) |
-| [凭证管理](services/ticket.md) | [在 BKCI 里使用商店插件](store/plugins/upload-plugin.md) | [设计理念](contribute/design.md) |
-| [构建资源](services/pools/) |  |  |
+| [Pipelines](services/pipelines/) | [Explore ci store](store/store-home.md) | [Architecture](contribute/architecture.md) |
+| [Console](services/console.md) | [Develop a ci plugin](store/plugins/create-plugin/) | [Code framework](contribute/code-framework.md) |
+| [Ticket](services/ticket.md) | [Upload a plugin to bkci](store/plugins/upload-plugin.md) | [Design](contribute/design.md) |
+| [Pools](services/pools/) |  |  |
 
-# 文档共建
+# How to contribute a document ?
 
 * [CONTRIBUTING](contribute/document.md)

SUMMARY.md

@@ -1,89 +1,89 @@
 # Table of contents
 
-* [首页](README.md)
+* [Home](README.md)
 
-## 🐤 了解基本概念 <a href="#overview" id="overview"></a>
+## 🐤 Learn concepts <a href="#overview" id="overview"></a>
 
-* [BKCI 是什么？](overview/what-is-bkci.md)
-* [BKCI 组件](overview/components.md)
-* [5分钟读懂 BKCI 流水线](overview/learn-pipeline-in-5-min.md)
-* [术语解释](overview/terminology/README.md)
+* [What is BKCI ?](overview/what-is-bkci.md)
+* [Componets](overview/components.md)
+* [Learn pipeline in 5 minitues](overview/learn-pipeline-in-5-min.md)
+* [Terminology](overview/terminology/README.md)
   * [Pipelines](overview/terminology/pipelines.md)
   * [Stage](overview/terminology/stage.md)
   * [Job](overview/terminology/job.md)
   * [Task](overview/terminology/task.md)
   * [Trigger](overview/terminology/trigger/README.md)
-    * [github事件触发](overview/terminology/trigger/github.md)
+    * [github trigger](overview/terminology/trigger/github.md)
   * [Variables](overview/terminology/variables.md)
 
-## 👉 使用 BKCI <a href="#tutorials" id="tutorials"></a>
+## 👉 Use BKCI <a href="#tutorials" id="tutorials"></a>
 
-* [创建你的第一条流水线](tutorials/create-first-pipeline.md)
-* [关联你的第一个代码库](tutorials/link-first-repo.md)
-* [为你的Git工程开启CI](tutorials/enable-git-ci.md)
-* [示例](tutorials/examples/README.md)
-  * [代码拉取+制品上传+制品下载](tutorials/examples/pull-upload-download.md)
-  * [流水线触发方式使用](tutorials/examples/different-triggers.md)
-  * [流水线变量使用](tutorials/examples/vars-usage.md)
-  * [使用模板创建流水线](tutorials/examples/create-pipeline-by-template.md)
-  * [流水线条件判断](tutorials/examples/condition-stage.md)
-  * [子流水线](tutorials/examples/children-pipeline.md)
+* [Create your first pipeline](tutorials/create-first-pipeline.md)
+* [Link your first repository to bkci](tutorials/link-first-repo.md)
+* [Run bkci in your git repository](tutorials/enable-git-ci.md)
+* [Examples](tutorials/examples/README.md)
+  * [Checkout-Build-Upload](tutorials/examples/pull-upload-download.md)
+  * [Use different triggers in your pipeline](tutorials/examples/different-triggers.md)
+  * [Use variables in your pipeline](tutorials/examples/vars-usage.md)
+  * [Create pipeline by templates](tutorials/examples/create-pipeline-by-template.md)
+  * [Run pipeline with condition](tutorials/examples/condition-stage.md)
+  * [Call sub-pipeline](tutorials/examples/children-pipeline.md)
   * [Java Maven Demo](tutorials/examples/java-maven-demo.md)
   * [Node Demo](tutorials/examples/node-demo.md)
 
 
-## 🚀 部署 BKCI <a href="#setup" id="setup"></a>
+## 🚀 Deploy BKCI <a href="#setup" id="setup"></a>
 
-* [BKCI 系统要求](setup/system-requirements/README.md)
-  * [BKCI 硬件规格指南](setup/system-requirements/hardware-specifications.md)
-* [使用 One-Docker 运行 BKCI 的学习环境](setup/run-bkci-in-one-docker.md)
-* [在生产环境中运行 BKCI](setup/run-bkci-in-prod/README.md)
-  * [将 BKCI 一键部署至腾讯云](setup/run-bkci-in-prod/on-tencentcloud.md)
-  * [在蓝鲸社区版中部署 BKCI](setup/run-bkci-in-prod/on-bkce.md)
+* [System-requirments](setup/system-requirements/README.md)
+  * [Hardware-specifications](setup/system-requirements/hardware-specifications.md)
+* [Run BKCI in One-Docker](setup/run-bkci-in-one-docker.md)
+* [Run BKCI in your production environment](setup/run-bkci-in-prod/README.md)
+  * [Deploy BKCI to TencentCloud](setup/run-bkci-in-prod/on-tencentcloud.md)
+  * [Deploy BKCI with BlueKing](setup/run-bkci-in-prod/on-bkce.md)
 
-## 📔 产品功能 <a href="#services" id="services"></a>
+## 📔 Production Documents <a href="#services" id="services"></a>
 
-* [控制台](services/console.md)
-* [流水线](services/pipelines/README.md)
-  * [流水线触发方式](services/pipelines/pipeline-triggers/README.md)
-    * [手动触发](services/pipelines/pipeline-triggers/pipeline-trigger-manual.md)
-    * [远程触发](services/pipelines/pipeline-triggers/pipeline-trigger-remote.md)
-    * [定时器触发](services/pipelines/pipeline-triggers/pipeline-trigger-timer.md)
-    * [gitlab触发](services/pipelines/pipeline-triggers/pipeline-trigger-gitlab.md)
-  * [流水线列表页](services/pipelines/pipeline-list.md)
-  * [流水线执行历史](services/pipelines/pipeline-build-history.md)
-  * [创建/编辑流水线](services/pipelines/pipeline-edit/README.md)
-    * [流水线图形化编排](services/pipelines/pipeline-edit/gui.md)
-    * [为流水线开启自定义构建号](services/pipelines/pipeline-edit/alias-buildno.md)
-    * [锁定流水线](services/pipelines/pipeline-edit/disable-pipeline.md)
-  * [流水线任务详情页](services/pipelines/pipeline-build-detail/README.md)
-    * [流水线状态信息汇总](services/pipelines/pipeline-build-detail/status.md)
-  * [流水线变量](services/pipelines/pipeline-variables/README.md)
-    * [变量的基本使用](services/pipelines/pipeline-variables/pipeline-variables-shell-batch.md)
-    * [使用变量控制流水线流程](services/pipelines/pipeline-variables/pipeline-variables-flow-control.md)
-    * [使用备注变量](services/pipelines/pipeline-variables/pipeline-variables-remark.md)
-    * [凭证变量](services/pipelines/pipeline-variables/pipeline-variables-ticket.md)
-* [构建资源](services/pools/README.md)
-  * [将你的构建机托管至 BKCI](services/pools/self-hosted-agents/README.md)
-    * [第三方构建机环境准备](services/pools/self-hosted-agents/prepara-agent.md)
-    * [导入Windows构建机](services/pools/self-hosted-agents/windows/README.md)
-      * [windows agent启动界面程序的解决办法](services/pools/self-hosted-agents/windows/run-ui.md)
-  * [构建机详情页](services/pools/agent-detail.md)
-* [凭证管理](services/ticket.md)
-* [代码库](services/repo.md)
-* [编译加速](services/turbo/README.md)
-  * [Linux C/C++ 编译加速](services/turbo/linux\_c\_c++/README.md)
-    * [定制Linux C/C++加速方案](services/turbo/linux\_c\_c++/new\_plan.md)
+* [Console](services/console.md)
+* [Pipelines](services/pipelines/README.md)
+  * [Triggers](services/pipelines/pipeline-triggers/README.md)
+    * [Manual triggers](services/pipelines/pipeline-triggers/pipeline-trigger-manual.md)
+    * [Remote triggers](services/pipelines/pipeline-triggers/pipeline-trigger-remote.md)
+    * [Scheduled triggers](services/pipelines/pipeline-triggers/pipeline-trigger-timer.md)
+    * [Gitlab Webhook](services/pipelines/pipeline-triggers/pipeline-trigger-gitlab.md)
+  * [Pipeline list](services/pipelines/pipeline-list.md)
+  * [Pipeline build history](services/pipelines/pipeline-build-history.md)
+  * [Create/Edit a pipeline](services/pipelines/pipeline-edit/README.md)
+    * [Pipeline GUI](services/pipelines/pipeline-edit/gui.md)
+    * [Alias a Build No.](services/pipelines/pipeline-edit/alias-buildno.md)
+    * [Lock pipelines](services/pipelines/pipeline-edit/disable-pipeline.md)
+  * [Pipeline build detail](services/pipelines/pipeline-build-detail/README.md)
+    * [About status](services/pipelines/pipeline-build-detail/status.md)
+  * [Variables](services/pipelines/pipeline-variables/README.md)
+    * [Define variables](services/pipelines/pipeline-variables/pipeline-variables-shell-batch.md)
+    * [Control your pipeline with variables](services/pipelines/pipeline-variables/pipeline-variables-flow-control.md)
+    * [Set a build remark](services/pipelines/pipeline-variables/pipeline-variables-remark.md)
+    * [Use secrets from ticket](services/pipelines/pipeline-variables/pipeline-variables-ticket.md)
+* [Pools](services/pools/README.md)
+  * [Self-hosted agents](services/pools/self-hosted-agents/README.md)
+    * [Prepara a self-hosted agents](services/pools/self-hosted-agents/prepara-agent.md)
+    * [Self-hosted Windows agents](services/pools/self-hosted-agents/windows/README.md)
+      * [Enables GUI in a Windows agent](services/pools/self-hosted-agents/windows/run-ui.md)
+  * [Agent detail](services/pools/agent-detail.md)
+* [Ticket](services/ticket.md)
+* [Repository](services/repo.md)
+* [Turbo](services/turbo/README.md)
+  * [Use Turbo on Linux C/C++](services/turbo/linux\_c\_c++/README.md)
+    * [定制Linux C/C++加速方案](services/turbo/linux\_c\_c++/new_plan.md)
     * [在流水线中进行编译加速](services/turbo/linux\_c\_c++/use\_in\_pipeline.md)
     * [在私有构建机上使用加速](services/turbo/linux\_c\_c++/use\_in\_local.md)
-* [代码检查](services/codecc/README.md)
-  * [代码检查使用](services/codecc/codecc-usage.md)
-  * [代码检查配置](services/codecc/codecc-config.md)
-  * [代码检查结果](services/codecc/codecc-result.md)
-  * [代码检查规则](services/codecc/codecc-ruleset.md)
+* [CodeCC](services/codecc/README.md)
+  * [QuickStart](services/codecc/codecc-usage.md)
+  * [Config a CodeCC task](services/codecc/codecc-config.md)
+  * [View CodeCC Reports](services/codecc/codecc-result.md)
+  * [Use ruleset](services/codecc/codecc-ruleset.md)
   * [代码检查部署所需资源](services/codecc/codecc-cost.md)
 
-## 🏪 研发商店 <a href="#store" id="store"></a>
+## 🏪 CI Store <a href="#store" id="store"></a>
 
 * [浏览研发商店](store/store-home.md)
 * [流水线模板](store/pipeline-templates.md)
@@ -234,7 +234,7 @@
   * [WEBHOOK-代码事件触发](reference/rest-api/code-event-trigger/README.md)
     * [获取流水线的webhook构建日志列表](reference/rest-api/code-event-trigger/get-the-pipelines-webhook-build-log-list.md)
     * [获取流水线的webhook列表](reference/rest-api/code-event-trigger/get-the-webhook-list-of-the-pipeline.md)
-* [数据库设计文档](reference/DB-doc/README.md)
+* [Database schema](reference/DB-doc/README.md)
   * [devops\_ci\_auth](reference/DB-doc/devops\_ci\_auth.md)
   * [devops\_ci\_sign](reference/DB-doc/devops\_ci\_sign.md)
   * [devops\_ci\_artifactory](reference/DB-doc/devops\_ci\_artifactory.md)
@@ -253,16 +253,16 @@
   * [devops\_ci\_ticket](reference/DB-doc/devops\_ci\_ticket.md)
   * [devops\_ci\_process](reference/DB-doc/devops\_ci\_process.md)
   * [devops\_ci\_measure](reference/DB-doc/devops\_ci\_measure.md)
-* [预定义变量列表](reference/pre-define-var/README.md)
-  * [gitlab事件触发](reference/pre-define-var/gitlab.md)
+* [Pre-define variables](reference/pre-define-var/README.md)
+  * [variables in gitlab trigger](reference/pre-define-var/gitlab.md)
 * [FAQS](reference/faqs/README.md)
-  * [流水线FAQ](reference/faqs/pipeline-faqs.md)
-  * [代码检查FAQ](reference/faqs/codecc-faqs.md)
-  * [编译加速FAQ](reference/faqs/turbo-faqs.md)
-  * [已知问题](reference/faqs/known-issues.md)
-* [系统限制](reference/limit/README.md)
-  * [流水线复杂度限制](reference/limit/pipeline-limit.md)
+  * [Pipeline faq](reference/faqs/pipeline-faqs.md)
+  * [CodeCC FAQ](reference/faqs/codecc-faqs.md)
+  * [Turbo FAQ](reference/faqs/turbo-faqs.md)
+  * [Known issues](reference/faqs/known-issues.md)
+* [Limit](reference/limit/README.md)
+  * [pipelines](reference/limit/pipeline-limit.md)
 
 ***
 
-* [返回 BKCI 官网](https://bkci.net)
+* [Back to BKCI website](https://bkci.net)