You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/08/15 13:47:23 UTC
[GitHub] [apisix-website] hf400159 opened a new pull request, #1287: docs: update documentation-guide
hf400159 opened a new pull request, #1287:
URL: https://github.com/apache/apisix-website/pull/1287
Fixes: #[Add issue number here]
Changes:
<!-- Add here what changes were made in this pull request and if possible provide links showcasing the changes. -->
Screenshots of the change:
<!-- Add screenshots depicting the changes. -->
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] netlify[bot] commented on pull request #1287: docs: update documentation-guide
Posted by GitBox <gi...@apache.org>.
netlify[bot] commented on PR #1287:
URL: https://github.com/apache/apisix-website/pull/1287#issuecomment-1215033721
### <span aria-hidden="true">👷</span> Deploy Preview for *apache-apisix* processing.
| Name | Link |
|---------------------------------|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit | f53b6c08b889c70f1991d473508c8df6886485e3 |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/sites/apache-apisix/deploys/62fa4e6b69b34300084ce29c |
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SylviaBABY commented on a diff in pull request #1287: docs: update documentation-guide
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #1287:
URL: https://github.com/apache/apisix-website/pull/1287#discussion_r948561722
##########
website/docs/general/blog-contributing-guide.md:
##########
@@ -139,14 +139,12 @@ Each post can have multiple tags. The tags used currently are given below and ea
Each post can have more than one tag. The available tags and explanations are as follows. If none of the tags below fits, please leave a comment in your pull request, and we will handle it together. Please note that these tags and rules of applying tags could change over time.
-- **Community**: Everything related to community, for example, "How to contribute to an open source project without writing code?".
-- **Events**: Related to events, for example, live streams, event previews, meetups and project meetings.
-- **Interview**: For example, Dr. Yang Li interview, Summer of Programming interview.
-- **Practical Case**: Includes best practices to follow. This is easily confused with **Technology**. The content of the article determines which tag the post belongs to. For example, "Running Apache APISIX on the xxx platform" would belong to the Practical Case tag and "Apache APISIX vs Envoy" would belong to the Technology tag.
-- **Release**: Tag for release notes. Note that the release notes in blog posts are polished whereas inline release notes are written by developers.
-- **Security**: Security vulnerability notifications and methods to bypass security vulnerabilities. Currently there are [six articles](/blog/tags/security/), and they generally have CVE-xxxxxxx in its title.
-- **Technology**: Technical articles. Should not be confused with **Practical Case** (see above).
-- **User Case**: Posts about using Apache APISIX. Tell us how you are using Apache APISIX!
+- **Community**: content related to community, community activities, and version release tags, such as: "How to contribute to the community in a form other than code?", live broadcast preview, event preview, meeting content and project meeting content.
Review Comment:
```suggestion
- **Community**: Content related to community, community activities, and version release tags, such as: "How to contribute to the community in a form other than code?", live broadcast preview, event preview, meeting content and project meeting content.
```
##########
website/docs/general/blog-contributing-guide.md:
##########
@@ -139,14 +139,12 @@ Each post can have multiple tags. The tags used currently are given below and ea
Each post can have more than one tag. The available tags and explanations are as follows. If none of the tags below fits, please leave a comment in your pull request, and we will handle it together. Please note that these tags and rules of applying tags could change over time.
-- **Community**: Everything related to community, for example, "How to contribute to an open source project without writing code?".
-- **Events**: Related to events, for example, live streams, event previews, meetups and project meetings.
-- **Interview**: For example, Dr. Yang Li interview, Summer of Programming interview.
-- **Practical Case**: Includes best practices to follow. This is easily confused with **Technology**. The content of the article determines which tag the post belongs to. For example, "Running Apache APISIX on the xxx platform" would belong to the Practical Case tag and "Apache APISIX vs Envoy" would belong to the Technology tag.
-- **Release**: Tag for release notes. Note that the release notes in blog posts are polished whereas inline release notes are written by developers.
-- **Security**: Security vulnerability notifications and methods to bypass security vulnerabilities. Currently there are [six articles](/blog/tags/security/), and they generally have CVE-xxxxxxx in its title.
-- **Technology**: Technical articles. Should not be confused with **Practical Case** (see above).
-- **User Case**: Posts about using Apache APISIX. Tell us how you are using Apache APISIX!
+- **Community**: content related to community, community activities, and version release tags, such as: "How to contribute to the community in a form other than code?", live broadcast preview, event preview, meeting content and project meeting content.
+- **Security**: Security Vulnerability Notifications and Methods to Address Security Vulnerabilities. There are currently [six articles](/blog/tags/security/), and they all have the same title as CVE-xxxxxxx.
+- **Technology**: technical articles. Needs to be distinguished from **Practical Case** (see above).
Review Comment:
```suggestion
```
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SylviaBABY merged pull request #1287: docs: update documentation-guide
Posted by GitBox <gi...@apache.org>.
SylviaBABY merged PR #1287:
URL: https://github.com/apache/apisix-website/pull/1287
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SylviaBABY commented on a diff in pull request #1287: docs: update documentation-guide
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #1287:
URL: https://github.com/apache/apisix-website/pull/1287#discussion_r948569290
##########
website/i18n/zh/docusaurus-plugin-content-docs/current/blog-contributing-guide.md:
##########
@@ -145,18 +145,16 @@ tags: [tag1,tag2,...,tagn]
:::
-- **Community**：和社区有关的内容，比如说："如何以代码之外形式给社区做贡献？"。
-- **Events**：和活动有关的内容，比如说：直播预告、活动预告、会议内容和项目会议内容。
-- **Interview**：例如，李杨博士访谈，《编程之夏》访谈。
-- **Practical Case**：包括要遵循的最佳实践。这很容易与 **Technology** 相混淆。文章的内容决定了该文章属于哪个标签。例如，"在xxx平台上运行 Apache APISIX" 属于 `Practical Case` 标签，而 "Apache APISIX 与 Envoy" 则属于 `Technology` 标签。
-- **Release**：版本发布的标签。请注意，博客文章中的版本发布说明是经过完善的，而对应仓库中的 `Release Note` 是由开发人员编写的。
+- **Community**：社区、社区活动有关的内容以及版本发布的标签，比如说："如何以代码之外形式给社区做贡献？"，直播预告、活动预告、会议内容和项目会议内容。
- **Security**：安全漏洞通知和解决安全漏洞的方法。目前有[六篇文章](/blog/tags/security/)，他们都同样有形如 CVE-xxxxxxx 的标题。
- **Technology**：技术文章。需要与 **Practical Case** 区分（见上）。
Review Comment:
```suggestion
```
##########
website/i18n/zh/docusaurus-plugin-content-docs/current/blog-contributing-guide.md:
##########
@@ -121,19 +121,19 @@ tags: [tag1,tag2,...,tagn]
- `authors.url`：作者的 GitHub 主页，例如：`url: "https://github.com/yzeng25"`。
- `authors.image_url`：作者的 GitHub 头像，例如：`authors.image_url: "https://avatars.githubusercontent.com/u/36651058?v=4"`。
-##### `keywords`
+#### `keywords`
关键字是提升 SEO 优化文章排名的必需字段。
在中文博客中，前三个关键字通常是 `API 网关`（英文博客中请使用 API Getway）、`APISIX` 和 `Apache APISIX`，后两个关键字与博客主题相关。
-##### `description`
+#### `description`
-短描述是另外一个提升 SEO 优化网站排名的必需字段。
+短描述是另外一个提升 SEO 优化网站排名的必需字段，需要包括用户需要这篇文章时，可能会使用的搜索关键字。
-对博客简短的概述就是一个好描述，通常描述的字符数在 150 到 170 之间即可。
+对博客简短的概述就是一个好描述，通常描述的字符数在 150 到 160 之间即可。
Review Comment:
```suggestion
对博客简短的概述就是一个好描述，通常描述的字符数在 100 到 150 之间即可。
```
--
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-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org