DocumentationTeam

Differences between revisions 66 and 67
Revision 66 as of 2013-10-28 21:47:17
Size: 4928
Editor: dsmythies
Comment: Fix DocBook incorrect link auto added by that demented auto adder
Revision 67 as of 2013-11-02 08:03:16
Size: 4838
Editor: mh-dixon
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
## Describe: ## Describe: 
Line 15: Line 15:
This page explains the structure of the DocumentationTeam and provides information about how to join the team. This page explains the structure of the Documentation Team and provides information about how to join it.
Line 17: Line 17:
The DocumentationTeam takes care of two main different types of documentation, the [[DocumentationTeam/Wiki|documentation wiki]] and the [[DocumentationTeam/SystemDocumentation|system documentation]] that ships with each version of *buntu. 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 19: Line 19:
This explains a bit about the teams structure: The Documentation Team has three divisions.
Line 21: Line 21:
 1. '''[[https://launchpad.net/~ubuntu-doc-contributors|Ubuntu Documentation Contributors]]'''. This is an open team, much like the Beginners Team, which anyone interested in helping with Ubuntu documentation can join to show their interest. Feel free to join this team and learn how to contribute from the DocumentationTeam 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.
= Contributors =
Line 27: Line 23:
1. '''[[https://launchpad.net/~ubuntu-core-doc|Ubuntu Documentation Committers]]'''. This team has write access to the official system documentation branches. Write access to these branches is restricted because this is the documentation that is included directly with every Ubuntu system. A system of quality control and review is therefore required. '''[[https://launchpad.net/~ubuntu-doc-contributors|Ubuntu Documentation Contributors]]'''. This is an open team, which anyone interested can join and assist in helping with Ubuntu documentation. Joining this team will enhance your sense of Community and the Documentation Team pages will quickly help you learn how to contribute. To join this team use the 'Join this team' link on '''[[https://launchpad.net/~ubuntu-doc-contributors|this page]]'''
Line 29: Line 25:
 1. '''[[https://launchpad.net/~ubuntu-doc-wiki-admins|Ubuntu Documentation Wiki Administrators]]'''. Members of this team 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. This is explained in the [[https://help.ubuntu.com/community/WikiGuide/DeletingAndRenaming|relevant section of the Wiki Guide]]. Members of this team frequently:
Line 31: Line 27:
== Suggested Requirements for Ubuntu Documentation Committers ==   * edit Ubuntu Documentation Wiki pages
Line 33: Line 29:
Membership of this team carries with it a right to commit material directly to the documents which are included in the Ubuntu operating system. For that reason we ask that applicants to join this team have:   * report bugs via Launchpad to the Ubuntu system documentation
Line 35: Line 31:
  * read the [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation|System Documentation series of pages]]
  * contributed a number of patches to the system documentation which, taken as a whole, demonstrate to the reviewer that the applicant applies the [[DocumentationTeam/StyleGuide|documentation team style guide]], and is comfortable working with Bazaar, 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).
  * contribute patches to system documentation through Launchpad and Bazaar
Line 39: Line 33:
== Suggested Requirements for Ubuntu Documentation Wiki Administrators ==   * participate on the Ubuntu-doc mailing list and/or in the #ubuntu-doc IRC channel
Line 41: Line 35:
For membership of this team, we ask that applicants to join have: = Committers =
Line 43: Line 37:
  * read the [[https://help.ubuntu.com/community/WikiGuide|Wiki Guide]].
  * made significant contributions to the help wiki by way of edits to pages.
  * demonstrated an understanding of the issues that can arise from deleting and renaming pages, and how to avoid them.
'''[[https://launchpad.net/~ubuntu-core-doc|Ubuntu Documentation Committers]]'''. This is a peer approved team which has write access to the official system documentation branches. This 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 47: Line 39:
= Suggested Reading - Style Guide = Before applying for membership applicants are asked to:
Line 49: Line 41:
All the team's work is subject to our [[/StyleGuide|Style Guide]].  * read [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation|System Documentation]].
Line 51: Line 43:
= Ready to join =  * 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 Bazaar, 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.
Line 53: Line 45:
Once you are more familiar with the team and its processes, you may find that you are able to contribute more effectively with either the Ubuntu Documentation Wiki Administrators team (if you wish to help with maintenance of the wiki), or the Ubuntu Documentation Committers team (if you wish to be able to push your changes directly to the system documentation).  * 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).
Line 55: Line 47:
You can apply to join either of these teams by posting to the 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. = Wiki Administrators =
Line 57: Line 49:
=== Beginners Team Help ===
The Beginners Team is here to help you get started on your journey to becoming a Documentation contributor.
'''[[https://launchpad.net/~ubuntu-doc-wiki-admins|Ubuntu Documentation Wiki Administrators]]'''. This 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 benefit from its advice so that your work will be of greater benefit to its readers.

= Team progression =

Once you are more familiar with the team and its processes, you may find that you are able to contribute more effectively with 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 the 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.

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

Introduction

This page explains the structure of the Documentation Team and provides 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. This is an open team, which anyone interested can join and assist in helping with Ubuntu documentation. Joining this team will enhance your sense of Community and the Documentation Team pages will quickly help you learn how to contribute. To join this team 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. This is a peer approved team which has write access to the official system documentation branches. This 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. This 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 benefit from its advice so that your work will be of greater benefit to its readers.

Team progression

Once you are more familiar with the team and its processes, you may find that you are able to contribute more effectively with 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 the 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


CategoryDocteam CategoryUbuntuTeams

DocumentationTeam (last edited 2021-06-11 05:29:18 by roguescholar)