Documentation Rules
Public Preview
With Documentation Rules TENANT_ADMINs can define organization’s documentation related requirements as rules and in the Documentation Review dashboard (under Well-Designed Review) see which objects are breaking these rules.
Currently you can set tag and description requirements for attributes, entities, loads and packages and define which schemas, zones or objects (based on regex) the rule applies to.
By default you will have a set of example rules setup (see image).
Example Rules
Below you can find more details about the configuration.
Column Name | Description | Nullable? |
|---|---|---|
Rule Name | Short name for the rule | No |
Rule Description | More detailed description for the rule | No |
Schemas | Comma separated list of schemas the rule applies to (all if left empty). | Yes |
Zones | Comma separated list of zones the rule applies to (all if left empty). | Yes |
Object Types | Comma separated list of object types the rule applies to (all if left empty). Options are:
| Yes |
Object Name Regex | Regex that the object must match for the rule to apply (all if left empty). | Yes |
Documentation Types | description and/or tag separated by a comma | No |
Is Enabled | TRUE or FALSE. Is this rule currently active. | No |