SystemDocumentation

Differences between revisions 1 and 41 (spanning 40 versions)
Revision 1 as of 2008-08-31 12:57:43
Size: 1572
Editor: 79-72-87-179
Comment: creating
Revision 41 as of 2015-01-09 16:03:42
Size: 2685
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. 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/]].
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 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.
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: 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!
 * '''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.
Line 13: Line 18:
 https://code.launchpad.net/ubuntu-doc == Getting Started ==
Line 15: Line 20:
 * Detailed information on on using the bazaar branches and getting to our repository is on the '''[[DocumentationTeam/Repository|Repository]]''' page. We have written quick summary of the process to get started for each type of system documentation:
 * '''[[/UbuntuDesktopGuide | Ubuntu Desktop Guide]]'''
 * '''[[/UbuntuServerGuide | Ubuntu Server Guide]]'''
Line 17: Line 24:
Furthermore, the following subpages help you when working with specific tasks on the documentation:
 * '''[[/Repository|Repository]]''' describes the use of Bazaar branches and creating your own repositories.
 * '''[[/BuildingDocumentation|Building]]''' helps you build the documentation from the sources.
 * '''[[/Editing|Editing]]''' covers editing the documents inside the Ubuntu documentation.
 * '''[[/Checking|Checking]]''' explains how to view the files you have edited and to review your work.
 * '''[[/Submitting|Submitting]]''' guides you through sending your contribution to the documentation.
Line 18: Line 31:
== 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 '''[[DocumentationTeam/Contribute|Contribute]]''' page details how to edit the documents and further information about the format (including a tutorial) can be found at https://help.ubuntu.com/community/DocBook.
 * See [[DocumentationTeam/DocbookTags]] for an introduction to writing documentation in Doc''''''Book
Finally, read the following pages for even more information:
 * '''[[DocumentationTeam/Translation|Translation]]''' for information on documentation translations.
 * '''[[DocumentationTeam/TechReview|TechnicalReview]]''' for information on technical reviewing and proof-reading.

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

System Documentation

One of the major tasks of the 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/.

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.

How can I help?

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!

  • File bug reports on the documentation when you find mistakes. See 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.

Getting Started

We have written quick summary of the process to get started for each type of system documentation:

Furthermore, the following subpages help you when working with specific tasks on the documentation:

  • Repository describes the use of Bazaar branches and creating your own repositories.

  • Building helps you build the documentation from the sources.

  • Editing covers editing the documents inside the Ubuntu documentation.

  • Checking explains how to view the files you have edited and to review your work.

  • Submitting guides you through sending your contribution to the documentation.

Finally, read the following pages for even more information:

  • Translation for information on documentation translations.

  • TechnicalReview for information on technical reviewing and proof-reading.

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