Docs
This team is now deprecated. Official announcement about the team's closure can be found here. |
|
|
|
|
Next Meeting: To be determined. Meetings in 
Ubuntu Help and Support IRC Channel: Path: Documentation
About Us
The Documentation Path gets you get started helping with the Ubuntu Dcumentation We are here just to guide you and answer questions. The team that does the actual work is the Documentation Team This team works on both the Community Wiki and the System Documentation.
There are three main areas, the two main wikis and the system documentation:
Help.Ubuntu/Community - The main community wiki for help documents for Ubuntu.
Ubuntu Wiki - This wiki is now used for organizational work, proposals and all materials not belonging to main wiki. Usually this is stuff associated with community teams, but not exclusively
System Documentation - This is the documentation that comes with Ubuntu, information on it can be found at the link. It's no more involved than doing work on the wiki, don't let the name scare you.
Getting Started
We are working on the Community Docs with the following goals:
Use the Tag functionality throughout the community docs to mark pages that need attention.
Work on improving the tagged pages, specifically for Needs Expansion, Content Cleanup, Style Cleanup, and Page Too Long.
The Wiki Cleanup offers good advice on cleaning up common problems.
Orphaned Pages - These are pages with nothing linking to them. Help them find friends! Tag and update as needed.
Other Wiki tasks listed at DocumentationTeam/Wiki/Tasks
As an aside for those interested, work on System Documentation bugs
See DocumentationTeam/SystemDocumentation for more information on how.
Bear in mind that we need to update/change all GeoCites links since they are now all deleted.
- New LTS release, updates on Ubuntu (Unity) Kubuntu, Xubuntu and Lubuntu, keyboard shortcuts etc.
Contact Us:
Please visit our IRC channel #ubuntu-beginners-team on Freenode to talk/know about Beginners team. You can also reach us by using the mailing list.
Required and Recommended Reading
To get a good grasp of what we do, please CAREFULLY READ through the following documents in order and ask anyone on the team if you have any questions. Note, these link only to the top level page, there are numerous sub pages that you should also read and understand. These pages are:
Required
Recommended
Editing the Wiki
A launchpad account is required, this will be used to sign in on both wikis to edit. This mandatory registration allows tracking and prevents malicious edits. Launchpad itself has many other uses associated with contributing to the community you can discover on your own.
Note - Ensure you have cookies enabled, so your login is stored.
Once signed in, go to either of the two wikis above and click Log In at the top. You will be prompted to authenticate via launchpad, proceed and your done. You can now make edits to the wikis.
Once logged into the Main Community Wiki, you'll notice a small bar at the bottom. This is the edit bar, it holds many options for manipulating pages. Explore and test them out while being careful not to do anything undesirable to pages.
Guidelines and Common Practices
Now that your set up to edit, it's important to know what to do. The wiki uses markup, to manipulate the text. Markup is a simple collection of special characters used to instruct the wiki system how to format pages. This allows for bold text or underlining to occur or something more complex like creating tables.
Required Reading:
Wiki Guide - A set of pages explaining markup and general formatting, read all of them thoroughly.
Formatting Guide - Pay special attention to this page, it and it's sub pages that deal with how the formatting works.
The Writing Guide and Style Guide - Offer insight into how pages should be written stylistically.
Icons - Images can be useful when properly worked into a page.
Wiki Sandbox - A sandbox, experiment with markup and editing tools as you like. The best learning is done hands on.
Communication - A few extra pointers on staying in contact and courtesy.
Advanced Recommended Reading:
Style Guide References - Additional materials on technical and documentation writing.
The Tag System - Used throughout the main wiki to mark what needs reviewing.
Deletion and Renaming - Such tasks are only done by admins, but it is best if you make their lives easier. There are only a few.
Redirecting - Can be useful to redirect pages or common alternate names to a main page.
EditMoin - Some prefer to edit the wiki pages from a desktop text editor, this package allows you to do so.
Macros - How to use macros.
System Documentation
Members interested in contributing to the system documentation should review the following links that are of interest, in addition to the System Documentation page mentioned before.
Repository - Explanation of the repository, where all the docs are located and how they are maintained.
Bazaar in five minutes - A quick start up guide for new users to using the version system bazaar.
Reviewing Documentation - Quick checklist for reviewing docs.
Tech Review - Explanation of the review process.
Tech Review Example - An example of review process, see Repository section for patching and submission process.
Joining the Team
To join the Beginners Team and begin your journey on working on Ubuntu Documentation see the Join Us page.
Past Efforts by BT to help as a team with wiki documentation
Summer of Documentation 2011
Summer of Documentation 2010
Summer of Documentation 2009
Summer of Documentation 2008
| /SoD2008 /SoD2009 /SoD2010 /SoD2011 |