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

[healthcheckv2extension] Document that extension is not ready for use #33313

Merged
merged 2 commits into from
May 30, 2024

Conversation

mwear
Copy link
Member

@mwear mwear commented May 30, 2024

Description:
Several users have tried to use this extension as the README makes it appear as though it's ready for use. I've updated
the README to include a warning and a note that the README is forward looking. I think it's useful to describe the functionality that the extension will provide when #30673 has been fully decomposed and integrated.

cc: @diranged @twistypigeon

Let me know if stronger wording is needed.

Link to tracking Issue: #33301

Documentation: README update

The PR that provides this functionality is being sliced up into smaller
chunks to facilitate review and are being integrated incrementally. We'll
remove this warning  when it's ready for use.
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a documentation-only change it probably doesn't require a changelog, but it's your call as code owner. 👍

@mwear mwear added the Skip Changelog PRs that do not require a CHANGELOG.md entry label May 30, 2024
@crobert-1 crobert-1 added the documentation Improvements or additions to documentation label May 30, 2024
@bogdandrutu bogdandrutu merged commit b6b1f13 into open-telemetry:main May 30, 2024
151 of 152 checks passed
@github-actions github-actions bot added this to the next release milestone May 30, 2024
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 extension/healthcheckv2 Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants