Merge lp:~salgado/launchpad/workitems-widget-help-popup into lp:launchpad

Proposed by Guilherme Salgado on 2012-03-05
Status: Merged
Merged at revision: 14942
Proposed branch: lp:~salgado/launchpad/workitems-widget-help-popup
Merge into: lp:launchpad
Prerequisite: lp:~linaro-infrastructure/launchpad/workitems-widget
Diff against target: 66 lines (+52/-0)
2 files modified
lib/lp/blueprints/help/workitems-help.html (+50/-0)
lib/lp/blueprints/templates/specification-index.pt (+2/-0)
To merge this branch: bzr merge lp:~salgado/launchpad/workitems-widget-help-popup
Reviewer Review Type Date Requested Status
Benji York (community) code 2012-03-05 Approve on 2012-03-05
huwshimi 2012-03-05 Pending
Review via email: mp+95894@code.launchpad.net

Description of the Change

Add a help popup to the new work-items editor widget

To post a comment you must log in.
Benji York (benji) wrote :

This branch looks good. It might be better to using CSS or inline style instead of the leading newline to format the <pre> block.

review: Approve (code)
Guilherme Salgado (salgado) wrote :

I couldn't find any existing CSS (other than a bunch of very specific, as judging by their names, rules with a top margin) that would do the trick so it might be better to just inline a margin-top there.

huwshimi (huwshimi) wrote :

Semantically all the sentences after the headings (lines 18, 23, 34, 38, 49) should be wrapped in <p> tags. This should also give you some extra space after each <p> and should solve your problem with the extra line in the <pre>.

Guilherme Salgado (salgado) wrote :

Huw's suggestion worked just fine :)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added file 'lib/lp/blueprints/help/workitems-help.html'
2--- lib/lp/blueprints/help/workitems-help.html 1970-01-01 00:00:00 +0000
3+++ lib/lp/blueprints/help/workitems-help.html 2012-03-05 21:44:24 +0000
4@@ -0,0 +1,50 @@
5+<html>
6+ <head>
7+ <title>Blueprint work items</title>
8+ <link rel="stylesheet" type="text/css"
9+ href="/+icing/yui/cssreset/reset.css" />
10+ <link rel="stylesheet" type="text/css"
11+ href="/+icing/yui/cssfonts/fonts.css" />
12+ <link rel="stylesheet" type="text/css"
13+ href="/+icing/yui/cssbase/base.css" />
14+ </head>
15+ <body>
16+ <h1>Using work items</h1>
17+
18+ <p>Often, it can take a few separate steps to complete the work described
19+ in a blueprint. Launchpad lets you track these steps in the "Work items"
20+ text box.</p>
21+
22+ <h2>Describing work items</h2>
23+
24+ <p>It's easy to track the steps, or work items, necessary to complete the
25+ blueprint. Using the <em>Work items</em> text box, give a short
26+ description of each work item along with its status. For example:</p>
27+
28+ <pre>
29+ Design the UI: DONE
30+ Test the UI: TODO
31+ Bootstrap the dev environment: POSTPONED
32+ </pre>
33+
34+ <p>Each work item goes on its own line, followed by a colon and its
35+ status.</p>
36+
37+ <h2>Work item statuses</h2>
38+
39+ <p>Each work item can have one of four statuses:</p>
40+
41+ <ul>
42+ <li>TODO</li>
43+ <li>INPROGRESS</li>
44+ <li>DONE</li>
45+ <li>POSTPONED</li>
46+ </ul>
47+
48+ <h2>More about work items</h2>
49+
50+ <p>There's <a href="https://help.launchpad.net/WorkItems"
51+ target="_blank">more about using work items</a> in the Launchpad help
52+ wiki.</p>
53+ </body>
54+</html>
55
56=== modified file 'lib/lp/blueprints/templates/specification-index.pt'
57--- lib/lp/blueprints/templates/specification-index.pt 2012-03-05 21:44:23 +0000
58+++ lib/lp/blueprints/templates/specification-index.pt 2012-03-05 21:44:24 +0000
59@@ -284,6 +284,8 @@
60 </div>
61
62 <div class="portlet">
63+ <a href="/+help-blueprints/workitems-help.html" target="help" class="sprite maybe">&nbsp;
64+ <span class="invisible-link">Tag help</span></a>
65 <div class="wide" tal:content="structure view/workitems_text_widget" />
66 </div>
67