Skip to content

Preserve Embedded YAML Formatting in Documentation Examples #419

@codeEvolveZenith345

Description

@codeEvolveZenith345

What:
Replace all instances of data: > with data: | in YAML code samples that embed multi-line manifests, especially under fields like raw: or data:.

Where:
All documentation files containing embedded YAML or scripts intended for copy-paste, e.g., chaos-workflow.md.

Why:
Using | (literal block scalar) ensures line breaks and YAML structure are preserved. This prevents copy-paste errors and makes examples directly reusable, whereas > (folded block scalar) collapses lines and corrupts embedded YAML manifests.

Benefit:
Ensures users can copy and use provided YAML examples without formatting or parsing issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions