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.

Sign up for GitHub

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

Jump to bottom

Review and improve component package #3049

Closed
bogdandrutu opened this issue Apr 28, 2021 · 6 comments
Closed

Review and improve component package #3049

bogdandrutu opened this issue Apr 28, 2021 · 6 comments
Assignees
@bryanuribe
Labels
area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release
Milestone
Phase1-Trace-GA-R...

Comments

@bogdandrutu
Copy link
Member

bogdandrutu commented Apr 28, 2021 •
edited
Loading

This is an umbrella issue for feedback and improvements for the component package.

Godoc: https://pkg.go.dev/go.opentelemetry.io/collector@v0.26.0/component

Things that we should look for:

  1. Can we avoid exposing publicly some of the APIs? Better to have less public APIs.
  2. Can we improve the names of the public APIs?
  3. Can we improve the documentation of the package/public APIs?
@bogdandrutu bogdandrutu added this to the Phase1-GA-Roadmap milestone Apr 28, 2021
@rakyll rakyll mentioned this issue Apr 29, 2021
Merged
@alolita
Copy link
Member

alolita commented May 12, 2021

@bogdandrutu can this be closed - since PR #3015 has been merged.

@alolita
Copy link
Member

alolita commented May 12, 2021

@rakyll @mxiamxia does an overall description (doc.go) need to be added at the package level? See https://pkg.go.dev/go.opentelemetry.io/collector@v0.26.0/component

@bogdandrutu bogdandrutu mentioned this issue May 14, 2021
Closed
10 tasks
@alolita alolita added area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release labels May 18, 2021
@alolita alolita self-assigned this May 18, 2021
@alolita
Copy link
Member

alolita commented May 18, 2021

@bryanuribe is working on this issue.

@bryanuribe
Copy link
Contributor

I'll take a look at this!

@alolita alolita assigned bryanuribe and unassigned alolita May 18, 2021
@alolita
Copy link
Member

alolita commented May 20, 2021

Please see #2677 for more details on the component package.

This was referenced May 24, 2021
Closed
Closed
Closed
Merged
Merged
@alolita
Copy link
Member

alolita commented Jun 14, 2021

Completed.

@alolita alolita closed this as completed Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bryanuribe bryanuribe

Labels
area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release
Projects
None yet
Milestone
Phase1-Trace-GA-Roadmap
Development

No branches or pull requests
4 participants
@rakyll @bogdandrutu @alolita @bryanuribe