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

Use of outdated collector API version in documentation #2090

Closed
Chinwendu20 opened this issue Dec 11, 2022 · 7 comments
Closed

Use of outdated collector API version in documentation #2090

Chinwendu20 opened this issue Dec 11, 2022 · 7 comments
Labels
bug Something isn't working sig:collector

Comments

@Chinwendu20
Copy link

I can see the documentation is based on version 0.53 of the collector API. I have opened this issue to discuss if the documentation should just reflect the latest version of collector API or better still there should be documentation for every collector release.

@Chinwendu20 Chinwendu20 added the bug Something isn't working label Dec 11, 2022
@cartermp
Copy link
Contributor

In general I think the docs should use only the latest APIs. Right now the collector is still (technically) pre-release, and so we can expect any number of further breaking changes to the API until such a time that it's considered stable. Since those older APIs won't be supported, it's not worth documenting how to use them.

@svrnm
Copy link
Member

svrnm commented Dec 12, 2022

I can see the documentation is based on version 0.53 of the collector API.

where do you see use of 0.53 collector? We try to auto-update the collector versions on release, so if the version is hardcoded somewhere we should fix that.

@Chinwendu20
Copy link
Author

I was following the tutorial for creating a trace receiver and I discovered a disparity between the collector API used and the most recent one the hyperlinks to the source code also points to v0.53:

image

It was also written here:
image

I have however implemented the trace receiver tutorial with v0.66 of the colector API

@svrnm
Copy link
Member

svrnm commented Dec 13, 2022

thanks, we will need to take the collector version variable we have in the getting started and use it in that page as well

@chalin
Copy link
Contributor

chalin commented Dec 13, 2022

We should avoid duplicating version info. I've updated the following umbrella issue with proposed solutions:

@svrnm
Copy link
Member

svrnm commented Dec 14, 2022

We should avoid duplicating version info. I've updated the following umbrella issue with proposed solutions:

Agreed.

@chalin
Copy link
Contributor

chalin commented Feb 3, 2023

I'm going to close this since the problems reported here will be addressed (in part) and/or tracked elsewhere:

If you think that something isn't covered by the items above, comment here.

@chalin chalin closed this as completed Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working sig:collector
Projects
None yet
Development

No branches or pull requests

4 participants