Skip to content

Style guide update: add details of how we include YAML snippets #3794

@abrennan89

Description

@abrennan89

Describe the change you'd like to see

As per the discussion here #3774 (comment) - we should show "full" samples of YAML in docs rather than just snippets, so that we are providing context for users of where exactly things like annotations sit in the YAML. We need to add this to the style guide so that we can enforce consistency.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions