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

docs: Refinery Config copyediting #734

Merged
merged 9 commits into from
Jun 22, 2023
Merged

docs: Refinery Config copyediting #734

merged 9 commits into from
Jun 22, 2023

Conversation

mjingle
Copy link
Contributor

@mjingle mjingle commented Jun 21, 2023 •
edited
Loading

Which problem is this PR solving?

This PR hopes to make the generated config.yaml file and associated documentation the best that it can be.

Short description of the changes

  • Standardize on capitalization for Refinery, Redis, Stress Level
  • Add codeblock formatting for fields
  • Check on TODOs found (refer to tagged PR comments)
  • Clarify existing wording
  • Use OpenTelemetry (OTel) consistently throughout config file without being obnoxious
  • Consider Groups descriptions
  • Word Wrap descriptions
  • Reduce duplicate field summary vs. field descriptions.

@mjingle mjingle added the wip Work In Progress label Jun 21, 2023
@mjingle mjingle requested a review from a team as a code owner June 21, 2023 22:49
@mjingle mjingle removed the wip Work In Progress label Jun 22, 2023
kentquirk
kentquirk approved these changes Jun 22, 2023
View reviewed changes
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 so much.

mjingle added 8 commits June 22, 2023 17:13
@mjingle @kentquirk
Copyediting first pass with word wrap
2ee7770 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Remove TODO mentions and incorrect version references
70e43d1 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Additional formatting fixes
2713062 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Restore v2 description as they're commented out when generated
24a4078 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Modify group descriptions to add Refinery section name header
50a5e60 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Standardize OTel/OpenTelemetry mentions to OpenTelemetry when relevant
4ec8f52 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
Reduce duplication in field summary and description
8d115d4 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@mjingle @kentquirk
One last pass
7371393 
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
@kentquirk kentquirk merged commit e564559 into main Jun 22, 2023
@kentquirk kentquirk deleted the mj.ConfigReview branch June 22, 2023 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kentquirk kentquirk kentquirk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mjingle @kentquirk