Tagging Standards
- No PII data should be held in tags for example use generic distribution lists and not individual user emails.
- Tags on an object must only hold data about the object.
- Tag values must be YAML compatible.
- Only tags documented in the following list are acceptable.
- Tag key standards:
- all lowercase
- 1st character is alphabetic otherwise alphanumeric
- no white space
- no special characters
Example
---
proposal:
id: 8572678454
version: 99
name: an example of tagging
description: an example of how YAML tags are placed inside a virtue object
tags:
- a_string_tag: "hello world"
- an_array_tag: [1,2,3,4]
- a_bool_tag: true
- a_number_tag: 9
- an_object_tag:
- field_a: A
- field_b: B
---
Acceptable Tags
| key | format | example | description |
|---|---|---|---|
| governance_policies | YAML string array | governance_policies: ["CR2.9", "CR4.5"] | a list of governance policies that this virtue adheres to |