You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@spamassassin.apache.org by bu...@bugzilla.spamassassin.org on 2005/11/09 22:15:46 UTC
[Bug 4679] New: Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
Summary: Bayes is undocumented in README, USAGE, INSTALL and
UPGRADE
Product: Spamassassin
Version: SVN Trunk (Latest Devel Version)
Platform: Other
URL: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=276325
OS/Version: other
Status: NEW
Severity: normal
Priority: P5
Component: Documentation
AssignedTo: dev@spamassassin.apache.org
ReportedBy: spamassassin@packages.debian.org
There is no explanation of what Bayes is or how it works in README (or any of
the other text files). There is a very small reference to perldoc sa-learn, but
it could easily be missed.
We really need to improve our documentation
Specifically, where is the "200 ham, 200 spam" requirement documented, for example.
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From jgmyers@proofpoint.com 2005-11-22 17:53 -------
(In reply to comment #4)
> So why not write a routine to scrape the Wiki on the day of release and
> stick the pages into files in the release tree?
That removes a key advantage of the Wiki: that it continues to be updated after
the release.
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From duncf@debian.org 2005-11-11 04:12 -------
Describing what a major part of the functionality does is hardly task-based. I
really would like to see a useful set of documents distributed with the source.
Having said that, I definitely dont have the time to construct such a set, so I
expect this bug to remain open for a while. ;-)
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From schulz@adi.com 2005-11-22 15:21 -------
The following email did not make it into the bug as a comment, so here it is.
> 'As a collaborative documentation platform, the wiki has already proved
> much more
> effective than our SVN codebase.'
So why not write a routine to scrape the Wiki on the day of release and
stick the pages into files in the release tree?
Loren
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From jm@jmason.org 2005-11-10 00:30 -------
I think we should just slim down the distributed file-based docs (README,
UPGRADE, INSTALL etc.) to the bare minimum, go into (painful) detail on the
wiki, and do everything possible to ensure that installers read that instead.
As a collaborative documentation platform, the wiki has already proved much more
effective than our SVN codebase.
(However, reference docs should still be maintained as POD on the modules and
scripts. I'm just talking about the task-based documentation parts.)
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
Re: [Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by Loren Wilton <lw...@earthlink.net>.
> 'As a collaborative documentation platform, the wiki has already proved
much more
> effective than our SVN codebase.'
So why not write a routine to scrape the Wiki on the day of release and
stick the pages into files in the release tree?
Loren
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From jm@jmason.org 2005-11-11 04:32 -------
I'll repeat:
'As a collaborative documentation platform, the wiki has already proved much more
effective than our SVN codebase.'
that's the key point IMO.
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4679] Bayes is undocumented in README, USAGE, INSTALL and UPGRADE
Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=4679
------- Additional Comments From jm@jmason.org 2005-11-22 20:29 -------
'So why not write a routine to scrape the Wiki on the day of release and
stick the pages into files in the release tree?'
fwiw, we are probably going to have to do something like this anyway, since the
README files etc. have already found their way into the wiki:
http://wiki.apache.org/spamassassin/BetterDocumentation/ReadmeTxt
http://wiki.apache.org/spamassassin/BetterDocumentation
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.