launchpad help|
Size: 9454
Comment: added individual code hosting qsg
|
← Revision 39 as of 2008-06-17 14:21:19 ⇥
Size: 6906
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''[[BR]][[TableOfContents]]|| | ## page was renamed from DocumentationSpecs ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>|| |
| Line 3: | Line 4: |
| == Overview == | = Introduction = |
| Line 5: | Line 6: |
| This page contains many mini-specs for new guides for help.launchpad.net. | During the first half of 2008, we're re-writing the Launchpad user guide. These mini-specs are each linked to blueprints stored in Launchpad. |
| Line 7: | Line 8: |
| If you'd like to help out with writing this documentation, please read our [[DocTeam/StyleGuide|style guide]] and [[DocTeam/ReviewProcess|review process]], then find out about [[DocTeam|joining the Launchpad Documentation team]]. | |
| Line 8: | Line 10: |
| * Overview: A Launchpad project where we can register blueprints for new support materials and, if appropriate, users can file bugs against existing documentation. * Goal/Deliverables: A project in Launchpad, several blueprints linked to mini-specs and a public announcement. * Full spec: none * Depends on: n/a |
= User guide overview = |
| Line 13: | Line 12: |
| '''We will know we are ready to announce the project when we have registered it in Launchpad and have enough blueprints to cover the basics of Launchpad.''' | The new Launchpad user guide will describe how to use each Launchpad, taking over from the current FeatureHighlights guide and much other material currently on the Launchpad Help wiki. |
| Line 15: | Line 14: |
| Each wiki page of the guide should standalone, for those readers dipping in and out of the guide, but should also gel coherently with the rest of the guide. <<Anchor(welcome)>> = launchpad-2008-user-guide-welcome = |
|
| Line 16: | Line 19: |
| [[Anchor(what-is-launchpad)]] == what-is-launchpad == Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/what-is-launchpad |
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-welcome |
| Line 24: | Line 24: |
| * Depends on: bug-tracker-overview, code-hosting-overview, translations-overview, blueprint-tracker-overview, answer-tracker-overview '''This guide will be ready for review when it has: * an overview description of Launchpad and its role in the lifecycle of the projects that use it * a description of how Launchpad handles collaboration and its suitability for the free software development process and community * an overview of each of Launchpad's generally available applications (i.e. not Soyuz) * a high-level description of how Launchpad interacts with Bazaar.''' [[Anchor(bug-tracker-overview)]] == bug-tracker-overview == * Overview: A high level introduction to the Launchpad Bug Tracker. * Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. * Full spec: none |
|
| Line 40: | Line 26: |
| '''This guide will be ready for review when it has: * high level description of the Launchpad bug tracker * introduction to multi-project bugs * introduction to external bug watches * overview of the email interface * introduction to integration with Code Hosting * examples of projects using the Launchpad Bug Tracker.''' |
'''This section will be ready for review when it has:''' * Welcome: brief overview of Launchpad, its benefits and the ideas upon which it is based * Creating a Launchpad account: explain the benefits of a Launchpad account, show the steps required to create and make the most of an account. Include "finding your way around your Launchpad account". * ChangingYourPassword * DeactivatingYourAccount * CreatingAnSSHKeyPair * ImportingYourOpenPGPKey * ReadingOpenPGPMail * KarmaCalculation. |
| Line 48: | Line 36: |
| [[Anchor(code-hosting-overview)]] == code-hosting-overview == |
<<Anchor(teams)>> = launchpad-2008-user-guide-teams = |
| Line 51: | Line 39: |
| * Overview: A high level introduction to Launchpad Code Hosting. * Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. |
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-teams * Overview: Show how to use teams in Launchpad. * Goal/Deliverables: A section of the user guide that shows how to use Launchpad teams |
| Line 54: | Line 44: |
| * Depends on: n/a | * Depends on: launchpad-2008-user-guide-welcome |
| Line 56: | Line 46: |
| '''This guide will be ready for review when it has: * high level description of managing revision history using Bazaar * explanation of why projects and individuals might want to host/mirror code on Launchpad * introduction to CVS/SVN import and an explanation of how people can access that code with Bzr and why * overview of the branch directory, mentioning links to blueprints and bugs.''' |
'''This section will be ready for review when it has:''' * JoiningATeam * Creating and running a team * Creating and running a team mailing list * TeamPolls * Mentoring. |
| Line 62: | Line 53: |
| [[Anchor(translations-overview)]] == translations-overview == |
<<Anchor(projects)>> = launchpad-2008-user-guide-projects = |
| Line 65: | Line 56: |
| * Overview: A high level introduction to Launchpad Translations. * Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. |
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-projects * Overview: Show how to create, run and use projects in Launchpad. * Goal/Deliverables: A section of the user guide that shows how to create, run and use projects in Launchpad |
| Line 68: | Line 61: |
| * Depends on: n/a | * Depends on: launchpad-2008-user-guide-welcome |
| Line 70: | Line 63: |
| '''This guide will be ready for review when it has: * high level description of the need for a simple way for translators to translate, without touching .po files directly * explanation of the collaborative nature of Launchpad Translations and the benefits therein * mention of: suggestions, translation team policies, standards compatible file export and import * links to some of the projects using Launchpad Translations.''' |
'''This section will be ready for review when it has:''' * RegisteringANewProject - include info about project groups, branding, people, etc * Releases, series and milestones * Project downloads * Project announcements - sit under the ```/Feeds``` directory |
| Line 76: | Line 69: |
| [[Anchor(blueprint-overview)]] == blueprint-overview == |
<<Anchor(bugs)>> = launchpad-2008-user-guide-bugs = |
| Line 79: | Line 72: |
| * Overview: A high level introduction to Launchpad's Blueprint Tracker. * Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-bugs * Overview: Show how to use the Launchpad bug tracker, both for projects and reporters. * Goal/Deliverables: A section of the Launchpad user guide that shows how to use the Launchpad bug tracker. |
| Line 82: | Line 77: |
| * Depends on: n/a | * Depends on: launchpad-2008-user-guide-welcome |
| Line 84: | Line 79: |
| '''This guide will be ready for review when it has: * high level description of what blueprints are * explanation of: priority, definition status, delivery, assignee, targeting * introduction to dependencies and road maps * introduction to meetings/sprints * mention of use of existing wiki * mention of ability for anyone to create a blueprint but project drivers to decide what is implemented.''' |
'''This section will be ready for review when it has: * Reporting bugs using Launchpad * Using Launchpad to track your project's bugs * Managing multi-project bugs * Creating and using external bug watches * BugStatuses * BugExpiry * BugTrackerEmailInterface * Linking bugs to branches. |
| Line 92: | Line 89: |
| [[Anchor(answers-overview)]] == answers-overview == |
<<Anchor(code)>> = launchpad-2008-user-guide-code = |
| Line 95: | Line 92: |
| * Overview: A high level introduction to Launchpad's Answer Tracker. * Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-code * Overview: Show how to use the Launchpad code hosting, for projects, teams and individuals. * Goal/Deliverables: A section of the Launchpad user guide that shows how to use Launchpad code hosting. |
| Line 98: | Line 97: |
| * Depends on: n/a | * Depends on: launchpad-2008-user-guide-welcome |
| Line 100: | Line 99: |
| '''This guide will be ready for review when it has: * problem of community knowledge being spread amongst various resources * need to make that knowledge searchable and discoverable * karma as a motivator * answer tracking - make sure questions stand a better chance of getting answers * answer contacts - as above and chance for good community involvement. |
'''This section will be ready for review when it has:''' * Hosting Bazaar branches using Launchpad * Using code hosted in Launchpad * Team branches * Mirroring and watching branches hosted elsewhere * Importing Svn and CVS repositories. |
| Line 107: | Line 106: |
| [[Anchor(file-downloads-qsg)]] == file-downloads-qsg == |
<<Anchor(translations)>> = launchpad-2008-user-guide-translations = |
| Line 110: | Line 109: |
| * Overview: Step by step guide to making binary files available for their project. * Goal/Deliverables: An article at help.launchpad.net. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-translations * Overview: Show how to use Launchpad Translations both for translators and project owners. * Goal/Deliverables: A section of the Launchpad user guide. |
| Line 113: | Line 114: |
| * Depends on: n/a | * Depends on: launchpad-2008-user-guide-welcome |
| Line 115: | Line 116: |
| '''This guide will be ready for review when it has: * brief explanation of file downloads as a way to serve Windows, Mac and non-Ubuntu Linux users * explanation of link between releases and file downloads * step by step guide to go from knowing nothing of file downloads to having your first file available to download. |
'''This section will be ready for review when it has: * Translating software in Launchpad - for both Ubuntu and upstreams * Creating a translation team * Making your project available for translation * Exporting translations from Launchpad |
| Line 120: | Line 122: |
| [[Anchor(register-your-project-qsg)]] == register-your-project-qsg == |
<<Anchor(blueprint)>> = launchpad-2008-user-guide-blueprint = |
| Line 123: | Line 125: |
| * Overview: Step by step guide to registering a project in Launchpad. * Goal/Deliverables: An article at help.launchpad.net. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-blueprint * Overview: Show how to create and manage blueprints, target them to releases etc and organise sprints. * Goal/Deliverables: A section of the Launchpad user guide. |
| Line 126: | Line 130: |
| * Depends on: | * Depends on: launchpad-2008-user-guide-welcome |
| Line 128: | Line 132: |
| '''This guide will be ready for review when it has: * brief overview of how projects work in Launchpad, project groups and how they relate to the Launchpad applications * step by step guide to registering a project in Launchpad. |
'''This section will be ready for review when it has:''' * Tracking chunks of work * Organising meetings using Launchpad. |
| Line 132: | Line 136: |
| [[Anchor(bug-tracker-for-new-project-qsg)]] == bug-tracker-for-new-project-qsg == |
<<Anchor(answers)>> = launchpad-2008-user-guide-answers = |
| Line 135: | Line 139: |
| * Overview: Step by step guide to preparing the Launchpad Bug Tracker for a new project * Goal/Deliverables: An article at help.launchpad.net. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-answers * Overview: Show how to ask for support and provide support in Launchpad. * Goal/Deliverables: A section of the Launchpad user guide. |
| Line 138: | Line 144: |
| * Depends on: bug-tracker-overview, register-a-project | * Depends on: launchpad-2008-user-guide-welcome |
| Line 140: | Line 146: |
| '''This guide will be ready for review when it has: * brief overview of Bug Tracker benefits * step by step guide to configuring Launchpad for use as the bug tracker for a new project (i.e. without existing bug history) or for a project that doesn't want to preserve an existing bug history. |
'''This section will be ready for review when it has:''' * Asking for help using Launchpad * Providing help in Launchpad * Creating and using FAQs * Using Launchpad Answers for your project. |
| Line 144: | Line 152: |
| [[Anchor(bug-tracker-for-existing-project-qsg)]] == bug-tracker-for-existing-project-qsg == |
<<Anchor(ppa)>> = launchpad-2008-user-guide-ppa = |
| Line 147: | Line 155: |
| * Overview: Step by step guide to preparing the Launchpad Bug Tracker for an existing project * Goal/Deliverables: An article at help.launchpad.net. |
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-ppa * Overview: Show how to use Personal Package Archives, with links to information on how to create Debian-style packages. * Goal/Deliverables: A section of the Launchpad user guide. |
| Line 150: | Line 160: |
| * Depends on: bug-tracker-overview, register-a-project | * Depends on: launchpad-2008-user-guide-welcome |
| Line 152: | Line 162: |
| '''This guide will be ready for review when it has: * brief overview of Bug Tracker benefits * explanation of the options available to projects who want to import an existing bug history * step by step guide to configuring Launchpad for use as the bug tracker for a project with an existing bug history that is to be preserved.''' |
'''This section will be ready for review when it has:''' |
| Line 157: | Line 164: |
| [[Anchor(translations-for-project-qsg)]] == translations-for-project-qsg == * Overview: Step by step guide to preparing Launchpad Translations for use with a project * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: translations-overview, register-a-project '''This guide will be ready for review when it has: * brief introduction to Launchpad Translations as a web interface to work with GNU GetText files and the collaborative nature of translating software * step by step guide to setting up your project to translation with Launchpad, at the Launchpad side * links to information on using GetText in a project.''' [[Anchor(project-code-hosting-with-bzr-qsg)]] == project-code-hosting-with-bzr-qsg == * Overview: Step by step guide to hosting Bazaar branches for a project * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: code-hosting-overview, register-a-project '''This guide will be ready for review when it has: * brief introduction to Code Hosting for a project * links to further information on Bazaar * introduction to team branches and the different models of Bazaar version control * step by step guide to setting up Code Hosting for a project in Launchpad.''' [[Anchor(individual-code-hosting-with-bzr-qsg)]] == individual-code-hosting-with-bzr-qsg == * Overview: Step by step guide to hosting Bazaar branches for an individual. * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: code-hosting-overview, register-a-project '''This guide will be ready for review when it has: * brief introduction to Code Hosting for an individual developer * brief explanation of how they can use the in conjunction with a project or team * links to further information on Bazaar * step by step guide to setting uploading or mirroring a branch, branching an existing hosted branch, associating a with a project.''' |
* Building and hosting packages with Launchpad * Common PPA errors * PPA FAQs |
Introduction
During the first half of 2008, we're re-writing the Launchpad user guide. These mini-specs are each linked to blueprints stored in Launchpad.
If you'd like to help out with writing this documentation, please read our style guide and review process, then find out about joining the Launchpad Documentation team.
User guide overview
The new Launchpad user guide will describe how to use each Launchpad, taking over from the current FeatureHighlights guide and much other material currently on the Launchpad Help wiki.
Each wiki page of the guide should standalone, for those readers dipping in and out of the guide, but should also gel coherently with the rest of the guide.
launchpad-2008-user-guide-welcome
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-welcome
- Overview: A high level overview of Launchpad and its applications, intended as a jumping-off point for other documentation.
- Goal/Deliverables: An article at help.launchpad.net and a corresponding link on the help home page.
- Full spec: none
- Depends on: n/a
This section will be ready for review when it has:
- Welcome: brief overview of Launchpad, its benefits and the ideas upon which it is based
- Creating a Launchpad account: explain the benefits of a Launchpad account, show the steps required to create and make the most of an account. Include "finding your way around your Launchpad account".
- CreatingAnSSHKeyPair
- ImportingYourOpenPGPKey
- ReadingOpenPGPMail
launchpad-2008-user-guide-teams
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-teams
- Overview: Show how to use teams in Launchpad.
- Goal/Deliverables: A section of the user guide that shows how to use Launchpad teams
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
- JoiningATeam
- Creating and running a team
- Creating and running a team mailing list
- Mentoring.
launchpad-2008-user-guide-projects
Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-projects
- Overview: Show how to create, run and use projects in Launchpad.
- Goal/Deliverables: A section of the user guide that shows how to create, run and use projects in Launchpad
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
- RegisteringANewProject - include info about project groups, branding, people, etc
- Releases, series and milestones
- Project downloads
Project announcements - sit under the /Feeds directory
launchpad-2008-user-guide-bugs
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-bugs
- Overview: Show how to use the Launchpad bug tracker, both for projects and reporters.
- Goal/Deliverables: A section of the Launchpad user guide that shows how to use the Launchpad bug tracker.
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-code
launchpad-2008-user-guide-code
This section will be ready for review when it has: launchpad-2008-user-guide-translations
This section will be ready for review when it has:
- Translating software in Launchpad - for both Ubuntu and upstreams
- Creating a translation team
- Making your project available for translation
- Exporting translations from Launchpad
launchpad-2008-user-guide-blueprint
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-blueprint
- Overview: Show how to create and manage blueprints, target them to releases etc and organise sprints.
- Goal/Deliverables: A section of the Launchpad user guide.
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
- Tracking chunks of work
- Organising meetings using Launchpad.
launchpad-2008-user-guide-answers
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-answers
- Overview: Show how to ask for support and provide support in Launchpad.
- Goal/Deliverables: A section of the Launchpad user guide.
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
- Asking for help using Launchpad
- Providing help in Launchpad
- Creating and using FAQs
- Using Launchpad Answers for your project.
launchpad-2008-user-guide-ppa
https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-ppa
- Overview: Show how to use Personal Package Archives, with links to information on how to create Debian-style packages.
- Goal/Deliverables: A section of the Launchpad user guide.
- Full spec: none
- Depends on: launchpad-2008-user-guide-welcome
This section will be ready for review when it has:
- Building and hosting packages with Launchpad
- Common PPA errors
- PPA FAQs
