docs: refinery_rules.md #802
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RainofTerra
changed the title
|
@kentquirk I would be down for modifying the generated docs template to incorporate @RainofTerra's suggestions! :) |
mjingle
reviewed
Jul 20, 2023
| @@ -7,7 +7,8 @@ It was automatically generated {{ now }}. | |||
| ## The Rules file | |||
|
|
|||
| The rules file is a YAML file. | |||
| Here is a simple example of a rules file: | |||
| Below is a simple example of a `rules` file. | |||
| View a [complete example](https://github.com/honeycombio/refinery/blob/main/rules_complete.yaml). | |||
There was a problem hiding this comment.
@kentquirk Not sure if the templates can support markdown format for links or not... Is this possible or what should be used instead?
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
kentquirk
force-pushed
the
terra.rules_doc_update
branch
from
b79b9ff to
263b5b7
Compare
kentquirk
approved these changes
Aug 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
DatatypeShort description of the changes
rules_complete.yamlfile since that file can be helpful in understanding what a full rules yaml file might look like, and adds the list of valid values forDatatype'Fixes #804