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

docs: Refinery Readme improvements #837

Merged
merged 14 commits into from
Dec 4, 2023
Merged

docs: Refinery Readme improvements #837

merged 14 commits into from
Dec 4, 2023

Conversation

mjingle
Copy link
Contributor

@mjingle mjingle commented Aug 9, 2023

Which problem is this PR solving?

This PR updates the Refinery README file, based on feedback and on the content currently lives in https://docs.honeycomb.io/manage-data-volume/refinery/

Short description of the changes

Changes include:

  • Update from .toml to .yaml file
  • Sampling Types descriptions and examples
  • Improve Troubleshooting Configuration section
  • Improve Dry Run Mode section

mjingle added 9 commits August 2, 2023 15:00
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
's doc PR changes

Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle mjingle added the wip Work In Progress label Aug 9, 2023
@mjingle mjingle requested a review from a team as a code owner August 9, 2023 15:47
mjingle added 3 commits August 9, 2023 12:05
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle mjingle added type: documentation and removed wip Work In Progress labels Aug 9, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
@mjingle mjingle requested a review from kentquirk December 4, 2023 20:44
Copy link
Contributor

@kentquirk kentquirk left a comment

Choose a reason for hiding this comment

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

Thank you for your help!

@kentquirk kentquirk merged commit 942ebb1 into main Dec 4, 2023
3 checks passed
@kentquirk kentquirk deleted the mj.ReadmeEnhancements branch December 4, 2023 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants