Docs
|
Size: 12029
Comment:
|
Size: 8654
Comment: updating the page to reflect new changes in FG
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 8: | Line 8: |
| {{https://launchpad.net/favicon.ico}} '''Launchpad''': LaunchpadHome:ubuntu-beginners-wiki <<BR>> {{https://launchpad.net/@@/mail}} '''Email''': [[http://lists.ubuntu.com/mailman/listinfo/Ubuntu-beginners |Ubuntu-beginners]]<<BR>> |
|
| Line 14: | Line 12: |
| The '''Documentation Focus Group''' is for Beginners Team Members and Apprentices who want to help update and maintain the documentation for Ubuntu. This focus group works as part of the [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]] contributing towards their efforts on both the Community Wiki and the System Documentation. This can get confusing, but shouldn't. To be clear, the Documentation Team isn't part of the Beginners Team, but we are a group that associates with them for convenience so that we can coordinate efforts and prevent duplication. |
The '''Documentation Focus Group''' is a guide to help you get start ed helping with the Ubuntu Dcumentation We are here just to guide you and answer questions. The team that does the actual work is the [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]] This team works on both the Community Wiki and the System Documentation. |
| Line 20: | Line 17: |
| * [[https://wiki.ubuntu.com|Ubuntu Wiki]] - This wiki is now used for organizational work, proposals and all materials not belonging to main wiki. | * [[https://wiki.ubuntu.com|Ubuntu Wiki]] - This wiki is now used for organizational work, proposals and all materials not belonging to main wiki. Usually this is stuff associated with community teams, but not exclusively |
| Line 23: | Line 20: |
| Please see '''[[https://wiki.ubuntu.com/BeginnersTeam/FocusGroups/Wiki#New%20Users|New Users]]''' section for a list of resources and steps to getting started. | |
| Line 39: | Line 36: |
| [[/SoD2011|Summer of Documentation 2011]] <<BR>> [[/SoD2010|Summer of Documentation 2010]] <<BR>> [[/SoD2009|Summer of Documentation 2009]] <<BR>> [[/SoD2008|Summer of Documentation 2008]] = Meetings = Meetings should be scheduled at least a week in advance, they will be announced to the Beginners Team mailing list, so make sure your signed up. They can also be found on the [[BeginnersTeam/Meetings#Focus%20Group%20Meetings|Team Meetings]] page. Meetings are held in the Beginners Team IRC channel - '''{{https://launchpad.net/@@/language}} [[irc://irc.freenode.org/ubuntu-beginners-team|#ubuntu-beginners-team]]''' on '''irc.freenode.net''' == Meeting Agenda == ||<rowstyle="background:#DFDFC3">Who||What|| ## || [[UndiFineD]] || New members || || [[UndiFineD]] || tag pages || || [[UndiFineD]] || Style guide || || [[UndiFineD]] || Mallard || || [[UndiFineD]] || help.ubuntu.com || || [[UndiFineD]] || Ubuntu Manual || || [[UndiFineD]] || [[/SoD2011|Summer of Documentation 2011]] Project || || [[UndiFineD]] || Any Other Business || == Agenda Links and Notes == = New Users = The focus groups leadership and membership is as follows: <<BR>> '''Lead:''' TBD <<BR>> '''Co-Lead:''' TBD <<BR>> '''Members:''' [[https://edge.launchpad.net/~ubuntu-beginners-wiki|Team Members]] Feel free to contact any of the above on IRC with questions regarding team related projects. Talk to the lead, [[UndiFineD]] if you would like to join the Wiki FG. Note that there are several steps to join, if you're confused or unsure at any step don't be shy. We are here to help. |
|
| Line 75: | Line 37: |
| The best way to reach any one of us is to contact us via [[https://help.ubuntu.com/community/InternetRelayChat|IRC]]. Join the irc.freenode.net server. You'll most likely find any one of us in our team channel '''{{https://launchpad.net/@@/language}} [[irc://irc.freenode.org/ubuntu-beginners-wiki|#ubuntu-beginners-wiki]]''' but we also hang out either in the '''{{https://launchpad.net/@@/language}} [[irc://irc.freenode.org/ubuntu-beginners-|#ubuntu-beginners]]''' (Beginners Team main channel) or '''{{https://launchpad.net/@@/language}} [[irc://irc.freenode.org/ubuntu-doc|#ubuntu-doc]]''' (Official Doc Team) channels. Relevant stuff can also be brought up on either the BT or Doc mail list. | Please [[http://webchat.freenode.net/?channels=ubuntu-beginners-team|visit our IRC channel]] #ubuntu-beginners-team on Freenode to talk/know about Beginners team. You can also reach us by using the [[https://lists.ubuntu.com/mailman/listinfo/ubuntu-beginners | mailing list]]. |
| Line 85: | Line 47: |
| 1. [[/StyleGuide|Style Guide]]. | |
| Line 90: | Line 53: |
| == Joining the Teams == To join this focus group, please talk to the lead/co-lead first. Once they have been notified, they will contact you and start the process of joining the Documentation FG. You should already be signed up to the [[https://lists.ubuntu.com/mailman/listinfo/ubuntu-beginners|BT mail list]] as part of joining the main Beginners team. |
== Joining the Team == To join the Beginners Team and begin your journey on working on Ubuntu Documentation see the [[https://wiki.ubuntu.com/BeginnersTeam/Membership | Join Us]] page. |
| Line 93: | Line 56: |
| Joining the documentation team is also easy and done in two steps. * Join the [[https://launchpad.net/~ubuntu-doc-contributors|Ubuntu Documentation Contributors Launchpad team]] * If you don't have a launchpad account, see the editing section below. * Join the [[https://lists.ubuntu.com/mailman/listinfo/ubuntu-doc|Documentation Team mailing list]] * Send an email to the mailing list introducing yourself to the team. Hanging out in our two main IRC channels is strongly encouraged and will help you get to know the team, and get quick answers to question as you get started. |
|
| Line 134: | Line 90: |
| = Mentors = We always prefer new people to have a mentor before editing a wiki/document to make sure that they are doing the right changes and keeping track of the new updates. |
==Past Efforts by BT to help as a team with wiki documentation == |
| Line 137: | Line 92: |
| '''Current Mentors''' ||<tablestyle="width:90%;background:#F4F3F1" rowstyle="font-weight: bold;background:#592441;color:#F4F3F1;">Mentors||Mentee|| |
[[/SoD2011|Summer of Documentation 2011]] <<BR>> [[/SoD2010|Summer of Documentation 2010]] <<BR>> [[/SoD2009|Summer of Documentation 2009]] <<BR>> [[/SoD2008|Summer of Documentation 2008]] |
This team is now deprecated. Official announcement about the team's closure can be found here. |
|
|
|
|
Next Meeting: To be determined. Meetings in 
Ubuntu Help and Support IRC Channel: |
|
Focus Group: Documentation
About Us
The Documentation Focus Group is a guide to help you get start ed helping with the Ubuntu Dcumentation We are here just to guide you and answer questions. The team that does the actual work is the Documentation Team This team works on both the Community Wiki and the System Documentation.
There are three main areas, the two main wikis and the system documentation:
Help.Ubuntu/Community - The main community wiki for help documents for Ubuntu.
Ubuntu Wiki - This wiki is now used for organizational work, proposals and all materials not belonging to main wiki. Usually this is stuff associated with community teams, but not exclusively
System Documentation - This is the documentation that comes with Ubuntu, information on it can be found at the link. It's no more involved than doing work on the wiki, don't let the name scare you.
Current Tasks
We are working on the Community Docs with the following goals:
Keep track of your work on https://help.ubuntu.com/community/Beginners/Development.
Use the Tag functionality throughout the community docs to mark pages that need attention.
Work on improving the tagged pages, specifically for Needs Expansion, Content Cleanup, Style Cleanup, and Page Too Long.
The Wiki Cleanup offers good advice on cleaning up common problems.
Orphaned Pages - These are pages with nothing linking to them. Help them find friends! Tag and update as needed.
Other Wiki tasks listed at DocumentationTeam/Wiki/Tasks
As an aside for those interested, work on System Documentation bugs
See DocumentationTeam/SystemDocumentation for more information on how.
Bear in mind that we need to update/change all GeoCites links since they are now all deleted.
- New LTS release, updates on Ubuntu (Unity) Kubuntu, Xubuntu and Lubuntu, keyboard shortcuts etc.
Contact Us:
Please visit our IRC channel #ubuntu-beginners-team on Freenode to talk/know about Beginners team. You can also reach us by using the mailing list.
Required and Recommended Reading
To get a good grasp of what we do, please CAREFULLY READ through the following documents in order and ask anyone on the team if you have any questions. Note, these link only to the top level page, there are numerous sub pages that you should also read and understand. These pages are:
Required
Recommended
Joining the Team
To join the Beginners Team and begin your journey on working on Ubuntu Documentation see the Join Us page.
Editing the Wiki
A launchpad account is required, this will be used to sign in on both wikis to edit. This mandatory registration allows tracking and prevents malicious edits. Launchpad itself has many other uses associated with contributing to the community you can discover on your own.
Note - Ensure you have cookies enabled, so your login is stored.
Once signed in, go to either of the two wikis above and click Log In at the top. You will be prompted to authenticate via launchpad, proceed and your done. You can now make edits to the wikis.
Once logged into the Main Community Wiki, you'll notice a small bar at the bottom. This is the edit bar, it holds many options for manipulating pages. Explore and test them out while being careful not to do anything undesirable to pages.
Guidelines and Common Practices
Now that your set up to edit, it's important to know what to do. The wiki uses markup, to manipulate the text. Markup is a simple collection of special characters used to instruct the wiki system how to format pages. This allows for bold text or underlining to occur or something more complex like creating tables.
Required Reading:
Wiki Guide - A set of pages explaining markup and general formatting, read all of them thoroughly.
Formatting Guide - Pay special attention to this page, it and it's sub pages that deal with how the formatting works.
The Writing Guide and Style Guide - Offer insight into how pages should be written stylistically.
Icons - Images can be useful when properly worked into a page.
Wiki Sandbox - A sandbox, experiment with markup and editing tools as you like. The best learning is done hands on.
Communication - A few extra pointers on staying in contact and courtesy.
Advanced Recommended Reading:
Style Guide References - Additional materials on technical and documentation writing.
The Tag System - Used throughout the main wiki to mark what needs reviewing.
Deletion and Renaming - Such tasks are only done by admins, but it is best if you make their lives easier. There are only a few.
Redirecting - Can be useful to redirect pages or common alternate names to a main page.
EditMoin - Some prefer to edit the wiki pages from a desktop text editor, this package allows you to do so.
Macros - How to use macros.
System Documentation
Members interested in contributing to the system documentation should review the following links that are of interest, in addition to the System Documentation page mentioned before.
Repository - Explanation of the repository, where all the docs are located and how they are maintained.
Bazaar in five minutes - A quick start up guide for new users to using the version system bazaar.
Reviewing Documentation - Quick checklist for reviewing docs.
Tech Review - Explanation of the review process.
Tech Review Example - An example of review process, see Repository section for patching and submission process.
==Past Efforts by BT to help as a team with wiki documentation ==
Summer of Documentation 2011
Summer of Documentation 2010
Summer of Documentation 2009
Summer of Documentation 2008
| /SoD2008 /SoD2009 /SoD2010 /SoD2011 |
BeginnersTeam/FocusGroups/Docs (last edited 2013-03-24 00:45:04 by duanedesign)