gnewsense-dev
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Gnewsense-dev] Organizing wiki documentation by version


From: Felipe Lopez
Subject: [Gnewsense-dev] Organizing wiki documentation by version
Date: Fri, 16 Aug 2013 15:58:29 -0500

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.

[video]:

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

With this structure, the new breadcrumbs feature in the wiki could make it easier for the user to navigate as well.

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)
________________

I wanted to ask first what you think, before opening a task in Savannah [2] to implement it.

So, What do you think?


[1]: http://www.gnewsense.org/Documentation
[2]: https://savannah.nongnu.org/task/?group=gnewsense

--
Felipe Lopez
http://sirgazil.info/

reply via email to

[Prev in Thread] Current Thread [Next in Thread]