You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
YuCheng Hu aebcf63db7 提交代码用来 Trigger 一次编译 1 week ago
.firebase 翻译并且测试 PR 编译 1 year ago
.github/workflows Route new issues for triage 1 year ago
config/_default 配置文件,修改编辑当前文档的仓库路径 1 year ago
scripts Relax the Hugo version restriction (#213) 1 year ago
static Initial commit 2 years ago
themes/default 文档第一页的翻译完成,解释什么是 Pulumi 1 year ago
.gitignore Fix tutorial indexes (#156) 1 year ago
.nvmrc Initial commit 2 years ago
.travis.yml Check the version for go 1 year ago
BLOGGING.md Clean up tags (#215) 1 year ago
CODE-OF-CONDUCT.md Initial commit 2 years ago
CONTRIBUTING.md Initial commit 2 years ago
Makefile Relax the Hugo version restriction (#213) 1 year ago
README.md 提交代码用来 Trigger 一次编译 1 week ago
firebase.json need to push public folder as well 1 year ago
go.mod Initial commit 2 years ago
package.json Initial commit 2 years ago
pulumi-hugo-cn.iml 提交代码用来 Trigger 一次编译 1 week ago
yarn.lock Merge dependabot branches (#231) 1 year ago

README.md

pulumi-hugo-cn

欢迎来到 Pulumi 中文文档项目(https://pulumi.ossez.com/) ,本项目是直接从官方的英文文档中 Fork 下来,并且直接翻译后及时更新的。

翻译后的文档使用 Google FireBase 项目提供的服务进行部署,部署访问的地址为:https://pulumi.ossez.com/

我们使用了 Jenkins 来进行 CI,本想使用一些开源或者在线的 CI 工具的,但在调试的时候对我们的编译次数有限制,一些构建需要本地环境,使用虚拟环境的构建时间过长,因此我们就集使用 Jenkins 来进行部署了。如您还有什么好的建议,请联系管理员。

有关本项目的编译和集成部署方式,请查看文章 Pulumi 项目文档如何部署到 firebase 中 中的内容,我们使用了 Jenkins 为 CI 工具。

非常重要的一点是,如果你尝试在 Windows 下面编译这个文档项目,你可能会遇到很多静态资源不存在或者没有被生成的情况,因此我们强烈建议你使用 Linux 系统的平台对文档进行编译。

同时在编译的时候需要使用官方提供的 'make build' 命令,这个命令将会在你的项目本地目录中生成一个 public 文件夹,这个文件夹就是所有的静态文件文件夹,你可以直接把这个文件夹上传到任何你喜欢的服务器上提供在线访问。

中文本地化说明

如果您有兴趣参与我们的小组和项目,请使用下面的联系方式和我们联系:

联系方式名称 联系方式
电子邮件 service@ossez.com
QQ 或微信 103899765
QQ 交流群 15186112
社区论坛 https://www.ossez.com/

公众平台

我们建议您通过社区论坛来和我们进行沟通,请关注我们公众平台上的账号

微信公众号

头条号

我们也在头条号上创建了我们的公众号,请扫描下面的 QR 关注我们的头条号。

Hugo 模块包含有 Pulumi 主题和网站的内容。

这个参考同时也被官方的 https://github.com/pulumi/docs 项目使用,用来创建你可以通过 https://pulumi.com 访问到的内容。如果你有兴趣对文档进行一些修改或者提交你的自己的博客内容到 https://pulumi.com/blog 链接中,那么你就来到了正确的地方了! 🙌

官方文档贡献

首先,请确保你已经阅读了我们的 社区贡献指南 同时也参考了我们的 代码规范

工具链

我们使用 Hugo 来构建 Pulumi 官方网站的静态文件。同时还使用了 Yarn 来管理 Node.js 使用的了依赖,文档的编写使用的是 Markdown 格式。

下面列出了如果你在本地编译生成文档静态文件所需要的工具链。

我们建议你的编译过程放在 Linux 平台上进行,如果你的操作系统中没有安装 make 工具的话,那么你还需要安装 make 工具。

CSS 和 JavaScript 工具

我们同时也使用了很多工具来编译和管理我们的 CSS 和 JavaScript 资源文件。

包括有下面的一些工具:

你并不需要单独或者全局安装上面的所有工具,我们在后面使用的脚本将会为你处理所有需要的工作。

但是如果你希望对官方的布局进行一些修改并且贡献的话,那么你可能需要对 CSS 和 JavaScript 进行提交,那么你需要对上面的这些工具是如何使用的需要有一些了解。

安装自检

运行 make ensure 来对你当前的环境进行检查,确定已经安装了正确的依赖和版本。这个脚本能够让你了解在当前的环境中你还有什么依赖需要进行安装。

make ensure

本地运行 Hugo

Once you've run make ensure successfully, you're ready to run the development server. If you're only planning on writing Markdown or working with Hugo layouts, this command should be all you need:

make serve

You can browse the development server at http://localhost:1313, and any changes you make to content or layouts should be reloaded automatically.

运行支持 CSS 和 JavaScript Hugo

If you plan on making changes to CSS or JavaScript files, you'll probably want to use this command instead:

make serve-all

The serve-all target runs Hugo, node-sass, and the Stencil development server concurrently, allowing you to make changes to Sass files, Stencil components, or TypeScript/JavaScript source files, and have those changes compiled and reloaded automatically as well.

Linting 和 testing

Linting 代码的本意就是找出程序中的错误,这些错误包括潜在的语法错误,编译错误,拼写错误等。

这一步是为了让你在对代码提交之前检查你的代码和你的 Markdown 文件,并且找出可能存在的问题,运行下面的命令:

make lint test

Tidying up

To clear away any module caches or build artifacts, run:

make clean

About this repository

This repository is a Hugo module that doubles as a development server. It does not contain every page of the Pulumi website, because most of those pages (e.g., those comprising our CLI and SDK docs) are generated from source code, so they aren't meant to be edited by humans directly.

Because of this, many of the links you follow when browsing around on the development server (to paths underneath /docs/reference for example) will fail to resolve because their content files are are checked into a different repository — most likely https://github.com/pulumi/docs. When we build the Pulumi website, we merge this module along with any others into a single build artifact, but when you're working within an individual module like this one, you may find you're unable to reach certain pages or verify the links you may want to make to them.

If you want to link to a page that exists on https://pulumi.com but not in this repository, just use the page's relative path with a Hugo relref in the usual way, and we'll make sure all links resolve properly at build-time. For example, to link to the Digital Ocean Droplet page (a page that doesn't exist in this repository but that would exist in an integration build), you'd use:

{{< relref /docs/reference/pkg/digitalocean/droplet >}}

This works because we've suppressed Hugo's built-in relref validation to keep the module-development workflow as lightweight as possible.

What's in this repo

  • All hand-authored content and documentation, including top-level pages, guides, blog posts, and some tutorials
  • Most Hugo module components, including archetypes, layouts, partials, shortcodes, data, etc.

You'll find all of these files in themes/default.

What's not in this repo

Merging and releasing

When a pull request is merged into the default branch of this repository, a follow-up PR is triggered on pulumi/docs that produces an integration build. Once that build completes and is approved and merged into pulumi/docs, the changes are deployed to pulumi.com.

Blogging

Interested in writing a blog post? See the blogging README for details.

Shortcodes and web components

We use number of Hugo shortcodes and web components in our pages. You can read more about many of them in the components README.