Skip to content

docs: SpamAssassin ENV docs refactor#3756

Merged
polarathene merged 12 commits intomasterfrom
chore/log-correct-sa-env-for-inbox
Jan 8, 2024
Merged

docs: SpamAssassin ENV docs refactor#3756
polarathene merged 12 commits intomasterfrom
chore/log-correct-sa-env-for-inbox

Conversation

@polarathene
Copy link
Copy Markdown
Member

@polarathene polarathene commented Jan 7, 2024

Description

  • ENV name logged was incomplete (SPAM_TO_INBOX=1).
  • SA related ENV docs revised.
    • Some use of two separate lists (ordered/unordered mix or not) would be merged by the markdown renderer (mkdocs one isn't particularly good for lists), even with the blank line to separate them. Worked around issue with content to separate the lists.
    • More details for settings, notably SA_KILL, linked references to other related ENV.
    • SA_KILL existing admonition about quarantine and ONE_DIR was introduced in Aug 2019. Revised.
  • An rspamd focused PR introduced an invalid 'warning' log level missed in review, this has been corrected to 'warn'.

Fixes: #2491


References:

Type of change

  • Improvement (non-breaking change that does improve existing functionality)

Checklist:

  • New and existing unit tests pass locally with my changes
  • I have added information about changes made in this PR to CHANGELOG.md

@polarathene polarathene added area/scripts kind/improvement Improve an existing feature, configuration file or the documentation area/documentation service/security/spamassassin labels Jan 7, 2024
@polarathene polarathene added this to the v14.0.0 milestone Jan 7, 2024
@polarathene polarathene self-assigned this Jan 7, 2024
@polarathene polarathene changed the title chore: Log SPAMASSASSIN_SPAM_TO_INBOX=1 ENV correctly docs: SA ENV + Log SPAMASSASSIN_SPAM_TO_INBOX=1 ENV correctly Jan 7, 2024
georglauterbach
georglauterbach previously approved these changes Jan 7, 2024
casperklein
casperklein previously approved these changes Jan 7, 2024
Comment thread docs/content/config/environment.md Outdated
- **2.0** => add spam info headers if at, or above that level
- **2.0** => add 'spam info' headers at, or above this level

Mail is not yet considered spam, but for purposes like diagnositcs it can be useful to identify mail with a spam score from a lower bound than `SA_TAG2`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Mail is not yet considered spam, but for purposes like diagnositcs it can be useful to identify mail with a spam score from a lower bound than `SA_TAG2`.
Mail is not yet considered spam, but for purposes like diagnostics it can be useful to identify mail with a spam score from a lower bound than `SA_TAG2`.

Comment thread mailserver.env Outdated
Comment thread docs/content/config/environment.md Outdated
@polarathene
Copy link
Copy Markdown
Member Author

At this point, the content is probably sufficient to migrate into it's own dedicated docs page (and pull in related FAQ items) 😝

Maybe if I find the time to reorganize the docs better I'll get around to that.


Thanks for the review catching those typos 🙏

Happy with this now, enabling auto-merge 🚀

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 8, 2024

Documentation preview for this PR is ready! 🎉

Built with commit: 5dafd4b

@polarathene polarathene enabled auto-merge (squash) January 8, 2024 01:54
@polarathene polarathene changed the title docs: SA ENV + Log SPAMASSASSIN_SPAM_TO_INBOX=1 ENV correctly docs: SA ENV docs refactor Jan 8, 2024
@polarathene polarathene changed the title docs: SA ENV docs refactor docs: SpamAssassin ENV docs refactor Jan 8, 2024
@polarathene polarathene disabled auto-merge January 8, 2024 01:55
@polarathene polarathene enabled auto-merge (squash) January 8, 2024 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation area/scripts kind/improvement Improve an existing feature, configuration file or the documentation service/security/spamassassin

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SA_KILL does not superseeds SPAMASSASSIN_SPAM_TO_INBOX

3 participants