Launchpad itself

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

  1. ppa-add-repo-help-492283
  2. Merge into 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
1=== added file 'lib/lp/soyuz/help/images/add-apt-repo1.png'
2Binary 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
3=== added file 'lib/lp/soyuz/help/images/add-apt-repo2.png'
4Binary 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
5=== removed file 'lib/lp/soyuz/help/images/software-sources-3rdparty-tab.png'
6Binary 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
7=== modified file 'lib/lp/soyuz/help/ppa-sources-list.html'
8--- lib/lp/soyuz/help/ppa-sources-list.html 2010-01-12 16:16:27 +0000
9+++ lib/lp/soyuz/help/ppa-sources-list.html 2010-02-11 11:39:18 +0000
10@@ -11,42 +11,169 @@
11 <body>
12 <h1>How do I use software from a PPA?</h1>
13
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>
15-
16- <h2>Adding the PPA to Ubuntu</h2>
17-
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>
19- <p><code>deb http://ppa.launchpad.net/awn-testing/ubuntu jaunty main</code></p>
20- <p><strong>Step 2:</strong> On your Ubuntu computer, open <em>System > Administration > Software Sources</em>.</p>
21- <p><strong>Step 3:</strong> Click the <em>Third Party Software</em> tab.</p>
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;" />
23- <p><strong>Step 4:</strong> Click the <em>Add</em> button.</p>
24- <p><strong>Step 5:</strong> Paste the line you copied in step 1 and click the <em>Add Source</em> button.
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>
26-
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>
28-
29- <h2>Telling Ubuntu how to authenticate the PPA</h2>
30-
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>
32-
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>
34-
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>
36- <p><strong>Step 2:</strong> Open your terminal and enter:</p>
37- <p><code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 12345678</code></p>
38- <p>Replace <em>12345678</em> with the key id you copied in step 1.</p>
39- <p><strong>Step 3:</strong> Finally, tell Ubuntu to re-load the details of each software archive it knows about:</p>
40- <p><code>sudo apt-get update</code></p>
41-
42- <p>You're now ready to install software from the PPA!</p>
43-
44-
45-
46-
47-
48- <p><a href="https://help.launchpad.net/Packaging/PPA"
49- target="_top">Read more about Personal Package Archives</a> in our help wiki.
50- </p>
51+ <p>
52+ To start installing and using software from a Personal Package Archive,
53+ you first need to tell Ubuntu where to find the PPA.
54+ </p>
55+
56+ <p>
57+ <strong>Important:</strong> The contents of Personal Package Archives
58+ are not checked or monitored. You install software from them at your own
59+ risk.
60+ </p>
61+
62+ <h2>Adding the PPA to Ubuntu 9.10 (Karmic) and later</h2>
63+
64+ <p>
65+ If you're using the most recent version of Ubuntu (or any version from
66+ Ubuntu 9.10 onwards), you can add a PPA to your system with a single
67+ line in your terminal.
68+ </p>
69+
70+ <p>
71+ <strong>Step 1:</strong> On the PPA's overview page, look for the
72+ heading that reads <em>Adding this PPA to your system</em>. Make a note
73+ of the PPA's location, which looks like:
74+ </p>
75+
76+ <p>
77+ <code>ppa:gwibber-daily/ppa</code>
78+ </p>
79+
80+ <p>
81+ <strong>Step 2:</strong> Open a terminal and enter:
82+ </p>
83+
84+ <p>
85+ <code>sudo add-apt-repository ppa:user/ppa-name</code>
86+ </p>
87+
88+ <p>
89+ Replace <code>ppa:user/ppa-name</code> with the PPA's location that you
90+ noted above.
91+ </p>
92+
93+ <img src="images/add-apt-repo1.png" alt="Screen shot of a terminal with the sudo add-apt-repoistory line" style="margin-bottom: 15px;" />
94+
95+ <p>
96+ Your system will now fetch the PPA's key. This enables your Ubuntu
97+ system to verify that the packages in the PPA have not been interfered
98+ with since they were built.
99+ </p>
100+
101+ <img src="images/add-apt-repo2.png" alt="Screen shot of a system retrieving the PPA details" style="margin-bottom: 15px;" />
102+
103+ <p>
104+ <strong>Step 3:</strong> Now, as a one-off, you should tell your system
105+ to pull down the latest list of software from each archive it knows
106+ about, including the PPA you just added:
107+ </p>
108+
109+ <p>
110+ <code>sudo apt-get update</code>
111+ </p>
112+
113+ <p>
114+ Now you're ready to start installing software from the PPA!
115+ </p>
116+
117+ <h2>On older (pre 9.10) Ubuntu systems</h2>
118+
119+ <p>
120+ <strong>Step 1:</strong> Visit the PPA's overview page in Launchpad.
121+ Look for the heading that reads Adding this PPA to your system and click
122+ the <em>Technical details about this PPA</em> link.
123+ </p>
124+
125+ <p>
126+ <strong>Step 2:</strong> Use the <em>Display sources.list</em> entries
127+ drop-down box to select the version of Ubuntu you're using.
128+ </p>
129+
130+ <p>
131+ <strong>Step 3:</strong> You'll see that the text-box directly below
132+ reads something like this:
133+ </p>
134+
135+ <p>
136+ <code>
137+ deb http://ppa.launchpad.net/gwibber-daily/ppa/ubuntu jaunty main<br />
138+ deb-src http://ppa.launchpad.net/gwibber-daily/ppa/ubuntu jaunty main
139+ </code>
140+ </p>
141+
142+ <p>
143+ Copy those lines.
144+ </p>
145+
146+ <p>
147+ <strong>Step 4:</strong> Open a terminal and type:
148+ </p>
149+
150+ <p>
151+ <code>sudo gedit /etc/apt/sources.list</code>
152+ </p>
153+
154+ <p>
155+ This will open a text editor containing the list of archives that your
156+ system is currently using. Scroll to the bottom of the file and paste the
157+ lines you copied in the step above.
158+ </p>
159+
160+ <p>
161+ Save the file and exit the text editor.
162+ </p>
163+
164+ <p>
165+ <strong>Step 5:</strong> Back on the PPA's overview page, look for the
166+ <em>Signing key</em> heading. You'll see something like:
167+ </p>
168+
169+ <p>
170+ <code>1024R/72D340A3 (What is this?)</code>
171+ </p>
172+
173+ <p>
174+ Copy the portion after the slash but not including the help link; e.g.
175+ just <code>72D340A3</code>.
176+ </p>
177+
178+ <p>
179+ <strong>Step 6:</strong> Now you need to add that key to your system so
180+ Ubuntu can verify the packages from the PPA. In your terminal, enter:
181+ </p>
182+
183+ <p>
184+ <code>sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys
185+ 72D340A3</code>
186+ </p>
187+
188+ <p>
189+ Replace <code>72D340A3</code> with whatever you copied in the step 5.
190+ </p>
191+
192+ <p>
193+ This will now pull down the PPA's key and add it to your system.
194+ </p>
195+
196+ <p>
197+ <strong>Step 7:</strong> Now, as a one-off, you should tell your system
198+ to pull down the latest list of software from each archive it knows
199+ about, including the PPA you just added:
200+ </p>
201+
202+ <p>
203+ <code>sudo apt-get update</code>
204+ </p>
205+
206+ <p>
207+ Now you're ready to start installing software from the PPA!
208+ </p>
209+
210+ <p>
211+ <a href="https://help.launchpad.net/Packaging/PPA" target="_blank">Read
212+ more about Personal Package Archives</a> in our help wiki.
213+ </p>
214+
215 </body>
216 </html>
217
218=== modified file 'lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt'
219--- lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt 2009-12-14 12:47:54 +0000
220+++ lib/lp/soyuz/stories/ppa/xx-ubuntu-ppas.txt 2010-02-11 11:39:18 +0000
221@@ -281,7 +281,7 @@
222 Adding this PPA to your system
223 You can update your system with unsupported packages from this
224 untrusted PPA by adding ppa:cprov/ppa to your system's Software Sources.
225- Not using Ubuntu 9.10 (karmic)?
226+ Not using Ubuntu 9.10 (Karmic)?
227 Technical details about this PPA
228 ...
229 For questions and bugs with software in this PPA please contact
230
231=== modified file 'lib/lp/soyuz/templates/archive-index.pt'
232--- lib/lp/soyuz/templates/archive-index.pt 2009-12-10 15:19:03 +0000
233+++ lib/lp/soyuz/templates/archive-index.pt 2010-02-11 11:39:18 +0000
234@@ -82,11 +82,12 @@
235 <tal:is-active condition="archive_active">
236
237 <p>You can update your system with unsupported packages from
238- this untrusted PPA by adding
239- <strong tal:content="view/ppa_reference">ppa:cprov/ppa</strong>
240+ this untrusted PPA by <a href="/+help/soyuz/ppa-sources-list.html"
241+ target="help">adding</a> <strong
242+ tal:content="view/ppa_reference">ppa:cprov/ppa</strong>
243 to your system's Software Sources.
244 <span id="pre-karmic-systems-slide-trigger"
245- >Not using Ubuntu 9.10 (karmic)?</span></p>
246+ >Not using Ubuntu 9.10 (Karmic)?</span></p>
247
248 <div id="ppa-install-slide-trigger">
249 <div class="widget-header">

Subscribers

People subscribed via source and target branches

to status/vote changes: