请在 jenkins-x.io 浏览这些文档
NOTE： 请浏览这些文档在 jenkins-x.io ，浏览此库中的 Markdown 文件时，并非所有链接都有效。
为了能够在本地编辑这个文档，你需要去 clone 这个仓库：
git clone --recurse-submodules --depth 1 https://github.com/jenkins-x/jx-docs.git请注意上面的 clone 命令的参数 --recurse-submodules 的使用。
这个选项会 pull 两个 git 子模块，叫做 docsy 和 labs-enhancements。
如果你已经执行过 git clone，但没有检出子模块的话，可以运行：
git submodule update --init --recursive在随后通过 git pull更新源代码时还要记住去 pull 子模块的更改：
git pull --recurse-submodules你可以通过以下方式查看子模块的 commit：
git submodule status --recursive在得到所有资源之后，你需要去 安装 npm 和确保需要的npm模块已经被安装
npm install该站点本身使用Hugo 构建的，并在config.toml 中进行配置。
你有两个方式运行 Hugo，直接运行在你的机器上面或通过Docker Compose。
以下两节更详细地描述了这两种备选方案。
NOTE: Hugo 在开发模式下将站点呈现在内存中，默认情况下，不会将任何内容写入磁盘。
如果你想要在你机器上面构建本地站点，你需要去安装 Hugo，检查Makefile 以了解最新的推荐版本使用，并且检查Golang的环境变量有无设置好。
一旦你安装了，你可以运行：
make server你可以现在访问localhost:1313下的站点。
如果不在本地安装 Hugo 的话，你可以使用本仓库中提供的 docker-compose.yml 在容器中启动 Hugo 服务
在容器化环境中。
确保你已经安装了 Docker 。
make compose-up你现在可以访问在 localhost:1313 下的站点。
这个 Hugo 服务在后台运行，你可以通过以下方式停止它：
make compose-down我们并非都是拼写大师，所以幸运的是，有一些工具可以帮助我们解决这个问题，我们正在使用node-markdown-spellcheck 去遍历我们所有的markdown 文件并列出任何拼写问题或者位置单词。
为了使这个尽可能简单，只需要运行一下命令：
make spellcheck该报告可能包括拼写正确的单词，但这仅意味着拼写检查器不知道正确的拼写（技术术语、命令等经常发生）。
请编辑 .spelling 并添加未知单词。
另外，请尽量保持列表按字母顺序排序，这样更易于浏览。
为了获得检查所有链接的帮助，我们使用htmlproofer。
make linkcheckNOTE: 初始运行非常慢（由于外部链接检查），并且缓存仅在完成时才建立。
NOTE: 现在忽略... x509: certificate ... 错误是安全的
如果您将页面移动到不同的位置，你可以通过在页面标题中使用 aliases 条目来添加重定向：
aliases:
- /some/old/path
- /another/path要升级到新的增强提交 - 我们希望很快会自动执行此操作！
cd content/en/docs/labs/enhancements
git checkout master
git pull
cd ..
git add enhancements
git commit -m "move to latest enhancements"Docsy 作为主题目录下
文档被加入到 jx-docs 仓库作为子模块在主题文件夹下面，
为了升级文档，运行下面的命令：
cd themes/docsy
git pull origin master
git submodule update --init --recursive为了让更多人更好的知道 Jenkins X ，本土化是很必要的和有意义的。
然后关于这个我们需要遵守一些规则，请阅读下面的相关语言：
请参阅可用的文档贡献指南 Jenkins X website.