SystemDocumentation

Differences between revisions 4 and 43 (spanning 39 versions)
Revision 4 as of 2008-08-31 15:11:21
Size: 1797
Editor: 79-72-87-179
Comment: link to /Tasks
Revision 43 as of 2015-01-09 16:55:35
Size: 1962
Editor: petermatulis
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
<<Include(DocumentationTeam/MeetingBanner)>>
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. 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:
== Repository == == How can I help? ==
Line 11: Line 12:
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: Here are some common tasks:
Line 13: Line 14:
 * Detailed information on on using the bazaar branches and getting to our repository is on the '''[[/Repository]]''' page.  * '''Proof-reading''' - Look for spelling/grammar mistakes and broken links.
 * '''Submit a bug''' - Send in a bug report when you find mistakes. See [[https://help.ubuntu.com/community/ReportingBugs | Reporting Bugs]] for more information.
 * '''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. Talk to other contributors, typically via one of our mailing lists, if you are unsure.
Line 15: Line 19:
== DocBook == == Getting Started ==
Line 17: Line 21:
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. We have quickstart guides for each platform:
Line 19: Line 23:
 * 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.
 * '''[[/UbuntuDesktopGuide | Ubuntu Desktop Guide]]'''
 * '''[[/UbuntuServerGuide | Ubuntu Server Guide]]'''
Line 22: Line 26:
== Submitting your Contribution == The following subpages provide details on specific tasks:
Line 24: Line 28:
Once you have made a change to a document and checked your work, the next step is to send your contribution to the DocumentationTeam.  * '''[[/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 26: Line 34:
 * The '''[[/Submitting]]''' page explains how to send your contribution to the DocumentationTeam by creating a patch. Finally, read the following pages for even more information:
Line 28: Line 36:
== 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.

Inclusion deadlines for ImpishString Freeze: September 16, 2021 / Non-language packs: September 30, 2021

System Documentation

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. See Reporting Bugs for more information.

  • 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. Talk to other contributors, typically via one of our mailing lists, if you are unsure.

Getting Started

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:

DocumentationTeam/SystemDocumentation (last edited 2015-01-09 18:41:02 by petermatulis)