AWS 文档现推出开放源版并在 GitHub 上开放

阅读数:93 2019 年 10 月 28 日 08:00

今年初,我们将 AWS 开发工具包开发人员指南以 GitHub 转贴的方式发布 (所有都可在 awsdocs 组织中找到),并邀请感兴趣的人以 Pull 请求的方式贡献修改和改进。

今天我们为该组织再次增加了 138 个开发人员指南和用户指南,同样期待收到您的请求。您可以修复漏洞,完善代码样本 (或提交新代码样本),增加详细信息,以及重新编写句段以提高准确性或明确性。此外,您还可以查看提交历史以进一步了解新功能和服务发布,跟踪文档的改进。

如何贡献
在开始使用前,请阅读 Amazon 开放源行为守则以及所感兴趣的 AWS 服务的贡献指南文档 (通常名称为 CONTRIBUTING.md)。 然后创建一个 GitHub 账户 (如果您还没有)。

如果发现有需要修改或完善之处,请访问该文档的 HTML 版,单击页面顶端的 Edit on GitHub (在 GitHub 上编辑) 按钮:

AWS 文档现推出开放源版并在 GitHub 上开放

这将允许您以源格式 (一般为 Markdown reStructuredText ) 编辑文档。源代码用于生成文档的 HTML、PDF 和 Kindle 版本。

登录 GitHub 后,单击铅笔标志:

AWS 文档现推出开放源版并在 GitHub 上开放

这将会创建一个“分支” — 也就是该文件的一个独立副本,您可以对其进行独立编辑。

然后进行编辑。一般而言,作为开放源项目的新贡献者,您应当通过小的高质量编辑积累经验和声誉。在此文档中,我将把“dozens of services” 修改为“over one hundred services”:

AWS 文档现推出开放源版并在 GitHub 上开放

然后我总结我的修改并单击 Propose file change (建议文件修改)

AWS 文档现推出开放源版并在 GitHub 上开放

我会检查差异来验证我的修改,然后单击 Create pull request (创建 Pull 请求)

AWS 文档现推出开放源版并在 GitHub 上开放

然后我会检查详细信息并再次单击 Create pull request (创建 Pull 请求)

AWS 文档现推出开放源版并在 GitHub 上开放

Pull 请求 (简称 PR) 将会被转交给 Elastic Beanstalk 文档团队,他们会决定是否接受、拒绝或联系我了解更多信息。该团队会尽力在 48 小时内处理 Pr,每当 PR 的状态发生变化时都将通过 GitHub 通知我。

与大多数开放源项目一样,经常提交重点明确、大小适中的 Pull 请求,要比偶尔提交包含数十项编辑的超大请求更受欢迎。

如果我对转贴的长期修订历史感兴趣,我可以 Watch (关注) 它和 / 或 Star (加星):

AWS 文档现推出开放源版并在 GitHub 上开放

如果我 Watch (关注) 某个转贴,我将在该服务指南有新的发布、发行或 Pull 请求时收到电子邮件通知。

立即建立分支
本次发布为您提供了又一个帮助我们完善 AWS 的途径。请告诉我您的意见!

本文转载自 AWS 技术博客。

原文链接:
https://amazonaws-china.com/cn/blogs/china/aws-documentation-is-now-open-source-and-on-github/

欲了解 AWS 的更多信息,请访问【AWS 技术专区】

评论

发布