SA Bugzilla – Bug 4771
website improvement: database of detailed rule descriptions
Last modified: 2006-12-04 11:17:22 UTC
It'd be nice to have a way for users/admins/interested parties to have an easy way to look up a human-readable description of rules, based on the rule name; something like: RCVD_IN_NJABL_DUL A sending IP address is listed in the NJABL [link] blocklist as a member of an ISP's dynamic IP address pool. Normally these addresses should not deliver mail directly to other ISPs. (Click [here] for more info on dynamic IP pools.) An easy way to implement this would be simply to use a prefix on wiki.apache.org/spamassassin, e.g. have the above as http://wiki.apache.org/spamassassin/Rules/RCVD_IN_NJABL_DUL Moin has good support for templates; for example, see http://moinmoin.wikiwikiweb.de/MoinMoinPatch and the way it creates subpages for patches using a standardized patch-page template. Doing a lookup of that would be pretty trivial; a CGI that simply redirects to "http://wiki.apache.org/spamassassin/Rules/"+$rulename. I wouldn't expect all the rules to be given description pages, but some could do with them, and we don't have a lot of info there right now.
here's a template for those pages: http://wiki.apache.org/spamassassin/RuleDescriptionTemplate -- and a demo list page: http://wiki.apache.org/spamassassin/RulesList .
*** Bug 5213 has been marked as a duplicate of this bug. ***
ok, this has been implemented on the site as of today; go forth and wikify, anyone who fancies documenting some of the more confusing rules ;)