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

[Karl Goetz]

On Sat, August 17, 2013 06:28, 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.

I was sure this had been brought up in the past, but I can't find
references. Still, its good to seee it come up again.

> 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

I'd rather not say 'Version3', rather say '3.0' or similar - just a
comment on style for thought :) Continuing to think out loud, I'm
wondering if it would be easier/saner to simply have oldstable/stable/dev
documentation and pages can be renamed when appropriate. Since there might
be good uses for permalinks oldstable/stable/dev could be redirect pages
to the relevant release?

> With this structure, the new breadcrumbs feature in the wiki could make it
> easier for the user to navigate as well.
...
> I wanted to ask first what you think, before opening a task in Savannah
> [2]
> to implement it.
>
> So, What do you think?

My main concern is needing to duplicate (potentially) large tracts of
documentation across versions where steps are almost identical.
What happens in this case?

thanks,
kk

-- 
http://www.kgoetz.id.au
>From Webmail