SystemDocumentation

Differences between revisions 39 and 40
Revision 39 as of 2014-07-02 22:00:14
Size: 2522
Editor: knome
Comment:
Revision 40 as of 2014-07-02 22:16:09
Size: 2680
Editor: knome
Comment:
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
 * '''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.  * '''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!
Line 30: Line 30:

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)