taskgNewSense GNU/Linux - Tasks: task #12772, Add basic structure to organize...


You are not allowed to post comments on this tracker with your current authentication level.

task #12772: Add basic structure to organize wiki documentation by version

Submitted by:  -Deleted Account- <sirgazil>
Submitted on:  Mon 19 Aug 2013 04:31:25 PM UTC  
Should Start On:  Mon 19 Aug 2013 05:00:00 AM UTC Should be Finished on:  Mon 19 Aug 2013 05:00:00 AM UTC
Category:  Documentation Priority:  5 - Normal
Status:  Done Privacy:  Public
Assigned to:  -Deleted Account- <sirgazil> Open/Closed:  Closed

Tue 20 Aug 2013 03:49:54 PM UTC, comment #1: 

This task is done.

User documentation now has the basic structure to separate content by system version [1].

Guidelines for documentation writers [2] were updated with the new conventions for managing wiki documentation.

[1]: http://www.gnewsense.org/Documentation
[2]: http://www.gnewsense.org/DocumentationTeam/Guidelines

-Deleted Account- <sirgazil>In charge of this item.
Mon 19 Aug 2013 04:31:25 PM UTC, original submission:  

Currently, documentation writers are updating existing gNewSense 2.x documentation pages instead of creating new pages for gNewSense 3.

Add a basic structure to the wiki so that users can browse the user documentation by version, and writers can work on past, current and future documentation at the same time.

This change was already discussed in the developers mailing list [1].

Structuring details

1. The following URL format will be used to separate documentation by version:



   For example, the URLs for gNewSense 2.x and gNewSense 3.x would be:


2. Pages belonging to a particular version must be created as subpages of the
   appropriate version to encourage the good use of the breadcrumbs feature.


   For example, the installation manual for gNewSense 3 would use the following



   If the Installation Manual has a page that explains how to create a Live DVD,
   the URL for this page could be:



3. When planning a new major version of the system, MoinMoin CopyPage action [2]
   can be used to generate the base documentation for the future version of
   gNewSense. The CopyPage action allows to copy a page with all its subpages
   and conserve the editing history [3].


   For example, to generate gNewSense 4 documentation, the following page
   would be copied with all its subpages




   And renamed to



   Note that the CopyPage action is not enabled by default in MoinMoin and has
   to be activated in MoinMoin configuration file [3].

4. Guidelines for documentation writers [4] must be updated, so that they are
   aware of these changes for managing wiki documentation.

[1]: http://lists.nongnu.org/archive/html/gnewsense-dev/2013-08/msg00035.html
[2]: http://www.gnewsense.org/HelpOnActions
[3]: http://lists.nongnu.org/archive/html/gnewsense-dev/2013-08/msg00048.html
[4]: http://www.gnewsense.org/DocumentationTeam/Guidelines

-Deleted Account- <sirgazil>In charge of this item.


No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by sirgazil (Submitted the item)



    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-08-20 sirgazil Open/ClosedOpen => Closed
    2013-08-20 sirgazil StatusIn Progress => Done

    Back to the top

    Powered by Savane 3.5