DocumentationTeam
|
Size: 2872
Comment: imported from the old wiki
|
Size: 4919
Comment: We don't have any meetings for now, removed the banner for now
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = DocumentationTeam = | #title Documentation Team <<Include(DocumentationTeam/MenuBar)>> |
| Line 3: | Line 4: |
| The documentation team is the engine of the Ubuntu Documentation Project (UDP), an Open Source volunteer project that aims to develop and maintain literary content surrounding the Ubuntu distribution and community. |
||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents(3)>>|| |
| Line 7: | Line 6: |
| Authored works are released using a dual license strategy. This means there are many ways to contribute to the project - documenting, editing, proof reading, technical checks and reporting or fixing typos, grammar or spelling errors. Even suggestions or ideas are welcomed here. |
= Introduction = |
| Line 12: | Line 8: |
| FAQ about the ubuntu documentation efforts can be found at the DocumentationTeamFAQ wiki page. | ## Describe: ## the teams's purpose and community role ## the team tasks and work ## who might be interested in joining/getting involved with the team |
| Line 14: | Line 13: |
| == Getting Involved == | |
| Line 16: | Line 14: |
| Great! You want to help. Here is a list of links to resources that will provide information on how to get started and become a productive member of the team. |
An explaination of the structure of the Documentation Team and information about how to join it. |
| Line 20: | Line 16: |
| If you are in a hurry, we suggest reading "[For the Hasty]." This page is the project nuts and bolts in a nut shell. We highly recommend it to people with experience in Open Source documentation projects. |
The Documentation Team takes care of two main types of documentation, the [[DocumentationTeam/Wiki|documentation wiki]] and the [[DocumentationTeam/SystemDocumentation|system documentation]] that ships with each version of *buntu. |
| Line 24: | Line 18: |
| For the not so hasty we recommend the scenic tour. The scenic tour is a list of links to pages arranged in an order that will guide you through various steps and provide you with information such as - where to find things, what you need, what needs doing, what's being done, what has been done, and how to do them. Each of these topics is linked to the next in sequential order. |
The Documentation Team has three divisions. |
| Line 30: | Line 20: |
| * DocteamGettingStarted - What we do and how to get involved. | = Contributors = |
| Line 32: | Line 22: |
| * DocteamLicense - The license used for the documentation produced by the team. | '''[[https://launchpad.net/~ubuntu-doc-contributors|Ubuntu Documentation Contributors]]''' is an open team which anyone interested can join and assist in helping with Ubuntu documentation. Being part of this team will enhance your sense of Community and the Documentation Team pages will quickly help you learn how to contribute. When you are ready to join use the 'Join this team' link on '''[[https://launchpad.net/~ubuntu-doc-contributors|this page]]''' |
| Line 34: | Line 24: |
| * DocteamProjects - The documents we work on: a list of everything under development linked to document specifications, HTML previews and status informations. | Members of this team frequently: |
| Line 36: | Line 26: |
| * DocteamWork - Programs and technologies. A descriptive list of the tools and technologies used in the project with links to relevant information. | * edit Ubuntu Documentation Wiki pages |
| Line 38: | Line 28: |
| * DocteamServices - Collaborative community infrastructures. Information about the nature and purpose of the various networks services that facilitate our communications. | * report bugs via Launchpad to the Ubuntu system documentation |
| Line 40: | Line 30: |
| == Special Help Wanted Here == | * contribute patches to system documentation through [[https://launchpad.net/|Launchpad]] and [[http://bazaar.canonical.com/en/|Bazaar]] |
| Line 42: | Line 32: |
| We can't all be experts. From time-to-time we need special skills not current within our skill pool and would be happy to obtain extra help. If there is something listed here and you feel that you can help, we would be happy to hear from you. |
* participate on the Ubuntu-doc mailing list and/or in the #ubuntu-doc IRC channel |
| Line 45: | Line 34: |
| '''Help with the QuickGuide'''! | = Committers = |
| Line 47: | Line 36: |
| A really easy, fun and useful source of things to do is the QuickGuide. One can have a look at it [http://people.ubuntu.com/~mako/docteam/quickguide/ online], then pick tasks from [http://people.ubuntu.com/~mako/docteam/status/qg-report.html its status report]. |
'''[[https://launchpad.net/~ubuntu-core-doc|Ubuntu Documentation Committers]]''' is a peer approved team which has write access to the official system documentation branches. Approval is necessary because this documentation is included directly with every Ubuntu operating system. A system of quality control and review is also applied. |
| Line 50: | Line 38: |
| To contribute new content without needing to mess with subversion or docbook, one can just post them to the ubuntu-doc list, or add/link their new parts at the end of QuickGuide and annonce them to the ubuntu-doc list, |
Before applying for membership applicants are asked to: * read [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation|System Documentation]]. * contribute a number of patches to the system documentation which, taken as a whole, demonstrate to the reviewer that the applicant applies the requirements of the [[DocumentationTeam/StyleGuide|documentation team style guide]], and is comfortable working with [[http://bazaar.canonical.com/en/|Bazaar]], [[https://launchpad.net/|Launchpad]], and either [[http://projectmallard.org/index.html|Mallard]] for the Ubuntu User Guide or [[https://help.ubuntu.com/community/DocBook|DocBook]] for the serverguide, or both. * read the UbuntuBugControl page and all those pages linked there (this is necessary because membership of the Ubuntu Documentation Committers team carries with it membership of the Ubuntu Bug Control team). = Wiki Administrators = '''[[https://launchpad.net/~ubuntu-doc-wiki-admins|Ubuntu Documentation Wiki Administrators]]''' is an experienced team who have permission to delete or rename wiki pages. This is a restricted action on the help wiki, because the renaming, or deletion of wiki pages can often cause unintended problems. Before applying for membership applicants are asked to: * read [[https://wiki.ubuntu.com/DocumentationTeam/StyleGuide|Style Guide]] * read [[https://help.ubuntu.com/community/WikiGuide|Wiki Guide]] * read [[https://help.ubuntu.com/community/WikiGuide/DeletingAndRenaming|DeletingAndRenaming]] * make significant contributions to the help wiki by way of edits to pages * demonstrate an understanding of the issues that can arise from deleting and renaming pages, and how to avoid them. = Style Guide = The work of all members of the Documentation Team is subject to our [[/StyleGuide|Style Guide]] and you will be expected to learn from its advice so that your work will be of greater benefit to its readers. = Team progression = Once you are more familiar with the Contributors team and its processes, you may find that you are able to contribute more effectively by joining either the Ubuntu Documentation Committers team (if you wish to be able to push your changes directly to the system documentation), or the Ubuntu Documentation Wiki Administrators team (if you wish to help with maintenance of the wiki). You can apply to join either of these teams by posting to their mailing list and asking to be added. Please provide evidence that you satisfy the requirements in this section. It's particularly helpful if you can include links to concrete examples of your work, such as wiki pages, or patches. = Sub-pages = ||<tablestyle="width:90%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''This Team wiki page contains the following sub-pages:'''|| ||<<Navigation(children,1)>>|| ---- CategoryDocteam CategoryUbuntuTeams |
Introduction
An explaination of the structure of the Documentation Team and information about how to join it.
The Documentation Team takes care of two main types of documentation, the documentation wiki and the system documentation that ships with each version of *buntu.
The Documentation Team has three divisions.
Contributors
Ubuntu Documentation Contributors is an open team which anyone interested can join and assist in helping with Ubuntu documentation. Being part of this team will enhance your sense of Community and the Documentation Team pages will quickly help you learn how to contribute. When you are ready to join use the 'Join this team' link on this page
Members of this team frequently:
- edit Ubuntu Documentation Wiki pages
- report bugs via Launchpad to the Ubuntu system documentation
contribute patches to system documentation through Launchpad and Bazaar
- participate on the Ubuntu-doc mailing list and/or in the #ubuntu-doc IRC channel
Committers
Ubuntu Documentation Committers is a peer approved team which has write access to the official system documentation branches. Approval is necessary because this documentation is included directly with every Ubuntu operating system. A system of quality control and review is also applied.
Before applying for membership applicants are asked to:
read System Documentation.
contribute a number of patches to the system documentation which, taken as a whole, demonstrate to the reviewer that the applicant applies the requirements of the documentation team style guide, and is comfortable working with Bazaar, Launchpad, and either Mallard for the Ubuntu User Guide or DocBook for the serverguide, or both.
read the UbuntuBugControl page and all those pages linked there (this is necessary because membership of the Ubuntu Documentation Committers team carries with it membership of the Ubuntu Bug Control team).
Wiki Administrators
Ubuntu Documentation Wiki Administrators is an experienced team who have permission to delete or rename wiki pages. This is a restricted action on the help wiki, because the renaming, or deletion of wiki pages can often cause unintended problems.
Before applying for membership applicants are asked to:
read Style Guide
read Wiki Guide
read DeletingAndRenaming
- make significant contributions to the help wiki by way of edits to pages
- demonstrate an understanding of the issues that can arise from deleting and renaming pages, and how to avoid them.
Style Guide
The work of all members of the Documentation Team is subject to our Style Guide and you will be expected to learn from its advice so that your work will be of greater benefit to its readers.
Team progression
Once you are more familiar with the Contributors team and its processes, you may find that you are able to contribute more effectively by joining either the Ubuntu Documentation Committers team (if you wish to be able to push your changes directly to the system documentation), or the Ubuntu Documentation Wiki Administrators team (if you wish to help with maintenance of the wiki).
You can apply to join either of these teams by posting to their mailing list and asking to be added. Please provide evidence that you satisfy the requirements in this section. It's particularly helpful if you can include links to concrete examples of your work, such as wiki pages, or patches.
Sub-pages
This Team wiki page contains the following sub-pages: |
DocumentationTeam (last edited 2021-06-11 05:29:18 by roguescholar)