Re: [Gnewsense-dev] Organizing wiki documentation by version

[Andrew R .]

rsiddharth wrote:
> To keep the URLs short, we might avail the 'Catogories' feature.
> 
> The gNewSense Packaging/Developement documentation[1][2] makes use of
> this feature.
> 
> [1]: http://gnewsense.org/CategoryPackaging [2]: 
> http://gnewsense.org/CategoryDevelopment
> 
> If we use 'Catorgies', the URL structure might look like:
> 
> /Documentation/gNS_VERSION/FOO_BAR

There are arguments either way for strict hierarchy versus category
tagging. I don't mind either way. But it would be nice for some
consensus on how this is done, or we will end up with different styles
of organising documentation.

> For instance, I feel the Documentation for GIMP[3], Emacs[4] 
> redundant, as the official documentation for these packages are good
>  enough.

+1.

Felipe Lopez wrote:
> Sometimes I'd like to be a dictator and make the documentation team 
> use a DVCS [2], Sphinx [3] and RTD [4] for easier publishing :P Or 
> use DVCS and Mallard [5] to have all the documentation integrated in 
> the operating system itself (by the way, I gave Sam a documentation 
> template [6] written in Mallard).

Maybe. But having some sort of online viewer is also essential, IMHO.
VCS permissions would have to be relaxed to be more wiki-like as well,
otherwise it would deter contributors. I'm not so sure how well others
would welcome such a move. I do see your point though.

Karl Goetz wrote:
> One reason for moinmoin at thed time was it could import and export 
> various formats which we could integrate with system documentation if
> desired.

That would be nice. I am planning on doing something similar to this for
my own trisquel-docs package (I'll probably start with a PPA) in
Trisquel land, integrated with the gnome-docs package.

Got to go,

-- 
Andrew Roffey     http://andrew.roffey.org
GPG fingerprint   F9E6 E6C4 0080 85F4 0E30 B0D9 7F7B DC7F 9657 B073