Diff for "DocTeam/UserGuide"

Not logged in - Log In / Register

Differences between revisions 1 and 7 (spanning 6 versions)
Revision 1 as of 2008-02-11 15:33:20
Size: 2525
Editor: 77-100-239-119
Comment:
Revision 7 as of 2008-06-17 14:21:18
Size: 2722
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Between now and June, we're going to write a new Launchpad user guide. This will replace just about everything that we have on the Help wiki at the start of the process.

The aims of this rewrite are:

 * Highlight and explain every part of Launchpad.
 * Provide a coherent tutorial, the individual pages/sections of which stand alone.

We have a [[DocTeam/StyleGuide/UserGuideTemplate|template for user guide pages]] and a [[StyleGuide|style guide]] to help make the help wiki consistent.
Line 4: Line 12:
 * Each section will have a ToC that won't form part of the tutorial's flow.
 * Primary articles are part of the tutorial's flow. Secondary are not but are linked from the section ToC and where necessary.
Each section of the tutorial will have its own directory on their help wiki: ```/Teams/``` for example.
Line 7: Line 14:
The wiki home page will link to the contents/overview page of each of these sections.

Each page of the tutorial will link to the previous and next pages.

= Style =

Primary articles are part of the tutorial's flow: i.e. they are linked using the ```next``` and ```previous``` links. Secondary are not but are linked from the section ToC and where necessary.
Line 13: Line 27:
'''Primary articles:'''

 * YourAccount/NewAccount - replaces CreatingYourLaunchpadAccount
 * YourAccount/Karma - replaces KarmaCalculation
 * YourAccount/ImportingYourPGPKey
 * YourAccount/CreatingAnSSHKeyPair

'''Secondary articles:'''

 * YourAccount/ChangingYourPassword
 * YourAccount/ChangingYourDisplayName
 * YourAccount/ClosingYourAccount
New section live.
Line 32: Line 35:
'''Primary articles:''' New section live.
Line 34: Line 37:
 * Teams/Joining
 * Teams/CreatingAndRuning
 * Teams/MailingLists
 * Teams/Polls
 * Teams/Mentoring
 
Line 42: Line 39:
'''Primary articles:''' New section live.
Line 44: Line 41:
 * Projects/Registering
 * Projects/ReleasesSeriesMilestones
 * Projects/FileDownloads
 * Feeds/ProjectAnnouncements
  
Line 61: Line 53:
 * Feeds#bugs
Line 71: Line 64:
 * Feeds#branches
Line 95: Line 89:
 * Answers/OfferingHelpForYourProject  * Answers/YourProject
Line 120: Line 114:
 * [:Legal/PPATermsofUse]  * [[Legal/PPATermsofUse]]

Between now and June, we're going to write a new Launchpad user guide. This will replace just about everything that we have on the Help wiki at the start of the process.

The aims of this rewrite are:

  • Highlight and explain every part of Launchpad.
  • Provide a coherent tutorial, the individual pages/sections of which stand alone.

We have a template for user guide pages and a style guide to help make the help wiki consistent.

Structure

Each section of the tutorial will have its own directory on their help wiki: /Teams/ for example.

The wiki home page will link to the contents/overview page of each of these sections.

Each page of the tutorial will link to the previous and next pages.

Style

Primary articles are part of the tutorial's flow: i.e. they are linked using the next and previous links. Secondary are not but are linked from the section ToC and where necessary.

/

YourAccount

New section live.

Nice to have:

Teams

New section live.

Projects

New section live.

Bugs

Primary articles:

  • Bugs/Reporting
  • Bugs/YourProjectsBugs
  • Bugs/MultiProjectBugs
  • Bugs/ExternalWatches
  • Bugs/Statuses
  • Bugs/Expiry
  • Bugs/EmailInterface
  • Bugs/BugBranchLinks
  • Feeds#bugs

Code

Primary articles:

  • Code/HostingBazaarBranches
  • Code/BranchingFromLaunchpad
  • Code/TeamBranches
  • Code/BranchesHostedElsewhere
  • Code/ImportingCVSAndSvn
  • Feeds#branches

Translations

Primary articles:

  • Translations/TranslatingSoftware
  • Translations/Teams
  • Translations/TranslatingYourProject
  • Translations/Exports

Blueprint

Primary articles:

  • Blueprint/TrackingWork
  • Blueprint/Meetings

Answers

Primary articles:

  • Answers/AskingForHelp
  • Answers/ProvidingHelp
  • Answers/CreatingAndUsingFAQs
  • Answers/YourProject

PPAs

Primary articles:

  • PPA/BuildingAndHostingPackages
  • PPA/CommonErrors
  • PPA/FAQs

/GetInvolved

Primary articles:

Others

Deletion candidates

Pages that have no obvious replacement in the new user guide and that are better explained elsewhere.

DocTeam/UserGuide (last edited 2010-11-11 19:50:27 by 122-63-10-108)