Launchpad itself

Merge lp:~thumper/launchpad/recipe-help into lp:launchpad

  1. recipe-help
  2. Merge into devel
Proposed by Tim Penhey on 2010-11-03
Status: Merged
Approved by: Gavin Panella on 2010-11-04
Approved revision: no longer in the source branch.
Merged at revision: 11868
Proposed branch: lp:~thumper/launchpad/recipe-help
Merge into: lp:launchpad
Diff against target: 148 lines (+76/-5)
6 files modified
lib/lp/code/browser/configure.zcml (+1/-1)
lib/lp/code/browser/tests/test_sourcepackagerecipe.py (+3/-3)
lib/lp/code/help/related-recipes.html (+38/-0)
lib/lp/code/interfaces/sourcepackagerecipe.py (+2/-1)
lib/lp/code/templates/branch-recipes.pt (+3/-0)
lib/lp/code/templates/sourcepackagerecipe-new.pt (+29/-0)
To merge this branch: bzr merge lp:~thumper/launchpad/recipe-help
Reviewer Review Type Date Requested Status
Matthew Revell (community) text 2010-11-03 Approve on 2010-11-04
Paul Hummer (community) code ui 2010-11-03 Approve on 2010-11-03
Launchpad code reviewers 2010-11-03 Pending
Review via email: mp+39922@code.launchpad.net

Commit Message

Add some help references to some recipe pages.

Description of the Change

This branch adds some help references to the recipe pages.

Not a lot to this branch.

To post a comment you must log in.
Paul Hummer (rockstar) wrote :

This looks fine to me.

review: Approve (code ui)
Matthew Revell (matthew.revell) wrote :

I approve the text, although I'd suggest the following change to the help pop-up:

<html>
  <head>
    <title>Related source package recipes</title>
    <link rel="stylesheet" type="text/css"
          href="/+icing/yui/cssreset/reset.css" />
   <link rel="stylesheet" type="text/css"
          href="/+icing/yui/cssfonts/fonts.css" />
    <link rel="stylesheet" type="text/css"
          href="/+icing/yui/cssbase/base.css" />
  </head>
  <body>
    <h1>Related source package recipes</h1>

    <p>
      You can ask Launchpad to make an automatic daily build
      of the code in this branch and place the resultant package(s)
      in your chosen PPA. (<a href="https://help.launchpad.net/Packaging/SourceBuilds" target="_blank">Read more</a>)
    </p>

    <p>A "recipe" is a description of the steps Launchpad's package builder should take to
      construct a source package from a set of Bazaar branches that you specify.
    </p>

    <p>
      Using a recipe, you tell Launchpad:
    </p>
    <ul class="bulleted">
      <li>in which branch to find the code</li>
      <li>where to find the packaging information &mdash; e.g. in a separate branch or in an existing Ubuntu package branch</li>
      <li>the correct package version (so users will still be able to upgrade to the stable version of the distro once it gets released)</li>
      <li>any modifications necessary to make the source build properly.</li>
    </ul>

  </body>
</html>

review: Approve (text)
Tim Penhey (thumper) wrote :

