DocumentationTeam
|
Size: 3110
Comment:
|
Size: 4767
Comment: updates page to reflect new PATHS format
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 14: | Line 14: |
| The '''Documentation Team''' is a group of community volunteers responsible for writing, editing, and updating the system documentation that ships with the Ubuntu, Kubuntu, Xubuntu, and Edubuntu desktop operating systems. New versions of these guides are available with each new release of Ubuntu. These are translated with the Rosetta translation tool in the same manner as all of the other applications in Ubuntu. | |
| Line 16: | Line 15: |
| = Projects = | This page explains the structure of the DocumentationTeam and provides information about how to join the team. |
| Line 18: | Line 17: |
| ## List the team's current projects and tasks as well as status and contact persons for each one. Make it easy for new people to know who to ask and where to go to get involved with a specific project. | 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. |
| Line 20: | Line 19: |
| The two types of documentation that the team is responsible for are: | This explains a bit about the teams structure: |
| Line 22: | Line 21: |
| * [[/SystemDocumentation|System Documentation]] --- the documentation that comes with every Ubuntu, Kubuntu, Xubuntu, and Edubuntu system. It includes the Ubuntu Server Guide. * [[/Wiki|Wiki Documentation]] --- the help wiki is a community edited resource that anyone can edit. |
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. |
| Line 25: | Line 27: |
| For information on how to contribute, visit either of the two pages linked above. If you need help understanding the team's processes, please consider [[/Contact|contacting the team]]. | 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. |
| Line 27: | Line 29: |
| = Style Guide = | 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]]. == Suggested Requirements for Ubuntu Documentation Committers == 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: * 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 DocBook, Bazaar and Launchpad. * 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). == Suggested Requirements for Ubuntu Documentation Wiki Administrators == For membership of this team, we ask that applicants to join have: * 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. = Suggected Reading - Style Guide = |
| Line 31: | Line 51: |
| = Meetings = | = Ready to join = |
| Line 33: | Line 53: |
| ## Link to Meeting Agendas and old meeting summaries here. | 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). |
| Line 35: | Line 55: |
| Ubuntu Documentation Team meetings are announced on the ubuntu-doc mailing list and normally take place in the [[irc://irc.freenode.net/ubuntu-meeting|#ubuntu-meeting]] IRC channel on irc.freenode.net. See the [[/MeetingAgenda|Meeting Agenda]] page for the agenda and time for the next meeting. | 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. |
| Line 37: | Line 57: |
| Summaries from previous Documentation Team meetings can be found on the [[MeetingLogs/DocTeam|Docteam Meeting Logs]] page. = Contact = ## List the contact information of the team: Mailing-list, IRC channel, and Web Forum as they may apply. Provide a link to the Launchpad page as a Team Member list if applicable. Consider how people will get in touch with you based on the contact information you supply. * Most communication happens on the Documentation Team '''[[http://lists.ubuntu.com/mailman/listinfo/ubuntu-doc|mailing list]]'''. * Join the [[irc://irc.freenode.net/ubuntu-doc|#ubuntu-doc]] IRC channel on irc.freenode.net. * A list of current Documentation Team members is available on our [[https://launchpad.net/~ubuntu-doc|Launchpad page]]. |
=== Beginners Team Help === The Beginners Team is here to help you get started on your journey to becoming a Documentation contributor. |
Inclusion deadlines for Impish – String Freeze: September 16, 2021 / Non-language packs: September 30, 2021 |
Introduction
This page explains the structure of the DocumentationTeam and provides information about how to join the team.
The DocumentationTeam takes care of two main different types of documentation, the documentation wiki and the system documentation that ships with each version of *buntu.
This explains a bit about the teams structure:
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.
1. 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.
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 relevant section of the Wiki Guide.
Suggested Requirements for Ubuntu Documentation Committers
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:
read the 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 documentation team style guide, and is comfortable working with DocBook, Bazaar and Launchpad.
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).
Suggested Requirements for Ubuntu Documentation Wiki Administrators
For membership of this team, we ask that applicants to join have:
read the 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.
Suggected Reading - Style Guide
All the team's work is subject to our Style Guide.
Ready to join
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).
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.
Beginners Team Help
The Beginners Team is here to help you get started on your journey to becoming a Documentation contributor.
Sub-pages
This Team wiki page contains the following sub-pages: |
DocumentationTeam (last edited 2021-06-11 05:29:18 by roguescholar)