The process for updating documentation is exactly the same as updating the source - i.e. create a patch issue in Scarab that contains the actual patch to the documentation (the Turbine-2 Documentation module should be used). Issues that are created in Scarab are reported to the turbine-dev mailing list so that the committers are made aware of them and can commit or otherwise comment on them.
As has been stated elsewhere, xdoc is a very simple format. You can follow the lead of the existing documentation. I have also offered to format and submit to Scarab documentation content suggestions posted to this list (as did someone else). Cheers, Scott -- Scott Eade Backstage Technologies Pty. Ltd. http://www.backstagetech.com.au > From: "Mitch Christensen" <[EMAIL PROTECTED]> > Reply-To: "Turbine Users List" <[EMAIL PROTECTED]> > Date: Tue, 12 Nov 2002 07:46:56 -0800 > To: "Turbine Users List" <[EMAIL PROTECTED]> > Subject: RE: Documentation (was: Re: Thanks) > > I suspect we are using Anakia for generation of the Turbine site. If so, > any documentation must be formatted in XML, per the Anakia requirements. > Can someone validate this? > > What is mechanism for submission? If I write what I believe to be a > beneficial howto, who decides that it has applicability, and incorporates it > into the Anakia tree and regenerates the site? > > Could it be that lack of a formal process in the reason there is > insufficient/outdated documentation? > > -Mitch > > -----Original Message----- > From: Quinton McCombs [mailto:qmccombs@;nequalsone.com] > Sent: Tuesday, November 12, 2002 7:30 AM > To: Turbine Users List > Subject: Re: Documentation (was: Re: Thanks) > > > Another idea for documentation could be something similar to the Linux > Documentation Project. This would allow documents of varying scope. > For example a very small how-to could be on transactions. > > A much larger how-to could be on intake or extending the turbine schema. > > > On Mon, 2002-11-11 at 18:37, Scott Eade wrote: > >> Great. For new documents we should aim for at least an outline before > we >> add them as works in progress. If you intend working on these through > to a >> level of semi-completion then you should look at the existing xdocs > and use >> that format (it is really very easy). >> >> I can't recall where the xdoc documentation resides, bit it is fairly > easy >> to follow an example - e.g.: >> > http://cvs.apache.org/viewcvs/jakarta-turbine-2/xdocs/howto/extend-user- > howt >> o.xml?rev=1.7&content-type=text/vnd.viewcvs-markup >> >> Cheers, >> >> Scott > >> Quinton McCombs< > Strategic Planner, NEqualsOne > 1800 International Park Drive > Suite 205 > Birmingham, AL 35243 > p: 205.324.8005 x121 800.466.1337 > f: 205.324.7008 > e: [EMAIL PROTECTED] > www.NEqualsOne.com > > > > -- > To unsubscribe, e-mail: <mailto:turbine-user-unsubscribe@;jakarta.apache.org> > For additional commands, e-mail: <mailto:turbine-user-help@;jakarta.apache.org> > -- To unsubscribe, e-mail: <mailto:turbine-user-unsubscribe@;jakarta.apache.org> For additional commands, e-mail: <mailto:turbine-user-help@;jakarta.apache.org>
