Merge lp:~matthew.revell/launchpad/ppa-add-repo-help-492283 into lp:launchpad/db-devel

Proposed by Matthew Revell
Status: Merged
Approved by: Gavin Panella
Approved revision: not available
Merged at revision: not available
Proposed branch: lp:~matthew.revell/launchpad/ppa-add-repo-help-492283
Merge into: lp:launchpad/db-devel
Diff against target: 249 lines (+169/-41)
3 files modified
lib/lp/soyuz/help/ppa-sources-list.html (+164/-37)
lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt (+1/-1)
lib/lp/soyuz/templates/archive-index.pt (+4/-3)
To merge this branch: bzr merge lp:~matthew.revell/launchpad/ppa-add-repo-help-492283
Reviewer Review Type Date Requested Status
Gavin Panella (community) Approve
Review via email: mp+19010@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Matthew Revell (matthew.revell) wrote :

This branch changes the PPA overview "Read about installing" help pop-up to cover the add-apt-repository method and the terminal method for older versions of Ubuntu.

It also adds a new link to the help pop-up (to the word "adding") that doesn't require that people click to reveal the sources.list snippet.

Revision history for this message
Gavin Panella (allenap) wrote :

This looks good.

There's a general problem with the help pages, in that they fail validation (no character encoding, no doctype). They work fine, but it would be nice to make them work a little better. Please can you file a bug along the lines of "inline help pages should validate". We can probably make lp.services.inlinehelp.browser.HelpFolder do the work for us.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added file 'lib/lp/soyuz/help/images/add-apt-repo1.png'
0Binary files lib/lp/soyuz/help/images/add-apt-repo1.png 1970-01-01 00:00:00 +0000 and lib/lp/soyuz/help/images/add-apt-repo1.png 2010-02-11 11:39:18 +0000 differ0Binary files lib/lp/soyuz/help/images/add-apt-repo1.png 1970-01-01 00:00:00 +0000 and lib/lp/soyuz/help/images/add-apt-repo1.png 2010-02-11 11:39:18 +0000 differ
=== added file 'lib/lp/soyuz/help/images/add-apt-repo2.png'
1Binary files lib/lp/soyuz/help/images/add-apt-repo2.png 1970-01-01 00:00:00 +0000 and lib/lp/soyuz/help/images/add-apt-repo2.png 2010-02-11 11:39:18 +0000 differ1Binary files lib/lp/soyuz/help/images/add-apt-repo2.png 1970-01-01 00:00:00 +0000 and lib/lp/soyuz/help/images/add-apt-repo2.png 2010-02-11 11:39:18 +0000 differ
=== removed file 'lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png'
2Binary files lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png 2009-06-05 14:48:38 +0000 and lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png 1970-01-01 00:00:00 +0000 differ2Binary files lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png 2009-06-05 14:48:38 +0000 and lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png 1970-01-01 00:00:00 +0000 differ
=== modified file 'lib/lp/soyuz/help/ppa-sources-list.html'
--- lib/lp/soyuz/help/ppa-sources-list.html 2010-01-12 16:16:27 +0000
+++ lib/lp/soyuz/help/ppa-sources-list.html 2010-02-11 11:39:18 +0000
@@ -11,42 +11,169 @@
11 <body>11 <body>
12 <h1>How do I use software from a PPA?</h1>12 <h1>How do I use software from a PPA?</h1>
1313
14 <p>To start installing and using software from a Personal Package Archive, you first need to tell Ubuntu where to find the PPA and how to verify the authenticity of its software.</p>14 <p>
1515 To start installing and using software from a Personal Package Archive,
16 <h2>Adding the PPA to Ubuntu</h2>16 you first need to tell Ubuntu where to find the PPA.
1717 </p>
18 <p><strong>Step 1:</strong> Copy the first line from the <em>apt sources.list entries</em> section of the PPA overview page. For example:</p>18
19 <p><code>deb http://ppa.launchpad.net/awn-testing/ubuntu jaunty main</code></p>19 <p>
20 <p><strong>Step 2:</strong> On your Ubuntu computer, open <em>System > Administration > Software Sources</em>.</p>20 <strong>Important:</strong> The contents of Personal Package Archives
21 <p><strong>Step 3:</strong> Click the <em>Third Party Software</em> tab.</p>21 are not checked or monitored. You install software from them at your own
22 <img src="images/software-sources-3rdparty-tab.png" alt="Screen shot of the top tabs in the Software Sources app" style="margin-bottom: 15px;" />22 risk.
23 <p><strong>Step 4:</strong> Click the <em>Add</em> button.</p>23 </p>
24 <p><strong>Step 5:</strong> Paste the line you copied in step 1 and click the <em>Add Source</em> button.24
25 <p><strong>Step 6:</strong> Now copy the second line from the <em>apt sources.list entries</em> section of the PPA overview page and paste it in just as you did in steps 4 and 5.</p>25 <h2>Adding the PPA to Ubuntu 9.10 (Karmic) and later</h2>
2626
27 <p>When prompted, reload the software sources information. Don't worry if you see a warning about unverified software sources; we're going to fix that next.</p>27 <p>
2828 If you're using the most recent version of Ubuntu (or any version from
29 <h2>Telling Ubuntu how to authenticate the PPA</h2>29 Ubuntu 9.10 onwards), you can add a PPA to your system with a single
3030 line in your terminal.
31 <p>Now Ubuntu knows about the PPA. It also needs to know how to check the software hasn't been tampered with since Launchpad built it.</p>31 </p>
3232
33 <p><strong>Note:</strong> This is not an endorsement of any of the software in PPAs. You must make sure you trust the PPA owner before installing their software.</p>33 <p>
3434 <strong>Step 1:</strong> On the PPA's overview page, look for the
35 <p><strong>Step 1:</strong> On the PPA's overview page you'll see the PPA's OpenPGP key id. It'll look something like this: <em>1024/12345678</em>. Copy it, or make a note of, the portion after the slash, e.g: <em>12345678</em>.</p>35 heading that reads <em>Adding this PPA to your system</em>. Make a note
36 <p><strong>Step 2:</strong> Open your terminal and enter:</p>36 of the PPA's location, which looks like:
37 <p><code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 12345678</code></p>37 </p>
38 <p>Replace <em>12345678</em> with the key id you copied in step 1.</p>38
39 <p><strong>Step 3:</strong> Finally, tell Ubuntu to re-load the details of each software archive it knows about:</p>39 <p>
40 <p><code>sudo apt-get update</code></p>40 <code>ppa:gwibber-daily/ppa</code>
4141 </p>
42 <p>You're now ready to install software from the PPA!</p>42
4343 <p>
4444 <strong>Step 2:</strong> Open a terminal and enter:
4545 </p>
4646
4747 <p>
48 <p><a href="https://help.launchpad.net/Packaging/PPA"48 <code>sudo add-apt-repository ppa:user/ppa-name</code>
49 target="_top">Read more about Personal Package Archives</a> in our help wiki.49 </p>
50 </p>50
51 <p>
52 Replace <code>ppa:user/ppa-name</code> with the PPA's location that you
53 noted above.
54 </p>
55
56 <img src="images/add-apt-repo1.png" alt="Screen shot of a terminal with the sudo add-apt-repoistory line" style="margin-bottom: 15px;" />
57
58 <p>
59 Your system will now fetch the PPA's key. This enables your Ubuntu
60 system to verify that the packages in the PPA have not been interfered
61 with since they were built.
62 </p>
63
64 <img src="images/add-apt-repo2.png" alt="Screen shot of a system retrieving the PPA details" style="margin-bottom: 15px;" />
65
66 <p>
67 <strong>Step 3:</strong> Now, as a one-off, you should tell your system
68 to pull down the latest list of software from each archive it knows
69 about, including the PPA you just added:
70 </p>
71
72 <p>
73 <code>sudo apt-get update</code>
74 </p>
75
76 <p>
77 Now you're ready to start installing software from the PPA!
78 </p>
79
80 <h2>On older (pre 9.10) Ubuntu systems</h2>
81
82 <p>
83 <strong>Step 1:</strong> Visit the PPA's overview page in Launchpad.
84 Look for the heading that reads Adding this PPA to your system and click
85 the <em>Technical details about this PPA</em> link.
86 </p>
87
88 <p>
89 <strong>Step 2:</strong> Use the <em>Display sources.list</em> entries
90 drop-down box to select the version of Ubuntu you're using.
91 </p>
92
93 <p>
94 <strong>Step 3:</strong> You'll see that the text-box directly below
95 reads something like this:
96 </p>
97
98 <p>
99 <code>
100 deb http://ppa.launchpad.net/gwibber-daily/ppa/ubuntu jaunty main<br />
101 deb-src http://ppa.launchpad.net/gwibber-daily/ppa/ubuntu jaunty main
102 </code>
103 </p>
104
105 <p>
106 Copy those lines.
107 </p>
108
109 <p>
110 <strong>Step 4:</strong> Open a terminal and type:
111 </p>
112
113 <p>
114 <code>sudo gedit /etc/apt/sources.list</code>
115 </p>
116
117 <p>
118 This will open a text editor containing the list of archives that your
119 system is currently using. Scroll to the bottom of the file and paste the
120 lines you copied in the step above.
121 </p>
122
123 <p>
124 Save the file and exit the text editor.
125 </p>
126
127 <p>
128 <strong>Step 5:</strong> Back on the PPA's overview page, look for the
129 <em>Signing key</em> heading. You'll see something like:
130 </p>
131
132 <p>
133 <code>1024R/72D340A3 (What is this?)</code>
134 </p>
135
136 <p>
137 Copy the portion after the slash but not including the help link; e.g.
138 just <code>72D340A3</code>.
139 </p>
140
141 <p>
142 <strong>Step 6:</strong> Now you need to add that key to your system so
143 Ubuntu can verify the packages from the PPA. In your terminal, enter:
144 </p>
145
146 <p>
147 <code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys
148 72D340A3</code>
149 </p>
150
151 <p>
152 Replace <code>72D340A3</code> with whatever you copied in the step 5.
153 </p>
154
155 <p>
156 This will now pull down the PPA's key and add it to your system.
157 </p>
158
159 <p>
160 <strong>Step 7:</strong> Now, as a one-off, you should tell your system
161 to pull down the latest list of software from each archive it knows
162 about, including the PPA you just added:
163 </p>
164
165 <p>
166 <code>sudo apt-get update</code>
167 </p>
168
169 <p>
170 Now you're ready to start installing software from the PPA!
171 </p>
172
173 <p>
174 <a href="https://help.launchpad.net/Packaging/PPA" target="_blank">Read
175 more about Personal Package Archives</a> in our help wiki.
176 </p>
177
51 </body>178 </body>
52</html>179</html>
53180
=== modified file 'lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt'
--- lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt 2009-12-14 12:47:54 +0000
+++ lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt 2010-02-11 11:39:18 +0000
@@ -281,7 +281,7 @@
281 Adding this PPA to your system281 Adding this PPA to your system
282 You can update your system with unsupported packages from this282 You can update your system with unsupported packages from this
283 untrusted PPA by adding ppa:cprov/ppa to your system's Software Sources.283 untrusted PPA by adding ppa:cprov/ppa to your system's Software Sources.
284 Not using Ubuntu 9.10 (karmic)?284 Not using Ubuntu 9.10 (Karmic)?
285 Technical details about this PPA285 Technical details about this PPA
286 ...286 ...
287 For questions and bugs with software in this PPA please contact287 For questions and bugs with software in this PPA please contact
288288
=== modified file 'lib/lp/soyuz/templates/archive-index.pt'
--- lib/lp/soyuz/templates/archive-index.pt 2009-12-10 15:19:03 +0000
+++ lib/lp/soyuz/templates/archive-index.pt 2010-02-11 11:39:18 +0000
@@ -82,11 +82,12 @@
82 <tal:is-active condition="archive_active">82 <tal:is-active condition="archive_active">
8383
84 <p>You can update your system with unsupported packages from84 <p>You can update your system with unsupported packages from
85 this untrusted PPA by adding85 this untrusted PPA by <a href="/+help/soyuz/ppa-sources-list.html"
86 <strong tal:content="view/ppa_reference">ppa:cprov/ppa</strong>86 target="help">adding</a> <strong
87 tal:content="view/ppa_reference">ppa:cprov/ppa</strong>
87 to your system's Software Sources.88 to your system's Software Sources.
88 <span id="pre-karmic-systems-slide-trigger"89 <span id="pre-karmic-systems-slide-trigger"
89 >Not using Ubuntu 9.10 (karmic)?</span></p>90 >Not using Ubuntu 9.10 (Karmic)?</span></p>
9091
91 <div id="ppa-install-slide-trigger">92 <div id="ppa-install-slide-trigger">
92 <div class="widget-header">93 <div class="widget-header">

Subscribers

People subscribed via source and target branches

to status/vote changes: