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: Add rule conditions documentation #951

Merged
merged 12 commits into from
Dec 18, 2023
Merged

docs: Add rule conditions documentation #951

merged 12 commits into from
Dec 18, 2023

Conversation

kentquirk
Copy link
Contributor

@kentquirk kentquirk commented Dec 14, 2023 •
edited
Loading

Which problem is this PR solving?

  • We need a lot more documentation on how rules work and in particular how the conditions work. We've never had anything other than the rules_complete file. This is an attempt to fix that.

Short description of the changes

  • Establish a structure
  • Write stuff

@kentquirk kentquirk changed the title doc: rules operators docs: Add rule conditions documentation Dec 14, 2023
@kentquirk kentquirk requested a review from mjingle December 17, 2023 23:53
@kentquirk kentquirk marked this pull request as ready for review December 17, 2023 23:55
@kentquirk kentquirk requested a review from a team as a code owner December 17, 2023 23:55
@kentquirk kentquirk added this to the v2.3 milestone Dec 17, 2023
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
mjingle
mjingle reviewed Dec 18, 2023
View reviewed changes
rules_conditions.md Outdated Show resolved Hide resolved
@mjingle mjingle self-requested a review December 18, 2023 17:20
mjingle
mjingle approved these changes Dec 18, 2023
View reviewed changes
Copy link
Contributor

@mjingle mjingle left a comment

Choose a reason for hiding this comment

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

🎉 Looks great! Thank you for this new documentation!

cartermp
cartermp approved these changes Dec 18, 2023
View reviewed changes
Copy link
Member

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

Overall looks good, just a question

rules_conditions.md Show resolved Hide resolved
rules_conditions.md Show resolved Hide resolved
@kentquirk kentquirk merged commit 3048734 into main Dec 18, 2023
3 checks passed
@kentquirk kentquirk deleted the rules_operators_doc branch December 18, 2023 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cartermp cartermp cartermp approved these changes

@mjingle mjingle mjingle approved these changes

Assignees

@kentquirk kentquirk

@VinozzZ VinozzZ

Labels
None yet
Projects
None yet
Milestone
v2.3
Development

Successfully merging this pull request may close these issues.
4 participants
@kentquirk @mjingle @cartermp @VinozzZ