Ubuntu community wiki - Page lifecycle

Tom Davies tomdavies04 at yahoo.co.uk
Wed Aug 17 14:57:09 UTC 2011


Hi :)
I really like all of suggestion 1 except 1c which would be nice but seems a bit 
idealistic and unlikely to happen.  I didn't really understand 2 except that it 
seemed to demand a lot of work which might never happen.  So, i think suggestion 
1 is best (less work).  


The question remains about what to do with pages that may have a 
version-specific name but might contain generic instructions that are still 
valid.  Hopefully a quick skim-read might reveal that before deleting?  If the 
page shouldn't be deleted then remove the tag and leave the page?  If there is 
only a very limited amount of useful stuff which is buried in tons of ancient 
stuff then delete.  I don't really know how to deal with this and feel a bit 
overwhelmed tbh.  


Regards  from
Tom :)



________________________________
From: Manuel Buser <mail at manuelbuser.ch>
To: ubuntu-doc at lists.ubuntu.com
Sent: Sun, 31 July, 2011 14:46:53
Subject: Ubuntu community wiki - Page lifecycle

 Hi there

There has been some       discussion about deleting outdated pages in       
help.ubuntu.com/community.
I think that the many outdated pages discourage people to use the       wiki. 
AND: The lack of a concept for a "page lifecycle" may also       discourage many 
contributors from updating the pages, as it may       look like a "hopeless" 
task.
Or did I miss something here?

Different concepts are used (version-specific pages, e.g. 
https://help.ubuntu.com/community/InstallLirc/Maverick,       or one paragraph 
per version, e.g.: https://help.ubuntu.com/community/AiptekTablet)

I try to make some SUGGESTIONS. To be discussed.

SUGGESTION 1: Versioning guidelines.

Each page...
 
	*   1a) ...SHOULD be           valid for all Ubuntu releases that are currently 
documented.           (Avoid version-specific pages).
	*   1b) ...SHOULD NOT mention the Ubuntu version or codename           
("Natty") in its pagename.
	*   1c) ...SHOULD contain version icons [to be created] on the           top 
level, or below each 1st level heading, in order to show           the user for 
which versions the chapter is valid. 

	*   1d) ...SHOULD be           generic: If possible, cover all recent Ubuntu 
versions in the           same text, newest first.
	*   1e) ...SHOULD           contain titles referring to the Ubuntu version IF 
it is           necessary to re-write entire chapters for different versions.           
Newest first.

SUGGESTION 2: Archiving concept:

Any current page should cover the last 1 to 5 Ubuntu releases.       Pages 
should be cleaned as follows after each LTS (long       term support) release. 


  * 1) Copy the full page content to a new page, append "_v2010"       to its 
name: "v" means version and 2010 is the year in which the       page was last 
modified.
  * 2) Add an "Archived page" tag [to be created]: "Archived: This       page is 
archived. It should not be modified. More info..."
  * 3) Go back to the original page. Clean its contents: Remove       whatever 
refers to versions older than the previous LTS version.       In the first line, 
add a link: "Documentation for older Ubuntu       versions was moved to this 
[archive page]" [link to mypage_v2010].       (NB if the entire page was 
outdated, the original page would now       be empty. In this case, it is 
recommended to tag it either for       deletion, or for expansion)

This rule would       result in the following "page lifecycle":
- 2012, March: The page covers 11.10 / 11.04 / 10.10 / 10.04 (LTS)
- 2012, April: 12.04 (LTS) arrives. The page covers 5 versions:       12.04 
(LTS) / 11.10       / 11.04 / 10.10 / 10.04 (LTS).
- 2012, September: The page is "cleaned" to the last version       (12.04). 
Contents referring to 11.10, 11.04, 10.10, 10.04 go to       the "archive page".
- Content for new Ubuntu releases is added in 2012-Oct, 2013-Apr,       
2013-Oct. Then we start over.

Regards! Manuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20110817/86f9aaed/attachment.html>


More information about the ubuntu-doc mailing list