Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance the discoverability of the documentation for Weaver, Jinja, and Semantic Conventions #439

Open
lquerel opened this issue Nov 1, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lquerel
Copy link
Contributor

lquerel commented Nov 1, 2024

As @marcalff mentioned in comment #227 (comment) , it would be beneficial to add the following comment into the jinja templates present in our examples and documentation.

{#
  Copyright The OpenTelemetry Authors
  SPDX-License-Identifier: Apache-2.0
  This file is:
  - a Jinja template,
  - used to generate semantic conventions,
  - using weaver.
  For doc on the template syntax:
  https://jinja.palletsprojects.com/en/3.0.x/
  For doc on the semantic conventions:
  https://github.com/open-telemetry/semantic-conventions
  For doc on weaver:
  https://github.com/open-telemetry/weaver
#}
@lquerel lquerel added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 1, 2024
@jsuereth
Copy link
Contributor

As a thought - if someone wanted to investigate setting up https://rust-lang.github.io/mdBook/ that'd be amazing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

2 participants