Skip to content

Generate consumable documentation from the spec #400

Open
@jsoriano

Description

@jsoriano

Spec files currently contain information about how each file and field should be used, with descriptions, examples, accepted values and so on. But these are source files that may be renamed, moved or removed, breaking documentation builds that depend on them.

Generate some intermediary documentation files in a well-known location (like docs/spec.asciidoc) that other projects may refer to.

And revert #401.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:DocsLabel for the Observability docs teamTeam:EcosystemLabel for the Packages Ecosystem team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions