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

Simple example repository #551

Open
garysassano opened this issue Jan 13, 2025 · 1 comment
Open

Simple example repository #551

garysassano opened this issue Jan 13, 2025 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@garysassano
Copy link

Background

Weaver is a powerful tool for developing, validating, documenting, and deploying semantic conventions and application telemetry schemas. However, its complexity can be a barrier for new users trying to understand its full potential.

Request

I would like to request the creation of a simple example repository that includes:

  1. Step-by-step instructions on setting up and using Weaver.
  2. A basic demo showing how to create a custom registry with attributes.
  3. Examples of how to generate code and documentation from semantic conventions.

Benefits

  1. Ease of Learning: A simple example would help new users quickly grasp the concepts and start using Weaver effectively.
  2. Consistency: Ensures that users can apply semantic conventions consistently across different languages and projects.
  3. Community Engagement: Encourages more developers to adopt Weaver by lowering the entry barrier.

Additional Context

Several users have expressed interest in a straightforward guide to using Weaver, as it would significantly reduce the learning curve. A practical example would be more effective than extensive documentation for many developers.

@lquerel lquerel added the help wanted Extra attention is needed label Jan 14, 2025
@lquerel
Copy link
Contributor

lquerel commented Jan 14, 2025

Overall, I can only agree with the idea of improving the discovery and onboarding experience for Weaver through examples and better documentation. I currently have a lot on my to-do list, which is why, for now, I’ll reach out to my teammates and other willing contributors who are already using Weaver to address this issue by adding the "help wanted" tag.

If nothing happens within a few weeks, I’ll find the time to address it myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

2 participants