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 [:DocTeam/StyleGuide:style guide] and [:DocTeam/ReviewProcess:review process], then find out about [:DocTeam: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.

Anchor(welcome)

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".

• ChangingYourPassword

• DeactivatingYourAccount

• CreatingAnSSHKeyPair
• ImportingYourOpenPGPKey
• ReadingOpenPGPMail

• KarmaCalculation.

Anchor(teams)

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

• TeamPolls

• Mentoring.

Anchor(projects)

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

Anchor(bugs)

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:

• Reporting bugs using Launchpad
• Using Launchpad to track your project's bugs
• Managing multi-project bugs
• Creating and using external bug watches

• BugStatuses

• BugExpiry

• BugTrackerEmailInterfacehttps://help.launchpad.net/DocTeam/Specs?action=edit

• Linking bugs to branches.

Anchor(code)

launchpad-2008-user-guide-code

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.

Anchor(translations)

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

Anchor(blueprint)

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.

Anchor(answers)

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.

Anchor(ppa)

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