source_board_162

Are there any guidelines around tags

Rising Star

The system provides tagging, but what are the guidelines around using them?

1 ACCEPTED SOLUTION

Adhering to Tag Guidelines will be crucial to organizing content and search. Some general guidelines include:

  1. Questions, Ideas, and Articles all can be tagged with multiple topic tags. Each tag represents an individual topic, but the question, idea or article may be applicable to multiple topics.
  2. Every question should be tagged with at least 1 “global” Tag that represents the HDP component(s) (e.g: Ambari, Knox, etc..). These tags should already be pre-defined (why it's called global), and you shouldn’t create new ones. These global tags will be the only tags that have their first letter in uppercase.
  3. Most questions should be tagged with a HDP component version and if relevant an Ambari component version. Check to see an existing tag for the component version exists (most of the time it will). If creating a new tag for a component version, use the following naming convention:
    • hdp-x.x.x (e.g; hdp-2.3.0)
    • ambari-x.x.x (e.g: ambari-2.1.0)
  4. You can add any custom relevant tags that describe your question. Always check to see if one exists before creating a new one.
  5. Do not create a topic tag that represents two topics. For example: "Ambari with Kerberos" is not a usable tag, and the question should use two tags "Ambari", and "Kerberos".
  6. It will be moderator’s job to be constantly managing tags. E.g.: If someone creates a question and tags it with “hdp 2-3-0”, the moderator should edit the post with the right tag: “hdp-2.3.0”.

View solution in original post

1 REPLY 1

Adhering to Tag Guidelines will be crucial to organizing content and search. Some general guidelines include:

  1. Questions, Ideas, and Articles all can be tagged with multiple topic tags. Each tag represents an individual topic, but the question, idea or article may be applicable to multiple topics.
  2. Every question should be tagged with at least 1 “global” Tag that represents the HDP component(s) (e.g: Ambari, Knox, etc..). These tags should already be pre-defined (why it's called global), and you shouldn’t create new ones. These global tags will be the only tags that have their first letter in uppercase.
  3. Most questions should be tagged with a HDP component version and if relevant an Ambari component version. Check to see an existing tag for the component version exists (most of the time it will). If creating a new tag for a component version, use the following naming convention:
    • hdp-x.x.x (e.g; hdp-2.3.0)
    • ambari-x.x.x (e.g: ambari-2.1.0)
  4. You can add any custom relevant tags that describe your question. Always check to see if one exists before creating a new one.
  5. Do not create a topic tag that represents two topics. For example: "Ambari with Kerberos" is not a usable tag, and the question should use two tags "Ambari", and "Kerberos".
  6. It will be moderator’s job to be constantly managing tags. E.g.: If someone creates a question and tags it with “hdp 2-3-0”, the moderator should edit the post with the right tag: “hdp-2.3.0”.
Take a Tour of the Community
Don't have an account?
Your experience may be limited. Sign in to explore more.