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/01/17 06:35:51 UTC

[GitHub] [apisix-website] yzeng25 edited a comment on issue #744: support more tags for posts

yzeng25 edited a comment on issue #744:
URL: https://github.com/apache/apisix-website/issues/744#issuecomment-1014185565


   Hi @adarrssh , 
   
   Thanks for bringing this up! I have had a conversation with @juzhiyuan about 4 months ago regarding on the similar issue. Here are some thoughts for you, hope it helps.
   
   ## What are tags
   
   We use tags to categorize blogs.
   
   ## Tags’ mechanism
   
   1. Show up in tags page [1], ordered alphabetically.
   2. Gather blogs with the same tag.
   3. When click on a certain tag, redirects to a page containing all blogs with the tag
   
   ## What tags do we have currently
   
   **Community**: community related, e.g. "How to contribute to an open source project without writing code?"
   **Events**: event-related, for example: online live stream, event previews, meetups, and online meeting, etc.
   **Interview**: Interviews, e.g., Dr. Yang Li interview, Summer of Programming interview.
   **Practical Case**: Best practices, easily confused with Technology. The factors that determine whether an article is a Technology or a Practical Case are: the content of the article and the subject of the description. For example, if the article is about "Running Apache APISIX on xxx platform", then it is a Practical Case; for example, if the article is about technical stuff, "Apache APISIX v.s. Envoy", then it is Technology.
   **Release**: Release notes, this is better understood. It should be noted that the release notes inside the blog are polished, while the release notes inside the release are written by developers.
   **Security**: Security vulnerability notification and methods to bypass security vulnerabilities, currently there are only two articles, very good to identify, generally have CVE-xxxxxxx is it.
   **Technology**: Technical articles, easily confused with Practical Case. The factors that determine whether an article is a Technology or a Practical Case are: the content of the article and the subject of the description. For example, if the article is about "Running Apache APISIX on xxx platform", then it is a Practical Case; for example, if the article is about technical stuff, "Apache APISIX v.s. Envoy", then it is Technology.
   **User Case**: User Case, this is also very straightforward. Please tell us how you use Apache APISIX and your feelings about Apache APISIX.
   
   Ref: Blog Contributing Guide[2]
   
   ## What tags do we want to have
   
   I would suggest spilt the “Technology” tag into different ones, such as “Ecosystem”, “Observability”,”Monitoring”,”Logging” etc.
   
   As @juzhiyuan suggests in the previous comments, the “Datadog” tag is indeed very precise. But this would result in a tag with only one blog under it. Think about this: if we were to add a tag for each specific brand, community, or product, the tags page [1] would look very messy.
   
   If we take a step back, take it as a sort of “Observability” or “Monitoring”, and add other blogs under the same tag. That is better in my opinion. In other words, we would expect tags’ granary (how fine-grained it is) reach the function field level, but not dive into a specific brand, community, or product.
   
   ## More complicated case
   
   Do we need 2 or more tags for a blog? It is technically supported to do so, but it is also hard for maintenance. Take “Datadog” as an example again, if we were to spilt Technology” tag into different ones, such as “Ecosystem”, “Observability”,”Monitoring”,”Logging”, it fits in more than 1 tag. Do we choose the best fit tag or all fitting tags?
   
   ## Reference
   [1]https://apisix.apache.org/blog/tags
   
   [2]https://apisix.apache.org/docs/general/blog


-- 
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