open-telemetry / open-telemetry/weaver
Define Namespace items
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 489
- Forks
- 108
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 40
Description
Is your feature request related to a problem? Please describe.
I want to be able to define my namespaces within yaml and have the corresponding markdown generated rather than needing to define it within readme.md files within the docs folder.
Describe the solution you'd like
To be able to write a yaml file similiar to the below describes my namespace and at build time generates a markdown file for me
groups:
- id: namespace.workflow
type: namespace
name: Workflow
stability: development
brief:
note:
header:
title:
content:
style:
footer:
title:
content:
style:
Or in v2
namespaces:
- name: workflow
stability: development
brief:
note:
header:
message:
type:
footer:
message:
type:
It is assumed the build process could automatically add references to any groups defined in the same folder so that we would have insight into what is available and could render it.
Describe alternatives you've considered
Manually maintain the linkage in markdown and remember to update it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing README.md files in the docs folder and the build process that turns them into markdown. Compare the proposed groups and namespaces YAML shapes with current linkage behavior. Done means namespace definitions in YAML generate the corresponding markdown and references to groups in the same folder automatically.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100