Hi Matt, it would have been much more help to say what the difference in the help text would have been. It was hard for me to work out what you had changed.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'lib/lp/code/browser/configure.zcml'
2--- lib/lp/code/browser/configure.zcml 2010-10-20 03:44:49 +0000
3+++ lib/lp/code/browser/configure.zcml 2010-11-04 22:53:52 +0000
4@@ -1262,7 +1262,7 @@
5 permission="launchpad.AnyPerson"
6 facet="branches"
7 name="+new-recipe"
8- template="../../app/templates/generic-edit.pt"/>
9+ template="../templates/sourcepackagerecipe-new.pt"/>
10 <browser:page
11 for="lp.code.interfaces.sourcepackagerecipe.ISourcePackageRecipe"
12 layer="lp.code.publisher.CodeLayer"
13
14=== modified file 'lib/lp/code/browser/tests/test_sourcepackagerecipe.py'
15--- lib/lp/code/browser/tests/test_sourcepackagerecipe.py 2010-10-29 00:06:49 +0000
16+++ lib/lp/code/browser/tests/test_sourcepackagerecipe.py 2010-11-04 22:53:52 +0000
17@@ -121,7 +121,7 @@
18 browser.getControl(name='field.name').value = 'daily'
19 browser.getControl('Description').value = 'Make some food!'
20 browser.getControl('Secret Squirrel').click()
21- browser.getControl('Build daily').click()
22+ browser.getControl('Automatically build each day').click()
23 browser.getControl('Create Recipe').click()
24
25 pattern = """\
26@@ -184,7 +184,7 @@
27 browser.getControl(name='field.name').value = 'daily'
28 browser.getControl('Description').value = 'Make some food!'
29 browser.getControl('Secret Squirrel').click()
30- browser.getControl('Build daily').click()
31+ browser.getControl('Automatically build each day').click()
32 browser.getControl('Owner').displayValue = ['Good Chefs']
33 browser.getControl('Create Recipe').click()
34
35@@ -279,7 +279,7 @@
36 browser.getControl(name='field.name').value = 'daily'
37 browser.getControl('Description').value = 'Make some food!'
38
39- browser.getControl('Build daily').click()
40+ browser.getControl('Automatically build each day').click()
41 browser.getControl('Create Recipe').click()
42 self.assertEqual(
43 extract_text(find_tags_by_class(browser.contents, 'message')[2]),
44
45=== added file 'lib/lp/code/help/related-recipes.html'
46--- lib/lp/code/help/related-recipes.html 1970-01-01 00:00:00 +0000
47+++ lib/lp/code/help/related-recipes.html 2010-11-04 22:53:52 +0000
48@@ -0,0 +1,38 @@
49+<html>
50+ <head>
51+ <title>Related source package recipes</title>
52+ <link rel="stylesheet" type="text/css"
53+ href="/+icing/yui/cssreset/reset.css" />
54+ <link rel="stylesheet" type="text/css"
55+ href="/+icing/yui/cssfonts/fonts.css" />
56+ <link rel="stylesheet" type="text/css"
57+ href="/+icing/yui/cssbase/base.css" />
58+ </head>
59+ <body>
60+ <h1>Related source package recipes</h1>
61+
62+ <p>
63+ You can ask Launchpad to make an automatic daily build
64+ of the code in this branch and place the resultant package(s)
65+ in your chosen PPA. (<a href="https://help.launchpad.net/Packaging/SourceBuilds" target="_blank">Read more</a>)
66+ </p>
67+
68+ <p>A "recipe" is a description of the steps Launchpad's package builder
69+ should take to construct a source package from a set of Bazaar branches
70+ that you specify.
71+ </p>
72+
73+ <p>
74+ Using a recipe, you tell Launchpad:
75+ </p>
76+ <ul class="bulleted">
77+ <li>in which branch to find the code</li>
78+ <li>where to find the packaging information &mdash; e.g. in a separate
79+ branch or in an existing Ubuntu package branch</li>
80+ <li>the correct package version (so users will still be able to upgrade
81+ to the stable version of the distro once it gets released)</li>
82+ <li>any modifications necessary to make the source build properly</li>
83+ </ul>
84+
85+ </body>
86+</html>
87
88=== modified file 'lib/lp/code/interfaces/sourcepackagerecipe.py'
89--- lib/lp/code/interfaces/sourcepackagerecipe.py 2010-11-04 06:36:29 +0000
90+++ lib/lp/code/interfaces/sourcepackagerecipe.py 2010-11-04 22:53:52 +0000
91@@ -171,7 +171,8 @@
92 " build a source package for"),
93 readonly=False)
94 build_daily = exported(Bool(
95- title=_("Build daily")))
96+ title=_("Automatically build each day, if the source has changed"),
97+ description=_("You can manually request a build at any time.")))
98
99 name = exported(TextLine(
100 title=_("Name"), required=True,
101
102=== modified file 'lib/lp/code/templates/branch-recipes.pt'
103--- lib/lp/code/templates/branch-recipes.pt 2010-07-21 13:22:25 +0000
104+++ lib/lp/code/templates/branch-recipes.pt 2010-11-04 22:53:52 +0000
105@@ -15,6 +15,9 @@
106 </a>
107 using this branch.
108
109+ <a href="/+help/related-recipes.html" target="help" class="sprite maybe">
110+ &nbsp;<span class="invisible-link">Tag help</span>
111+ </a>
112 </div>
113
114 <span
115
116=== added file 'lib/lp/code/templates/sourcepackagerecipe-new.pt'
117--- lib/lp/code/templates/sourcepackagerecipe-new.pt 1970-01-01 00:00:00 +0000
118+++ lib/lp/code/templates/sourcepackagerecipe-new.pt 2010-11-04 22:53:52 +0000
119@@ -0,0 +1,29 @@
120+<html
121+ xmlns="http://www.w3.org/1999/xhtml"
122+ xmlns:tal="http://xml.zope.org/namespaces/tal"
123+ xmlns:metal="http://xml.zope.org/namespaces/metal"
124+ xmlns:i18n="http://xml.zope.org/namespaces/i18n"
125+ metal:use-macro="view/macro:page/main_only"
126+ i18n:domain="launchpad">
127+ <body>
128+ <div metal:fill-slot="main">
129+
130+ <div>
131+ <p>A "recipe" is a description of the steps bzr-builder should take to
132+ construct a source package from the various bzr branches. Its format
133+ specifies:</p>
134+ <ul class="bulleted">
135+ <li>where to use the code from (trunk branch, beta branch, etc.), where to get the packaging from (separate branch? ubuntu branch?)</li>
136+ <li>the correct package version (so users will still be able to upgrade to the stable version of the distro once it gets released)</li>
137+ <li>what to modify to make the source build properly</li>
138+ </ul>
139+
140+ <p>We strongly recommend that you test your recipe locally first.
141+ <a href="https://help.launchpad.net/Packaging/SourceBuilds/GettingStarted">Read more...</a></p>
142+
143+ </div>
144+
145+ <div metal:use-macro="context/@@launchpad_form/form" />
146+ </div>
147+ </body>
148+</html>