How to fix roundup.org's customizing.txt

"John P. Rouillard" <[email protected]>
Newsgroups gmane.comp.bug-tracking.roundup.devel
Message-ID <[email protected]>
Hi all:

I just checked in a fix to the customizing.txt documentation. One of
the examples stopped working sometime in the 1.4 release I think when
the new search permissions were added.

See the mailing list thread ending at:

  https://sourceforge.net/p/roundup/mailman/message/36408780/

The current head documentation is now correct. Any thoughts on how to
fix this on the web site?

I can't use the current head doc as it has a change to reference
things that are only applicable with the python 3 patches (the change
to using gpg rather than pyme for PGP signed email). Also I don't want
to grab the whole doc suite because of other incompatible changes.

I can branch from the 1.6.0 release and do the update, but I would
really like to keep all the changes in the head except for the
gpg/pyme change as the majority of them fix documentation issues
(obsolete URL's) that I couldn't fix in time for the 1.6.0 release.

As I see it I can do one of 3 things:

1) do nothing with the web site and leave the example in
   customizing.txt broken. Advantage: the online doc exactly matches
   the released doc and can be reproduced from hg. Disadvantage:
   people looking for a working example won't find it.

2) check out the current customizing.txt, manually roll back the gpg
   to pyme reference and publish.  Advantage: example works works and
   url's to supplimentary docs also work. Disadvantage: doc not in hg,
   doc doesn't match released 1.6.0 doc.

3) branch the doc in hg (to 1.6.0_branch), roll back the gpg/pyme
   change and publish that. Advantage: in hg and reproducable if we
   need to do another 1.6.x release not based on trunk, working
   example and url's.  Disadvantage: not the same as released 1.6.0,
   need to figure out how to do the required hg work.

Thoughts?

--
				-- rouilj
John Rouillard
===========================================================================
My employers don't acknowledge my existence much less my opinions.

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.