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/18 01:07:33 UTC

[GitHub] [apisix-website] SylviaBABY commented on a diff in pull request #1287: docs: update documentation-guide

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