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.

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

Changes for writing_rules tutorial and similar material #503

Open
TonyGravagno opened this issue May 4, 2021 · 0 comments
Open

Changes for writing_rules tutorial and similar material #503

TonyGravagno opened this issue May 4, 2021 · 0 comments

Comments

@TonyGravagno
Copy link
Contributor

Ref : The section "Rule weights" implies a discussion of "weights". But the first line reads :

"Rule weights are usually defined in the metrics section and contain the following data: score triggers for different actions, symbol scores, symbol descriptions, symbol group definitions".

So, the specific topic of weights is just a part of the information covered. The general topic is more about the different ways available to define rules.

Also, from above: "score triggers for different actions" and "symbol scores", isn't that the same thing?


Suggestions:

  1. Rename this section to something like "Ways to define Rules".
  2. Where the text says "Define scores...", change to "Define symbols".
  3. Similarly, for this sentence: "Please bear in mind that the scores you define directly from Lua have lower priority and are overriden by scores defined in the groups.conf file. WebUI defined scores have even higher priority."
    • Change to "Please bear in mind that the symbols you define directly from Lua have lower priority and are overriden by symbols defined in other configuration files. WebUI defined symbos have even higher priority."
  4. Move and rename the section "Rspamd symbols" higher up in the doc to introduce concepts, and change the name to "Rspamd Rules", since that section describes rule types, including filters, and not just symbols.

In general, I'd like to make other changes like this, are we agreed that changes like this make sense?

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant