SylviaBABY commented on code in PR #1094: URL: https://github.com/apache/apisix-website/pull/1094#discussion_r874413368
########## website/i18n/zh/docusaurus-plugin-content-docs/current/blog-contributing-guide.md: ########## @@ -0,0 +1,207 @@ +--- +id: blog +title: 博客贡献指南 +keywords: +- API 网关 +- APISIX +- Apache APISIX +- 博客 +description: 如何在 Apache APISIX 官网提交或更新博客？ +--- + +如需在 Apache APISIX 网站上进行撰写或更新[博客](/blog/)，请遵循本篇指南。 + +如果你对已经发布的博客内容存有疑问，欢迎提交 [issue](/docs/general/submit-issue) 进行反馈。如果你有意愿，也可自己创建一个 [PR](/docs/general/contributor-guide/#open-a-pull-request) 对该问题进行修复。 + +当前博客支持[中文](/zh/blog/)和[英文](/blog/)两种语言，你可以根据自己的熟悉的语言提交博客。目前中文和英文博客需要同时提交，否则在官网会出现未知错误，但是你不必担心，社区贡献者会在你提交博客之后翻译文章，届时你可以 Review 相应 PR。 + +你可以在 `website/blog` 目录下根据年/月/日创建一个目录，并提交英文博客。 + +例如：`website/blog/2022/03/01/apisix-integration-public-api-plugin.md` 该目录释义如下： + +- `apisix-integration-public-api-plugin.md` 是这篇博客的文件名，这篇博客的发布日期是 2022 年 3 月 1 日， +- `website/blog/2022/03/01` 是该博客所在的目录。 +- `https://apisix.apache.org/blog/2022/03/01/apisix-integration-public-api-plugin` 是该博客 PR 合并后的 URL。 + +:::note + +同样的，你可以在 `website/i18n/zh/docusaurus-plugin-content-blog` 目录下提交中文博客。 + +::: + +## 博客类型 + +你不但可以提交如何使用 Apache APISIX 的博客，而且也可以提交如何为 Apache APISIX 做贡献的博客。 + +你也可以更新已经发布的博客，包括但不限于更新博客内容，修复 issues 中提到的链接错误、用词错误以及表述不清晰等问题。 + +### 提交博客流程 + +提交一篇新博客是为 Apache APISIX 做贡献的最好方式之一。Apache APISIX 项目的使用者和贡献者都可以从你的博客中学习经验。 + +1. 首先你需要在正确的路径中存放新的博客文档。 + 1. 如果你用**英文**撰写博客，请在 `website/blog` 目录下新建一个 Markdown 文件。 + 2. 如果你用**中文**撰写博客，请在 `website/i18n/zh/docusaurus-plugin-content-blog` 目录下新建一个 Markdown 文件。 + 3. 如果你未能找到一个合适的目录匹配年月日，你可以新建一个文件夹来存放博客。 + +2. 当你找到了一个存放你的博客的目录，你就可以在该目录中创建一个 Markdown 文件。请注意，文件名请使用英文，并且避免大写字母。Reviewers 可能会建议你改变文件名以提升 SEO（部分文件名含有大写字母，已经在 [#713](https://github.com/apache/apisix-website/issues/713) 中被修复）。 + +3. 你可以通过编辑 Markdown 文件把文字、图片、图表添加到你的博客中。你可以从 [Markdown 指南](https://www.markdownguide.org/)了解更多关于 Markdown 格式的信息。 + - 添加图片前请先将图片上传到[公共图片 CDN 服务](https://markdown-editor-chi.vercel.app/#/)然后在 Markdown 文件中添加图片链接。 + - 表格及图片蕴涵了大量信息，我们很乐意看到它们。从经验来看小于等于4列的表格在网页上显得更加美观。 + +4. 根据你新建的博客[创建一个 PR](/docs/general/contributor-guide/##创建一个-pr)。 + +:::note + +你可以通过在本地构建网页环境检查你的修改。这可以确保在你提交 PR 之前没有任何错别字或遗留问题。虽然 Apache APISIX Website 会运行 CI 来检查并反馈这些错误，但更推荐优先在本地环境进行测试。具体构建流程请参考[构建网页环境](https://github.com/apache/apisix-website/blob/master/README.md) + +::: + +#### 配置博客元数据 + +每一个博客源文件都包含了一个 YAML 前言或标题，并使用两行 `---` 与正文分分隔。 + +元数据中包含了`title`，`description`，`authors`、`tags`和`keywords`等字段，部分内容可以参考的模板如下： Review Comment: ```suggestion 元数据中包含了 `title`、`description`、`authors`、`tags` 和 `keywords` 等字段，部分内容可以参考的模板如下： ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
