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:
/Documentation/DISTRO_MAYOR_NUMBER
For example, the URLs for gNewSense 2.x and gNewSense 3.x would be:
/Documentation/3
/Documentation/2
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
URL:
/Documentation/3/InstallationManual
If the Installation Manual has a page that explains how to create a Live DVD,
the URL for this page could be:
/Documentation/3/InstallationManual/CreatingALiveDVD
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
/Documentation/3
And renamed to
/Documentation/4
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
|