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: The generated docs for rules don't include the options for choices types #804

Closed
kentquirk opened this issue Jul 20, 2023 · 0 comments · Fixed by #802
Closed

docs: The generated docs for rules don't include the options for choices types #804

kentquirk opened this issue Jul 20, 2023 · 0 comments · Fixed by #802
Labels
type: bug Something isn't working
Milestone
v2.1

Comments

@kentquirk
Copy link
Contributor

We don't list anywhere the valid values for things in the rules file that have choices, like Operator.

Need to tweak the template and regenerate, and post to docs.
@kentquirk kentquirk added the type: bug Something isn't working label Jul 20, 2023
@mjingle mjingle mentioned this issue Jul 20, 2023
Merged
3 tasks
@kentquirk kentquirk added this to the v2.1 milestone Jul 27, 2023
kentquirk added a commit that referenced this issue Aug 1, 2023
@mjingle @kentquirk
docs: refinery_rules.md (#802)
f2fa512 
## Which problem is this PR solving?

- Documentation updates
  - [x] Link to complete refinery rules example
  - [x] generates options/choices for `Datatype`
  - [x] generates options/choices for all valid operators for conditions

## Short description of the changes

- This PR just adds a link to the `rules_complete.yaml` file since that
file can be helpful in understanding what a full rules yaml file might
look like, and adds the list of valid values for `Datatype`'

Fixes #804

---------

Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Co-authored-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: bug Something isn't working
Projects
None yet
Milestone
v2.1
Development

Successfully merging a pull request may close this issue.

docs: refinery_rules.md honeycombio/refinery
1 participant
@kentquirk