open-telemetry / open-telemetry/weaver
Document exact datamodel for values sent to JINJA templates
Open
Nobody has claimed this yet.
template engine
ux
- Dominant language
- Rust
- Stars
- 486
- Forks
- 108
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 40
Description
As part of a "getting started" guide, we should provide a tabular-type view of which fields (and their nested structure) are available in JINJA templates.
While this would change based on JQ, we should document what our common JQ helper methods return.
Related to #583
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 locating the getting-started guide and the documentation for common JQ helper methods. Identify the fields and nested structures exposed to JINJA templates, including how helper return values vary with JQ. Done means the guide contains a tabular datamodel description that clearly covers the common cases.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100