Tagging wiki pages with Ubuntu version numbers

[Wesley Schwengle]

All,

On 08-12-13 10:58, Hannie Dumoleyn wrote:
> Here are some of my thoughts, for what they are worth (maybe it is not
> feasible).
>
> I agree that it is better if a wiki page is written in such a way that
> it can be used in all versions. Unfortunately, that is not always
> possible. Here are some ideas I have on this:
> 1. Guidelines for wiki page writers: try to make it as generic as
> possible/avoid mentioning version number unless the contents is
> specifically meant for that version/other advice?
> 2. Tagging: Add a selection box with version numbers to all new wiki
> pages where the default is "All versions". The writer can choose
> another version number here, but only if the page is written for that
> version only.
> 3. Check wiki pages on a regular basis to see if the contents is still
> valid for "All versions". This is the most difficult and time
> consuming task which could be done by community wiki team members.
> Perhaps the bulk of wiki pages can be divided in smaller portions
> (subjects, alphabetically, categories?) so that team members can check
> a certain number of subjects/pages.

I agree with most of it. Although I wouldn't write guides for Ubuntu
versions, write them for the package version. If a major release of a
certain package breaks the docs, you need to change it. Minor releases
are often backwards compatible. So your docs are safe. In case a major
release is done, you need to update the docs (only for that specific
release/version). You can have a main page eg.

OpenSSHD:
   A lot of nifty details regarding OpenSSH and its daemon and client.
   You can even talk about details for a specific version and refer to
the subpage.

OpenSSHD/Version_X.y:
     a sub page describing the details with specific details for that
release

OpenSSHD/Version_Y.z
     a sub page describing the details with specific details for that
release

Perhaps prior to an Ubuntu release (when the alpha does live or pick any
date) a script checks all the tags on a page (version of the
package/Ubuntu) and can notify the doc team about issues. I don't think
a human should check all the pages, that can be automated. You can also
check if pages do not have a tag and notify the doc-team so these pages
can be tagged.
I think that will decrease the workload of having to check pages.

Cheers,
Wesley
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20131208/6decd933/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 263 bytes
Desc: OpenPGP digital signature
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20131208/6decd933/attachment.pgp>