realm_is_not_documented

Category

Documentation

Severity

Error

What It Does

Checks if all realms in the repository are documented in docs/v2/metadata.yaml.

Why Is This Bad

It can be hard to understand the purpose of certain realms and when to use them. Documentation explains what they are for and make it easier to pick the right realm.

How To Fix

Example Realm

datacenter.example_realm

Add an entry in docs/v2/metadata.yaml that looks like this:

realms:
  datacenter:
    description: 'The datacenter realm contains all our datacenters as subrealms.'

    subrealms:
      example_realm:
        description: >
          An example realm to show how to fix the lint regarding undocumented
          realms.

Known Problems

None

Example

error: realm `testing.saltmaster_ide.nebula.dg` is not documented in metadata file
  file: "pillars/global/realm/testing/saltmaster_ide/nebula/dg/init.sls"
  quickfix: create an entry in "/home/athaller/code/work/salt/saltstack/docs/v2/metadata.yaml" for the realm testing.saltmaster_ide.nebula.dg
  category: Documentation
  help: for more information see https://share.thaller.ws/sk43iJjWGQoypYQB2JtopK5KnLwa9u/index.html#realm_is_not_documented

results matching ""

    No results matching ""