launchpad help|
Size: 3054
Comment: Added code hosting overview
|
Size: 13138
Comment: code section
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from DocumentationSpecs | |
| Line 3: | Line 4: |
| == Overview == This page contains many mini-specs for new guides for help.launchpad.net. * 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 '''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.''' [[Anchor(what-is-launchpad)]] == what-is-launchpad == Blueprint: https://blueprints.launchpad.net/launchpad-documentation/+spec/what-is-launchpad |
= 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 |
| 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. |
* 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 == 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. * Full spec: none * Depends on: launchpad-2008-user-guide-welcome '''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-overview)]] == translations-overview == * Overview: A high level introduction to Launchpad Translations. |
| Line 40: | Line 114: |
| '''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.''' [[Anchor(code-hosting-overview)]] == code-hosting-overview == * Overview: A high level introduction to Launchpad Code Hosting. |
'''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.''' [[Anchor(blueprint-overview)]] == blueprint-overview == * Overview: A high level introduction to Launchpad's Blueprint Tracker. |
| Line 56: | Line 128: |
| '''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 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.''' [[Anchor(answers-overview)]] == answers-overview == * 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. * Full spec: none * Depends on: n/a '''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. [[Anchor(file-downloads-qsg)]] == file-downloads-qsg == * Overview: Step by step guide to making binary files available for their project. * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: n/a '''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. [[Anchor(register-your-project-qsg)]] == register-your-project-qsg == * Overview: Step by step guide to registering a project in Launchpad. * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: '''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. [[Anchor(bug-tracker-for-new-project-qsg)]] == bug-tracker-for-new-project-qsg == * Overview: Step by step guide to preparing the Launchpad Bug Tracker for a new project * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: bug-tracker-overview, register-a-project '''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. [[Anchor(bug-tracker-for-existing-project-qsg)]] == bug-tracker-for-existing-project-qsg == * Overview: Step by step guide to preparing the Launchpad Bug Tracker for an existing project * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: bug-tracker-overview, register-a-project '''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.''' [[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.''' [[Anchor(registering-a-blueprint-qsg)]] == registering-a-blueprint-qsg == * Overview: Step by step guide to registering a blueprint * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: blueprint-tracker-overview, register-a-project '''This guide will be ready for review when it has: * step by step guide to registering a blueprint against a project * explanation of the need to use an external wiki, or other place to store wiki body * link to info on writing a good blueprint * explanation of the different roles.''' [[Anchor(using-answer-track-for-project-qsg)]] == using-answer-track-for-project-qsg == * Overview: Step by step guide to using the Answer Tracker for a project * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: answer-tracker-overview, register-a-project '''This guide will be ready for review when it has: * a step by step guide that shows a project owner how to start using the Answer Tracker for their project * brief explanation of answer contacts * introduction to linking to bugs * info about question subscribers * explanation of question statuses.''' [Anchor(becoming-an-answer-contact-qsg)]] == becoming-an-answer-contact-qsg == * Overview: Step by step guide to answering questions in the Answer Tracker and becoming a project's answer contact. * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: answer-tracker-overview, register-a-project '''This guide will be ready for review when it has: * step by step guide to finding and answering a question, subscribing and becoming an answer contact. [[Anchor(asking-a-question-qsg)]] == asking-a-question-qsg == * Overview: Step by step guide to asking a question in the Answer Tracker. * Goal/Deliverables: An article at help.launchpad.net. * Full spec: none * Depends on: answer-tracker-overview '''This guide will be ready for review when it has a step by step guide to finding to asking a support question.''' |
ContentsBRTableOfContents |
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.
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: BugTrackerEmailInterfacehttps://help.launchpad.net/DocTeam/Specs?action=edit https://blueprints.launchpad.net/launchpad-documentation/+spec/launchpad-2008-user-guide-code Goal/Deliverables: An article at help.launchpad.net and a corresponding link in the WhatIsLaunchpad page. launchpad-2008-user-guide-code
This section will be ready for review when it has: translations-overview
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.
blueprint-overview
- 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.
- Full spec: none
- Depends on: n/a
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.
answers-overview
- 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.
- Full spec: none
- Depends on: n/a
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.
file-downloads-qsg
- Overview: Step by step guide to making binary files available for their project.
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: n/a
This guide will be ready for review when it has: Anchor(register-your-project-qsg)
register-your-project-qsg
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.
Anchor(bug-tracker-for-new-project-qsg)
bug-tracker-for-new-project-qsg
- Overview: Step by step guide to preparing the Launchpad Bug Tracker for a new project
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: bug-tracker-overview, register-a-project
This guide will be ready for review when it has: Anchor(bug-tracker-for-existing-project-qsg)
bug-tracker-for-existing-project-qsg
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.
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.
Anchor(registering-a-blueprint-qsg)
registering-a-blueprint-qsg
- Overview: Step by step guide to registering a blueprint
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: blueprint-tracker-overview, register-a-project
This guide will be ready for review when it has:
- step by step guide to registering a blueprint against a project
- explanation of the need to use an external wiki, or other place to store wiki body
- link to info on writing a good blueprint
explanation of the different roles.
Anchor(using-answer-track-for-project-qsg)
using-answer-track-for-project-qsg
- Overview: Step by step guide to using the Answer Tracker for a project
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: answer-tracker-overview, register-a-project
This guide will be ready for review when it has:
- a step by step guide that shows a project owner how to start using the Answer Tracker for their project
- brief explanation of answer contacts
- introduction to linking to bugs
- info about question subscribers
explanation of question statuses.
[Anchor(becoming-an-answer-contact-qsg)]]
becoming-an-answer-contact-qsg
- Overview: Step by step guide to answering questions in the Answer Tracker and becoming a project's answer contact.
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: answer-tracker-overview, register-a-project
This guide will be ready for review when it has:
- step by step guide to finding and answering a question, subscribing and becoming an answer contact.
asking-a-question-qsg
- Overview: Step by step guide to asking a question in the Answer Tracker.
- Goal/Deliverables: An article at help.launchpad.net.
- Full spec: none
- Depends on: answer-tracker-overview
This guide will be ready for review when it has a step by step guide to finding to asking a support question.
