getting started section
← Revision 44 as of 2015-01-09 18:41:02
|Deletions are marked like this.||Additions are marked like this.|
|Line 2:||Line 2:|
|Line 3:||Line 4:|
|One of the major tasks of the DocumentationTeam is to take care of the documentation which comes with every Ubuntu system, and is available from '''System''' -> '''Help and Support''' on an Ubuntu desktop.||= System Documentation =|
|Line 5:||Line 6:|
|The team also takes care of the system documentation available in Kubuntu, Xubuntu and Edubuntu and the Ubuntu Server Guide.||The main purpose of the [[https://wiki.ubuntu.com/DocumentationTeam | Documentation Team]] is to maintain the official documentation for Desktop and Server. Desktop ships with this documentation but the Server does not. Both are available on [[https://help.ubuntu.com]].|
|Line 7:||Line 8:|
|In order to contribute to the system documentation, you need to know a bit about the tools and processes the team uses to maintain the documentation. '''Don't worry if you don't know any of our tools yet.''' They are very easy to learn and it's possible to make useful contributions before learning how to use all the tools.||In order to help you will need to use Doc team tools and processes but you can make meaningful contributions without learning all of them at once.|
|Line 9:||Line 10:|
|The first thing you need to do is familiarize yourself with the docteam environment. This page briefly describes the various things you need to know and provides links for further reading and discovery.||== How can I help? ==
Here are some common tasks:
* '''Proof-reading''' - Look for spelling/grammar mistakes and broken links.
* '''Submit a bug''' - [[https://help.ubuntu.com/community/ReportingBugs | Send in a bug report]] when you find mistakes.
* '''Fix a bug''' - Propose new wording to fix an existing bug.
* '''Create new material''' - Add to an existing topic or write on a new topic.
[[https://wiki.ubuntu.com/DocumentationTeam/Contact | Contact us]] for any questions you may have. We're a friendly bunch.
|Line 13:||Line 23:|
|An important (and easy) way of helping out is to proof-read the system documentation and report any errors that you find.||We have quickstart guides for each platform:|
|Line 15:||Line 25:|
| * Follow the instructions given in the documentation to see if they work and if they make sense
* Click links to make sure that they still work
* Report spelling and grammar mistakes, mis-translated words and typos
* Report documentation that you think is missing or inadequate
| * '''[[/UbuntuDesktopGuide | Ubuntu Desktop Guide]]'''
* '''[[/UbuntuServerGuide | Ubuntu Server Guide]]'''
|Line 20:||Line 28:|
|See '''[[DocumentationTeam/TechReview|Technical Reviewing Documentation]]''' for information on becoming a technical reviewer/proofreader.||The following subpages provide details on specific tasks:|
|Line 22:||Line 30:|
|You can file bug reports on [[https://bugs.launchpad.net/products/ubuntu-doc/+filebug|Launchpad]] if you find a problem. See [[https://help.ubuntu.com/community/ReportingBugs|Reporting Bugs]] for more information on how to file bugs correctly.|| * '''[[/Repository | Repository]]''' - Working with Bazaar branches and repositories.
* '''[[/BuildingDocumentation | Building]]''' - Building the documentation from the sources.
* '''[[/Editing | Editing]]''' - Editing the source documents.
* '''[[/Checking | Checking]]''' - Verifying your work.
* '''[[/Submitting | Submitting]]''' - Sending in your contribution.
|Line 24:||Line 36:|
|Alternatively, you can make suggestions on improving the documentation on the [[https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc|Documentation Team mailing list]].||Finally, read the following pages for even more information:|
|Line 26:||Line 38:|
|== Repository ==
If you want to make changes to the system documentation, you need to download the ''repository'' which stores the latest copy of the documentation. Like most Ubuntu projects, we store our material using the ''Bazaar'' (or ''bzr'') version control system:
* Detailed information on on using the bazaar branches and getting to our repository is on the '''[[/Repository]]''' page.
== DocBook ==
The system documentation is written in a simple markup language called Doc``Book XML. Doc``Book is similar to HTML and is easy to learn to write with. When you start working on our documents, you will see how Doc``Book is employed by the docteam.
* The '''[[/Editing]]''' page details how to edit the documents.
* The '''[[/Checking]]''' page explains how to view the files you have edited and to check your work.
== Submitting your Contribution ==
Once you have made a change to a document and checked your work, the next step is to send your contribution to the DocumentationTeam.
* The '''[[/Submitting]]''' page explains how to send your contribution to the DocumentationTeam by creating a patch.
== Tasks ==
You can get some ideas for tasks that need doing on the system documentation on the '''[[/Tasks]]''' page.
| * '''[[DocumentationTeam/Translation | Translation]]''' - How translations work.
* '''[[DocumentationTeam/TechReview | TechnicalReview]]''' - About technical reviewing and proof-reading.
The main purpose of the Documentation Team is to maintain the official documentation for Desktop and Server. Desktop ships with this documentation but the Server does not. Both are available on https://help.ubuntu.com.
In order to help you will need to use Doc team tools and processes but you can make meaningful contributions without learning all of them at once.
How can I help?
Here are some common tasks:
Proof-reading - Look for spelling/grammar mistakes and broken links.
Submit a bug - Send in a bug report when you find mistakes.
Fix a bug - Propose new wording to fix an existing bug.
Create new material - Add to an existing topic or write on a new topic.
Contact us for any questions you may have. We're a friendly bunch.
We have quickstart guides for each platform:
The following subpages provide details on specific tasks:
Repository - Working with Bazaar branches and repositories.
Building - Building the documentation from the sources.
Editing - Editing the source documents.
Checking - Verifying your work.
Submitting - Sending in your contribution.
Finally, read the following pages for even more information: