SystemDocumentation
|
Size: 1572
Comment: creating
|
Size: 3281
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| <<Include(DocumentationTeam/MenuBar)>> | <<Include(DocumentationTeam/SystemDocumentation/MenuBar)>> <<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. == 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! 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. == Getting Started == 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: * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide|Ubuntu Desktop Guide Single Page]] * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|Ubuntu ServerGuide Single Page]] |
| Line 11: | Line 27: |
| 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: | 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. |
| Line 13: | Line 29: |
| https://code.launchpad.net/ubuntu-doc | * Detailed information on using the Bazaar branches and getting to our repository is on the '''[[/Repository]]''' page. |
| Line 15: | Line 31: |
| * Detailed information on on using the bazaar branches and getting to our repository is on the '''[[DocumentationTeam/Repository|Repository]]''' page. | == Docbook or Mallard? == |
| Line 17: | Line 33: |
| 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. | |
| Line 18: | Line 35: |
| == DocBook == | * 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. |
| Line 20: | Line 38: |
| 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. | == Submitting Your Contribution == |
| Line 22: | Line 40: |
| * 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 |
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. |
Inclusion deadlines for Impish – String 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! Also see the Technical Review page for information on technical reviewing and proof-reading.
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
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:
Repository
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 using the Bazaar branches and getting to our repository is on the /Repository page.
Docbook or Mallard?
While the serverguide is written in DocBook, the system documentation is written in 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/SystemDocumentation (last edited 2015-01-09 18:41:02 by petermatulis)