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

[rsiddharth]

On Fri, Aug 16, 2013 at 03:58:29PM -0500, Felipe Lopez wrote:
> Hi,
> 
> I've been thinking that it may be easier for users to browse the
> documentation by version. And it would probably make it easier for
> documentation writers to work on past, current and future documentation at
> the same time. So, for example, some writers could work on gNewSense 4
> documentation without altering current gNewSense 3 documentation.
> Currently, documentation writers are updating existing gNewSense 2.x
> documentation pages instead of creating new pages for gNewSense 3.

Looks like a very good idea.

> 
> We could use a URL structure like the following:
> 
>     /Documentation/GNS_VERSION/SECTION_NAME/PAGE_TITLE
> 
> So, for example, the installation instructions for gNewSense 3 would be
> located at:
> 
>     /Documentation/Version3/InstallationManual/Introduction

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

> If this change in documentation structure is implemented, the current
> documentation page [1] would list documentation sets by version. For
> example:
> 
> ________________
> 
> Documentation
> 
> This section contains current and archived manuals for gNewSense users.
> 
> If you notice any errors or omissions in the documentation, please report
> to them to [GNS_BUG_TRACKER] or [join the Documentation team] to help us
> improve it.
> 
> * gNewSense 3 "Parkes" (current)
> * gNewSense 2 "deltah" (outdated)
> ________________

Yes, Docs page will look cleaner.

Period. 

Also, we need to have consensus on, what/what not, to document in the
gNewSense Wiki.

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

I think, the Wiki must contain *only* gNewSense specific
documentation, that way we can make good use of time & space.


[3]: http://gnewsense.org/Documentation/GIMP
[4]: http://gnewsense.org/Documentation/Emacs

Thanks for paying heed.
-- 
rsiddharth <http://rsiddharth.ninth.su>
gpg public key: http://rsiddharth.ninth.su/rsd-pub-key.asc
fingerprint: 7E7E 9403 8F39 796E D9AB  5923 E867 2A45 B6AD 4643

signature.asc
Description: Digital signature