elastic / elastic/package-spec

Generate consumable documentation from the spec

Open
#400 0 comments 0 reactions 0 assignees View on GitHub
Team:Docs Team:Ecosystem
Dominant language
Go
Stars
20
Forks
93
Avg merge
15h 10m
Merged PRs (30d)
12

Description

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 https://github.com/elastic/package-spec/pull/401.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.