Summer of Documentation

Due to the success of the same effort that took place in 2009 and 2010, the 2011 Summer of Documentation will attempt to be another effort by a handful of Ubuntu Forums BeginnersTeam members to help get the Community Docs up to date by working with the Ubuntu DocumentationTeam, particularly the Wiki Team.

Major Work

Quality Control

In 2008, the Documentation Team started implementing the Tag system on the Community Docs. Last year we finished the transition from the old Category system to using Tags (with the help of some who did not contribute directly to the Summer of Documentation). This new system makes it easier for users to track what pages need attention on the wiki, and what type of attention is required.

Orphaned Pages

The fact that the wiki is open for anybody to work on, pages can easily get isolated from the rest of the existing documentation. One of the tasks this summer will be to help setup links to and from Orphaned Pages, which are pages that aren't linked to from anywhere else inside the wiki.

Contributing to the Project

Well if you're here you're probably assuming, "How do I help and contribute to this project?". Well here's how. When you've found a page you wish to edit/fix you'll first need to go and file a bug. Now at that you're probably thinking, "Isn't filing bugs for Ubuntu not the wiki?" Well, yes...but for this it makes it not only easier to track what is being worked on but also by who. So, the page you'll need to visit is here at: Summer of Documentation Bugs. So what you'll do is go to that page and then the info you'll need to include in your new bug will be:

• Name of the Page and the Page URL
• Does the page have any sub-pages? If so will you edit those as well?
• The nature of the bug. Is it a simple edit with spelling fixes? Or is a major edit? Or is it a complete overhaul and update.
• You'll need to then mark the bug according to the importance of the fix. High? Low? Not sure? If it's a help page mark it at least moderate.
• And finally, mark the bug accordingly. Is the fix released? Is it In Progress? Or is it an invalid bug? If so mark it appropriately!

Wiki Pages

Of course, a key component to getting the Community Docs up to date involved actually working on pages that were tagged for Cleanup and/or Expansion. These are pages that the BT members contributing to the SoD did heavy work on. It is by no means a complete list of the work done, but highlights some of this year's most visible achievements.

Closing

A message will be posted here at the conclusion of the project, this fall.

---

CategoryBeginnersTeam