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

Create missing documents for projects #2088

Open
2 of 5 tasks
svrnm opened this issue May 3, 2024 · 7 comments
Open
2 of 5 tasks

Create missing documents for projects #2088

svrnm opened this issue May 3, 2024 · 7 comments

Comments

@svrnm
Copy link
Member

svrnm commented May 3, 2024

We have a few already running projects1 that do not have a document in the projects folder, main reason is because they pre-date the process. Can the GC liaisons work with the SIGs to (a) verify if a document is required (i.e. the SIG is "not permanent") and if so create those documents?

  • Client Instrumentation SIG (can be copied from this issue probably), @danielgblanco
  • Profiling SIG (can be copied from this issue probably), @mtwo, @open-telemetry/profiling-maintainers
  • System SemConv (can be copied from this issue probably), @svrnm, @open-telemetry/semconv-system-approvers
  • Prometheus Interoperability SIG, @alolita, @open-telemetry/wg-prometheus
  • Agent Management SIG, @tedsuo, @open-telemetry/opamp-spec-approvers (probably not required to have one?)

Please check the box if either your SIG does not match the need to require a document or when you have added the document to the folder.

Footnotes

  1. Picked them from https://github.com/orgs/open-telemetry/projects/29/views/1 during project triage session

svrnm added a commit to svrnm/community that referenced this issue May 3, 2024
@tigrannajaryan
Copy link
Member

Agent Management SIG

The SIG's work is actively in progress and there is no clear target when we can consider it "done". We can still add a project document if you prefer that. I don't have a strong opinion.

@danielgblanco
Copy link
Contributor

I think all these SIGs, with the exception of perhaps System SemConv, will be permanent. So, the SIGs themselves will not have a clear target to consider them "done". However, I think it'd still be valuable to have a set of deliverables as initial reason to create the SIG in the first place. Essentially a SIG bootstrap project.

@dashpole
Copy link

dashpole commented May 3, 2024

I'll write the document for the prometheus compatibility WG. I hope to wrap up the WG in the next few months.

@svrnm
Copy link
Member Author

svrnm commented May 6, 2024

Thank you all!

The SIG's work is actively in progress and there is no clear target when we can consider it "done". We can still add a project document if you prefer that. I don't have a strong opinion.

If the SIG is permanent (or very long running/with no clear end goal yet), I think we do not need a document.

@felixge
Copy link
Member

felixge commented May 6, 2024

If the SIG is permanent (or very long running/with no clear end goal yet), I think we do not need a document.

I think this will be the case for the profiling SIG. The initial goal is to turn profiling into a new stable signal type. But I think there will continue to be a need for a standing SIG to maintain the signal. So as far as I'm concerned, we can check the profiling SIG from the list above.

@svrnm
Copy link
Member Author

svrnm commented May 7, 2024

Since creating the document for the profiling SIG is probably as simple as copying this issue into a markdown file, I argue it's still nice to have (same applies to the client instrumentation SIG, which has such an issue as well).

@danielgblanco
Copy link
Contributor

Regarding the client-instrumentation SIG, there's in fact a single Project Document that was copied from the issue in #1584 but the spec issue was not closed at the time. I just closed open-telemetry/opentelemetry-specification#2734 with a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants