Skip to content

Commit

Permalink
docs: Refinery Config copyediting (#734)
Browse files Browse the repository at this point in the history
## 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

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

---------

Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
  • Loading branch information
mjingle and kentquirk authored Jun 22, 2023
1 parent cb1a436 commit e564559
Showing 1 changed file with 414 additions and 394 deletions.
Loading

0 comments on commit e564559

Please sign in to comment.