SystemDocumentation

Differences between revisions 33 and 44 (spanning 11 versions)
⇤ ← Revision 33 as of 2014-07-02 21:33:22 →
Size: 3281
Editor: xdsl-83-150-81-40
Comment:
← Revision 44 as of 2015-01-09 18:41:02 → ⇥
Size: 1960
Editor: petermatulis
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<<Include(DocumentationTeam/SystemDocumentation/MenuBar)>> <<Include(DocumentationTeam/MenuBar)>>
Line 6: Line 6:
One of the major tasks of the [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]] is to take care of the documentation which comes with every Ubuntu system. This documentation is also available on [[https://help.ubuntu.com/]]. 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 8: 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 12: Line 12:
The ways to help the Ubuntu Documentation team are almost limitless, but here's a short list of things you can start with:
 * '''Proof-reading''' is an important and easy way to help. You only need to follow the instructions, click the links and check spelling and grammar! Also see the [[DocumentationTeam/TechReview|Technical Review page]] for information on technical reviewing and proof-reading.
 * '''File bug reports''' on the documentation when you find mistakes. See [[https://help.ubuntu.com/community/ReportingBugs|Reporting Bugs]] for more information on reporting bugs.
 * '''Submit patches''' to fix bugs in the documentation.
 * '''Submit new material''' to the documentation. If you are just getting started, ask for help from other contributors and work with them to get your improvements in the next release of Ubuntu. If you start contributing regularly, you can learn to use the tools and ultimately be able to merge others' new material.		 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 20: Line 23:
There are plenty of ways to get started with the team. For a quick summary of the process for each type of system documentation, refer to: We have quickstart guides for each platform:
Line 22: Line 25:
 * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide|Ubuntu Desktop Guide Single Page]]
 * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|Ubuntu ServerGuide Single Page]]		  * '''[[/UbuntuDesktopGuide | Ubuntu Desktop Guide]]'''
 * '''[[/UbuntuServerGuide | Ubuntu Server Guide]]'''
Line 25: Line 28:
== Repository == The following subpages provide details on specific tasks:
Line 27: Line 30:
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.  * '''[[/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 29: Line 36:
 * Detailed information on using the Bazaar branches and getting to our repository is on the '''[[/Repository]]''' page. Finally, read the following pages for even more information:
Line 31: Line 38:
== Docbook or Mallard? ==

While the serverguide is written in DocBook, the system documentation is written in [[http://projectmallard.org/|Mallard]]. Both are similar to HTML and easy to learn and use.

 * 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 Documentation Team.

 * The '''[[/Submitting]]''' page explains how to send your contribution to the Documentation Team by creating a patch.

== Tasks ==

The '''[[/Tasks]]''' page contains some ideas for working on the system documentation.		  * '''[[DocumentationTeam/Translation | Translation]]''' - How translations work.
 * '''[[DocumentationTeam/TechReview | TechnicalReview]]''' - About technical reviewing and proof-reading.

Inclusion deadlines for Impish – String 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.

  • 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.

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)