This is an automated email from the ASF dual-hosted git repository.
jark pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4e13ba1 [FLINK-11565][docs] Translate the "Improve the Website" page
into Chinese
4e13ba1 is described below
commit 4e13ba149feed3ac2dd5fc5e7964130c0dbc07ff
Author: klion26 <qcx978132...@gmail.com>
AuthorDate: Tue Feb 26 22:53:04 2019 +0800
[FLINK-11565][docs] Translate the "Improve the Website" page into Chinese
This closes #177
---
content/zh/improve-website.html | 92 ++++++++++++++++++++---------------------
improve-website.zh.md | 80 +++++++++++++++++------------------
2 files changed, 83 insertions(+), 89 deletions(-)
diff --git a/content/zh/improve-website.html b/content/zh/improve-website.html
index 4da8066..61a5845 100644
--- a/content/zh/improve-website.html
+++ b/content/zh/improve-website.html
@@ -152,119 +152,115 @@
<div class="col-sm-12">
<h1>改进网站</h1>
- <p>The <a href="http://flink.apache.org";>Apache Flink website</a>
presents Apache Flink and its community. It serves several purposes
including:</p>
+ <p><a href="http://flink.apache.org";>Apache Flink 官网</a> 介绍了 Apache
Flink 及其社区。包括如下多种用途：</p>
<ul>
- <li>Informing visitors about Apache Flink and its features.</li>
- <li>Encouraging visitors to download and use Flink.</li>
- <li>Encouraging visitors to engage with the community.</li>
+ <li>向来访者介绍 Apache Flink 及其特性。</li>
+ <li>鼓励来访者下载并使用 Flink。</li>
+ <li>鼓励来访者与社区进行互动。</li>
</ul>
-<p>We welcome any contribution to improve our website. This document contains
all information that is necessary to improve Flink’s website.</p>
+<p>我们欢迎任何改进官网的贡献。本文档包含了所有改进 Flink 官网所需要的信息。</p>
<div class="page-toc">
<ul id="markdown-toc">
- <li><a href="#obtain-the-website-sources"
id="markdown-toc-obtain-the-website-sources">Obtain the website sources</a></li>
- <li><a href="#directory-structure-and-files"
id="markdown-toc-directory-structure-and-files">Directory structure and
files</a></li>
- <li><a href="#update-or-extend-the-documentation"
id="markdown-toc-update-or-extend-the-documentation">Update or extend the
documentation</a></li>
- <li><a href="#submit-your-contribution"
id="markdown-toc-submit-your-contribution">Submit your contribution</a></li>
- <li><a href="#committer-section"
id="markdown-toc-committer-section">Committer section</a></li>
+ <li><a href="#section" id="markdown-toc-section">获取官网源码</a></li>
+ <li><a href="#section-1" id="markdown-toc-section-1">目录结构和文件</a></li>
+ <li><a href="#section-2" id="markdown-toc-section-2">更新文档</a></li>
+ <li><a href="#section-3" id="markdown-toc-section-3">提交你的贡献</a></li>
+ <li><a href="#committer-" id="markdown-toc-committer-">Committer 章节</a></li>
</ul>
</div>
-<h2 id="obtain-the-website-sources">Obtain the website sources</h2>
+<h2 id="section">获取官网源码</h2>
-<p>The website of Apache Flink is hosted in a dedicated <a
href="http://git-scm.com/";>git</a> repository which is mirrored to GitHub at <a
href="https://github.com/apache/flink-web";>https://github.com/apache/flink-web</a>.</p>
+<p>Apache Flink 官网的源码托管在专用的 <a href="http://git-scm.com/";>git</a> 仓库中，并在
Github 中有一个镜像 <a
href="https://github.com/apache/flink-web";>https://github.com/apache/flink-web</a>。</p>
-<p>The easiest way to contribute website updates is to fork <a
href="https://github.com/apache/flink-web";>the mirrored website repository on
GitHub</a> into your own GitHub account by clicking on the fork button at the
top right. If you have no GitHub account, you can create one for free.</p>
+<p>向官网贡献的最简单方式是通过单击右上角的 fork 按钮，将 [Github 上官网的镜像]
(https://github.com/apache/flink-web) 镜像到自己的仓库中。如果没有 Github 帐户，你可以免费创建一个。</p>
-<p>Next, clone your fork to your local machine.</p>
+<p>接下来，把你镜像的仓库克隆到本地机器上。</p>
<div class="highlight"><pre><code>git clone
https://github.com/<your-user-name>/flink-web.git
</code></pre></div>
-<p>The <code>flink-web</code> directory contains the cloned repository. The
website resides in the <code>asf-site</code> branch of the repository. Run the
following commands to enter the directory and switch to the
<code>asf-site</code> branch.</p>
+<p><code>flink-web</code> 目录包含了拷贝的仓库。官网的代码位于 <code>asf-site</code>
分支上。运行如下命令切换到 <code>asf-site</code> 分支</p>
<div class="highlight"><pre><code>cd flink-web
git checkout asf-site
</code></pre></div>
-<h2 id="directory-structure-and-files">Directory structure and files</h2>
+<h2 id="section-1">目录结构和文件</h2>
-<p>Flink’s website is written in <a
href="http://daringfireball.net/projects/markdown/";>Markdown</a>. Markdown is a
lightweight markup language which can be translated to HTML. We use <a
href="http://jekyllrb.com/";>Jekyll</a> to generate static HTML files from
Markdown.</p>
+<p>Flink 的官网是用 <a
href="http://daringfireball.net/projects/markdown/";>Markdown</a> 所编写。Markdown
是一种轻量级标记语言，可以翻译为 HTML。我们使用 <a href="http://jekyllrb.com/";>Jekyll</a> 生成静态 HTML
文件。</p>
-<p>The files and directories in the website git repository have the following
roles:</p>
+<p>官网仓库中的目录和文件组织如下：</p>
<ul>
- <li>All files ending with <code>.md</code> are Markdown files. These files
are translated into static HTML files.</li>
- <li>Regular directories (not starting with an underscore (<code>_</code>))
contain also <code>.md</code> files. The directory structure is reflected in
the generated HTML files and the published website.</li>
- <li>The <code>_posts</code> directory contains blog posts. Each blog post is
written as one Markdown file. To contribute a post, add a new file there.</li>
- <li>The <code>_includes/</code> directory contains includeable files such as
the navigation bar or the footer.</li>
- <li>The <code>docs/</code> directory contains copies of the documentation of
Flink for different releases. There is a directory inside <code>docs/</code>
for each stable release and the latest SNAPSHOT version. The build script is
taking care of the maintenance of this directory.</li>
- <li>The <code>content/</code> directory contains the generated HTML files
from Jekyll. It is important to place the files in this directory since the
Apache Infrastructure to host the Flink website is pulling the HTML content
from his directory. (For committers: When pushing changes to the website git,
push also the updates in the <code>content/</code> directory!)</li>
+ <li>所有文件以 <code>.md</code> 结尾。这些文件会被转换为静态 HTML 文件。</li>
+ <li>常规目录（不以下划线（<code>_</code>）开头）也包含以 <code>.md</code> 结尾的文件。目录结构最终会反映在生成的
HTML 文件和发布的网站上。</li>
+ <li><code>_posts</code> 目录下包含了所有的博客文章。每个 Markdown
文件是一篇博客。贡献新的博客，请添加一个新的文件。</li>
+ <li><code>_includes/</code> 目录包含可导入的文件，例如导航栏或页脚。</li>
+ <li><code>docs/</code> 目录包含不同版本的 Flink 文档。在 <code>docs/</code>
目录下包含了所有已经发布的版本文档，以及最新的预览版文档。构建脚本负责维护这个目录。</li>
+ <li><code>content/</code> 目录包含所有 Jekyll 生成的静态 HTML 文件。谨记一定要把文件放到该目录下，因为
Apache Infrastructure 会从该目录拉取 HTML 内容。（对于提交者：当推送对该网站仓库的更改时，也请推送
<code>content/</code> 目录的更新）。</li>
</ul>
-<h2 id="update-or-extend-the-documentation">Update or extend the
documentation</h2>
+<h2 id="section-2">更新文档</h2>
-<p>You can update and extend the website by modifying or adding Markdown files
or any other resources such as CSS files. To verify your changes start the
build script in preview mode.</p>
+<p>可以通过修改已有文档，或新增资源–比如 CSS 文件等方式对网站进行更新。想验证你的修改，可以执行如下命令：</p>
<div class="highlight"><pre><code>./build.sh -p
</code></pre></div>
-<p>The script compiles the Markdown files into HTML and starts a local
webserver. Open your browser at <code>http://localhost:4000</code> to view the
website including your changes. The served website is automatically re-compiled
and updated when you modify and save any file and refresh your browser.</p>
+<p>该脚本会把所有 Markdown 文件转换为 HTML 文件，并启动一个本地 web 服务器。打开浏览器并访问
<code>http://localhost:4000</code> 查看你的修改。当你重新修改并保存文件后，刷新浏览器可以看到最新的内容。</p>
-<p>Alternatively you can build the web site using Docker (without augmenting
your host environment):</p>
+<p>或者你可以使用 Docker 进行网站的构建（不增加主机环境）：</p>
<div class="highlight"><pre><code>docker run --rm
--volume="$PWD:/srv/flink-web" --expose=4000 -p 4000:4000 -it ruby:2.5 bash -c
'cd /srv/flink-web && ./build.sh -p'
</code></pre></div>
-<p>Please feel free to ask any questions you have on the developer mailing
list.</p>
+<p>如果有任何疑问，欢迎在开发者邮件列表中咨询。</p>
-<h2 id="submit-your-contribution">Submit your contribution</h2>
+<h2 id="section-3">提交你的贡献</h2>
-<p>The Flink project accepts website contributions through the <a
href="https://github.com/apache/flink-web";>GitHub Mirror</a> as <a
href="https://help.github.com/articles/using-pull-requests";>Pull Requests</a>.
Pull requests are a simple way of offering a patch by providing a pointer to a
code branch that contains the changes.</p>
+<p>Flink 项目通过 <a href="https://github.com/apache/flink-web";>GitHub Mirror</a>
以提交 <a href="https://help.github.com/articles/using-pull-requests";>Pull
Requests</a> 方式接受网站贡献。Pull requests 是一种通过向特定代码分支提交补丁的简单方法。</p>
-<p>To prepare and submit a pull request follow these steps.</p>
+<p>请按以下步骤操作准备并提交 pull request。</p>
<ol>
+ <li>将你的更改提交到本地 git 仓库。
<strong>请确保你的提交不包含自动生成的文件（<code>content/</code>目录中的任何文件）。</strong>
如果不是重大重构，请将代码压缩到一个提交中。</li>
<li>
- <p>Commit your changes to your local git repository. <strong>Please Make
sure that your commit does not include translated files (any files in the
<code>content/</code> directory).</strong> Unless your contribution is a major
rework of the website, please squash it into a single commit.</p>
- </li>
- <li>
- <p>Push the commit to a dedicated branch of your fork of the Flink
repository at GitHub.</p>
+ <p>请将提交推送到 GitHub 上你自己仓库的一个特定分支。</p>
<p><code>
git push origin myBranch
</code></p>
</li>
- <li>
- <p>Go the website of your repository fork
(<code>https://github.com/<your-user-name>/flink-web</code>) and use the
“Create Pull Request” button to start creating a pull request. Make sure that
the base fork is <code>apache/flink-web asf-site</code> and the head fork
selects the branch with your changes. Give the pull request a meaningful
description and submit it.</p>
- </li>
+
<li>打开你镜像的仓库(<code>https://github.com/<your-user-name>/flink-web</code>)
并使用 “Create Pull Request” 按钮开始创建 pull request 取请求。
确保基础分支是<code>apache/flink-web asf-site</code> ，并且 head fork 选择带有更改内容的分支。 为 pull
request 提供有意义的描述并提交。</li>
</ol>
-<h2 id="committer-section">Committer section</h2>
+<h2 id="committer-">Committer 章节</h2>
-<p><strong>This section is only relevant for committers.</strong></p>
+<p><strong>本节仅适用于提交者。</strong></p>
-<h3 class="no_toc" id="asf-website-git-repositories">ASF website git
repositories</h3>
+<h3 class="no_toc" id="asf--git-">ASF 网站的 git 仓库</h3>
<p><strong>ASF writable</strong>:
https://gitbox.apache.org/repos/asf/flink-web.git</p>
-<p>Details on how to set the credentials for the ASF git repository are <a
href="https://gitbox.apache.org/";>linked here</a>.</p>
+<p>有关如何设置 ASF git 仓库凭据的详细信息可以参考 <a
href="https://gitbox.apache.org/";>链接</a>。</p>
-<h3 class="no_toc" id="merging-a-pull-request">Merging a pull request</h3>
+<h3 class="no_toc" id="pull-request">合并 pull request</h3>
-<p>Contributions are expected to be done on the source files only (no
modifications on the compiled files in the <code>content/</code> directory.).
Before pushing a website change, please run the build script</p>
+<p>默认所有的修改仅在源文件上完成（对<code>content/</code>目录中自动生成的文件没有修改）。
在推送网站更改之前，请运行构建脚本。</p>
<div class="highlight"><pre><code>./build.sh
</code></pre></div>
-<p>add the changes to the <code>content/</code> directory as an additional
commit and push the changes to the ASF base repository.</p>
+<p>将更改添加到<code>content/</code> 目录作为附加提交，并将更改推送到 ASF 基本仓库。</p>
-<h3 class="no_toc" id="updating-the-documentation-directory">Updating the
documentation directory</h3>
+<h3 class="no_toc" id="section-4">更新文档目录结构</h3>
-<p>The build script does also take care of maintaining the <code>docs/</code>
directory. Set the <code>-u</code> flag to update documentation. This includes
fetching the Flink git repository and copying different versions of the
documentation.</p>
+<p>构建脚本还负责维护<code>docs/</code>目录。 设置 <code>-u</code> 标志以更新文档。 这包括获取 Flink git
仓库中不同版本的文档。</p>
</div>
diff --git a/improve-website.zh.md b/improve-website.zh.md
index d8be9e6..c10c461 100644
--- a/improve-website.zh.md
+++ b/improve-website.zh.md
@@ -2,105 +2,103 @@
title: "改进网站"
---
-The [Apache Flink website](http://flink.apache.org) presents Apache Flink and
its community. It serves several purposes including:
+[Apache Flink 官网](http://flink.apache.org) 介绍了 Apache Flink 及其社区。包括如下多种用途：
-- Informing visitors about Apache Flink and its features.
-- Encouraging visitors to download and use Flink.
-- Encouraging visitors to engage with the community.
+- 向来访者介绍 Apache Flink 及其特性。
+- 鼓励来访者下载并使用 Flink。
+- 鼓励来访者与社区进行互动。
-We welcome any contribution to improve our website. This document contains all
information that is necessary to improve Flink's website.
+我们欢迎任何改进官网的贡献。本文档包含了所有改进 Flink 官网所需要的信息。
{% toc %}
-## Obtain the website sources
+## 获取官网源码
-The website of Apache Flink is hosted in a dedicated
[git](http://git-scm.com/) repository which is mirrored to GitHub at
[https://github.com/apache/flink-web](https://github.com/apache/flink-web).
+Apache Flink 官网的源码托管在专用的 [git](http://git-scm.com/) 仓库中，并在 Github 中有一个镜像
[https://github.com/apache/flink-web](https://github.com/apache/flink-web)。
-The easiest way to contribute website updates is to fork [the mirrored website
repository on GitHub](https://github.com/apache/flink-web) into your own GitHub
account by clicking on the fork button at the top right. If you have no GitHub
account, you can create one for free.
+向官网贡献的最简单方式是通过单击右上角的 fork 按钮，将 [Github 上官网的镜像]
(https://github.com/apache/flink-web) 镜像到自己的仓库中。如果没有 Github 帐户，你可以免费创建一个。
-Next, clone your fork to your local machine.
+接下来，把你镜像的仓库克隆到本地机器上。
```
git clone https://github.com/<your-user-name>/flink-web.git
```
-The `flink-web` directory contains the cloned repository. The website resides
in the `asf-site` branch of the repository. Run the following commands to enter
the directory and switch to the `asf-site` branch.
+`flink-web` 目录包含了拷贝的仓库。官网的代码位于 `asf-site` 分支上。运行如下命令切换到 `asf-site` 分支
```
cd flink-web
git checkout asf-site
```
-## Directory structure and files
+## 目录结构和文件
-Flink's website is written in
[Markdown](http://daringfireball.net/projects/markdown/). Markdown is a
lightweight markup language which can be translated to HTML. We use
[Jekyll](http://jekyllrb.com/) to generate static HTML files from Markdown.
+Flink 的官网是用 [Markdown](http://daringfireball.net/projects/markdown/)
所编写。Markdown 是一种轻量级标记语言，可以翻译为 HTML。我们使用 [Jekyll](http://jekyllrb.com/) 生成静态
HTML 文件。
-The files and directories in the website git repository have the following
roles:
+官网仓库中的目录和文件组织如下：
-- All files ending with `.md` are Markdown files. These files are translated
into static HTML files.
-- Regular directories (not starting with an underscore (`_`)) contain also
`.md` files. The directory structure is reflected in the generated HTML files
and the published website.
-- The `_posts` directory contains blog posts. Each blog post is written as one
Markdown file. To contribute a post, add a new file there.
-- The `_includes/` directory contains includeable files such as the navigation
bar or the footer.
-- The `docs/` directory contains copies of the documentation of Flink for
different releases. There is a directory inside `docs/` for each stable release
and the latest SNAPSHOT version. The build script is taking care of the
maintenance of this directory.
-- The `content/` directory contains the generated HTML files from Jekyll. It
is important to place the files in this directory since the Apache
Infrastructure to host the Flink website is pulling the HTML content from his
directory. (For committers: When pushing changes to the website git, push also
the updates in the `content/` directory!)
+- 所有文件以 `.md` 结尾。这些文件会被转换为静态 HTML 文件。
+- 常规目录（不以下划线（`_`）开头）也包含以 `.md` 结尾的文件。目录结构最终会反映在生成的 HTML 文件和发布的网站上。
+- `_posts` 目录下包含了所有的博客文章。每个 Markdown 文件是一篇博客。贡献新的博客，请添加一个新的文件。
+- `_includes/` 目录包含可导入的文件，例如导航栏或页脚。
+- `docs/` 目录包含不同版本的 Flink 文档。在 `docs/`
目录下包含了所有已经发布的版本文档，以及最新的预览版文档。构建脚本负责维护这个目录。
+- `content/` 目录包含所有 Jekyll 生成的静态 HTML 文件。谨记一定要把文件放到该目录下，因为 Apache
Infrastructure 会从该目录拉取 HTML 内容。（对于提交者：当推送对该网站仓库的更改时，也请推送 `content/` 目录的更新）。
-## Update or extend the documentation
+## 更新文档
-You can update and extend the website by modifying or adding Markdown files or
any other resources such as CSS files. To verify your changes start the build
script in preview mode.
+可以通过修改已有文档，或新增资源--比如 CSS 文件等方式对网站进行更新。想验证你的修改，可以执行如下命令：
```
./build.sh -p
```
-The script compiles the Markdown files into HTML and starts a local webserver.
Open your browser at `http://localhost:4000` to view the website including your
changes. The served website is automatically re-compiled and updated when you
modify and save any file and refresh your browser.
+该脚本会把所有 Markdown 文件转换为 HTML 文件，并启动一个本地 web 服务器。打开浏览器并访问
`http://localhost:4000` 查看你的修改。当你重新修改并保存文件后，刷新浏览器可以看到最新的内容。
-Alternatively you can build the web site using Docker (without augmenting your
host environment):
+或者你可以使用 Docker 进行网站的构建（不增加主机环境）：
```
docker run --rm --volume="$PWD:/srv/flink-web" --expose=4000 -p 4000:4000 -it
ruby:2.5 bash -c 'cd /srv/flink-web && ./build.sh -p'
```
-Please feel free to ask any questions you have on the developer mailing list.
+如果有任何疑问，欢迎在开发者邮件列表中咨询。
-## Submit your contribution
+## 提交你的贡献
-The Flink project accepts website contributions through the [GitHub
Mirror](https://github.com/apache/flink-web) as [Pull
Requests](https://help.github.com/articles/using-pull-requests). Pull requests
are a simple way of offering a patch by providing a pointer to a code branch
that contains the changes.
+Flink 项目通过 [GitHub Mirror](https://github.com/apache/flink-web) 以提交 [Pull
Requests](https://help.github.com/articles/using-pull-requests) 方式接受网站贡献。Pull
requests 是一种通过向特定代码分支提交补丁的简单方法。
-To prepare and submit a pull request follow these steps.
+请按以下步骤操作准备并提交 pull request。
-1. Commit your changes to your local git repository. **Please Make sure that
your commit does not include translated files (any files in the `content/`
directory).** Unless your contribution is a major rework of the website, please
squash it into a single commit.
-
-2. Push the commit to a dedicated branch of your fork of the Flink repository
at GitHub.
+1. 将你的更改提交到本地 git 仓库。 **请确保你的提交不包含自动生成的文件（`content/`目录中的任何文件）。**
如果不是重大重构，请将代码压缩到一个提交中。
+2. 请将提交推送到 GitHub 上你自己仓库的一个特定分支。
```
git push origin myBranch
```
+3. 打开你镜像的仓库(`https://github.com/<your-user-name>/flink-web`) 并使用 "Create Pull
Request" 按钮开始创建 pull request 取请求。 确保基础分支是`apache/flink-web asf-site` ，并且 head
fork 选择带有更改内容的分支。 为 pull request 提供有意义的描述并提交。
-3. Go the website of your repository fork
(`https://github.com/<your-user-name>/flink-web`) and use the "Create Pull
Request" button to start creating a pull request. Make sure that the base fork
is `apache/flink-web asf-site` and the head fork selects the branch with your
changes. Give the pull request a meaningful description and submit it.
-
-## Committer section
+## Committer 章节
-**This section is only relevant for committers.**
+**本节仅适用于提交者。**
-### ASF website git repositories
+### ASF 网站的 git 仓库
{:.no_toc}
**ASF writable**: https://gitbox.apache.org/repos/asf/flink-web.git
-Details on how to set the credentials for the ASF git repository are [linked
here](https://gitbox.apache.org/).
+有关如何设置 ASF git 仓库凭据的详细信息可以参考 [链接](https://gitbox.apache.org/)。
-### Merging a pull request
+### 合并 pull request
{:.no_toc}
-Contributions are expected to be done on the source files only (no
modifications on the compiled files in the `content/` directory.). Before
pushing a website change, please run the build script
+默认所有的修改仅在源文件上完成（对`content/`目录中自动生成的文件没有修改）。 在推送网站更改之前，请运行构建脚本。
```
./build.sh
```
-add the changes to the `content/` directory as an additional commit and push
the changes to the ASF base repository.
+将更改添加到`content/` 目录作为附加提交，并将更改推送到 ASF 基本仓库。
-### Updating the documentation directory
+### 更新文档目录结构
{:.no_toc}
-The build script does also take care of maintaining the `docs/` directory. Set
the `-u` flag to update documentation. This includes fetching the Flink git
repository and copying different versions of the documentation.
+构建脚本还负责维护`docs/`目录。 设置 `-u` 标志以更新文档。 这包括获取 Flink git 仓库中不同版本的文档。
