Skip to content

Markdown based specification #255

@thompson-tomo

Description

@thompson-tomo

I would like to have the specification described in markdown files which are generated automatically based upon the schema definition files.

After some research & testing it appears that https://github.com/adobe/jsonschema2md/ can be used and it won't need an additional runtime ie go/python.

The Hope is once the docs are of quality ie all titles are set, they can be published to openTelemetry.io to maximise visibility/understanding.

An example of using the tool can be seen at: https://github.com/thompson-tomo/opentelemetry-configuration/tree/feature/%23255_MarkdownDocs/docs/spec

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