launchpad-reviewers team mailing list archive
-
launchpad-reviewers team
-
Mailing list archive
-
Message #01709
[Merge] lp:~sinzui/launchpad/reg-docs-0 into lp:launchpad/devel
Curtis Hovey has proposed merging lp:~sinzui/launchpad/reg-docs-0 into lp:launchpad/devel.
Requested reviews:
Launchpad code reviewers (launchpad-reviewers)
Related bugs:
#504126 openpgp docco is confusing in the face of errors
https://bugs.launchpad.net/bugs/504126
#505304 update instructions for submitting an OpenPGP key
https://bugs.launchpad.net/bugs/505304
#524041 "Change your OpenPGP keys" doesn't mention publishing the key
https://bugs.launchpad.net/bugs/524041
#655242 Steps to generate OpenPGP key are not described correctly
https://bugs.launchpad.net/bugs/655242
This is my branch to fix OpenGPG documentation.
lp:~sinzui/launchpad/reg-docs-0
Diff size: 185
Launchpad bug:
https://bugs.launchpad.net/bugs/655242
https://bugs.launchpad.net/bugs/505304
https://bugs.launchpad.net/bugs/504126
https://bugs.launchpad.net/bugs/606866
Test command: None. No tests for help docs
Pre-implementation: no one
Target release: 10.11
Fix OpenGPG documentation
-------------------------
While revising the OpenPGP help instructions, I was surprised by mix of
GUI and command line instructions. I reviewed the reported bugs and decided
that I could rewrite both the inline help and wiki instructions to solve
several related bugs.
#655242 Steps to generate OpenPGP key are not described correctly
Updated the help to explain the location of the
"Passwords and Encryption Keys" in 10.04- and 10.10+.
#524041 "Change your OpenPGP keys" doesn't mention publishing the key
Added the missing instruction to upload the key after the change.
#505304 update instructions for submitting an OpenPGP key
Updated the instructions to use "Passwords and Encryption Keys" for
all OpenPGP setup tasks. Added a link to the help site where users can
learn how to use the GPG command to setup Lp.
#504126 openpgp docco is confusing in the face of errors
Removed the GPG command instructions. They are on the wiki now and the
link to GPG docs and errors released.
Rules
-----
* Update the inline help text to only refer to the GUI explanation
of setting up OpenPGP with Launchpad. (#505304)
* Add links to the wiki page that has more information and explains how
to use the command line GPG tool. Include links to the GPG documentation
to handle errors. (#504126)
* Revise the OpenPGP text to explain how to access
"Passwords and Encryption Keys" in 10.10 and higher. (#655242)
* Revise the fingerprint instruction to explain
that the key must be published to a key server. (#524041)
QA
--
* Visit your edit gpg keys page
* Open the help link for "Learn more about OpenPGP keys"
* Verify the instructions use "Passwords and Encryption Keys" as the
example.
* Verify that you know how to create, upload, and edit your keys
* Verify the fingerprint instructions remind the user to publish the
key.
* Open the finger print help.
* Verify the help contains GUI instructions to find th fingerprint.
Lint
----
Linting changed files:
lib/lp/registry/help/import-pgp-key.html
lib/lp/registry/help/openpgp-keys.html
lib/lp/registry/templates/person-editpgpkeys.pt
Test
----
No tests verify the help documentation
Implementation
--------------
Added GUI instructions to the inline help files.
lib/lp/registry/help/import-pgp-key.html
lib/lp/registry/help/openpgp-keys.html
Added a reminder that the key must be published to a key server.
lib/lp/registry/templates/person-editpgpkeys.pt
--
__Curtis C. Hovey_________
http://launchpad.net/
--
https://code.launchpad.net/~sinzui/launchpad/reg-docs-0/+merge/39471
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~sinzui/launchpad/reg-docs-0 into lp:launchpad/devel.
=== modified file 'lib/lp/registry/help/import-pgp-key.html'
--- lib/lp/registry/help/import-pgp-key.html 2010-01-12 16:16:27 +0000
+++ lib/lp/registry/help/import-pgp-key.html 2010-10-27 19:51:28 +0000
@@ -17,6 +17,33 @@
<h2>Retrieving the key in Ubuntu</h2>
+ <p>
+ The easiest way to generate a new OpenPGP key in Ubuntu is to use the
+ <em>Passwords and Encryption Keys</em> tool. If you are using Ubuntu
+ 10.04 or an earlier version, it is located at
+ <em>Applications > Accessories > Passwords and Encryption Keys</em>.
+ In Ubuntu 10.10 and later versions, it is located at
+ <em>System > Preferences > Passwords and Encryption Keys</em>.
+ </p>
+
+ <p>
+ <strong>Step 1</strong> Open Passwords and Encryption Keys.
+ </p>
+
+ <p>
+ <strong>Step 2</strong> Select the My Personal Keys tab, select your key
+ and open the property window by pressing Space Bar or double clicking
+ with your pointer. Select the Details tab of the property window.
+ </p>
+
+ <p>
+ <strong>Step 3</strong> Select the Fingerprint text (the ten blocks of
+ numbers and letter). Copy the text by pressing the
+ <code>control+c</code> keys together.
+ </p>
+
+ <h2>Retrieving the key using the GPG command</h2>
+
<p>Open a terminal and enter:</p>
<p><code>gpg --fingerprint</code></p>
@@ -29,7 +56,8 @@
sub 2048g/ABCDEF12 2007-01-26</code>
</p>
- <p>Highlight and copy only the numeric fingerprint: <code>0464 39CD 2486 190A 2C5A 0739 0E68 04DC 16E7 CB72</code> in the example above.
-
+ <p>
+ Highlight and copy only the numeric fingerprint: <code>0464 39CD 2486 190A 2C5A 0739 0E68 04DC 16E7 CB72</code> in the example above.
+ </p>
</body>
</html>
=== modified file 'lib/lp/registry/help/openpgp-keys.html'
--- lib/lp/registry/help/openpgp-keys.html 2010-01-12 16:16:27 +0000
+++ lib/lp/registry/help/openpgp-keys.html 2010-10-27 19:51:28 +0000
@@ -19,8 +19,6 @@
which you should guard closely. Both are standard text files that make up a digital signature.
</p>
- <p><a href="https://help.ubuntu.com/community/GnuPrivacyGuardHowto"; target="_blank">Read more about OpenPGP keys ></a></p>
-
<p>
In Launchpad, you can use your OpenPGP key to identify yourself when using the bug
tracker's email interface, when uploading distribution packages and when signing a code
@@ -30,18 +28,25 @@
<h2>Generating your key in Ubuntu</h2>
<p>
- The easiest way to generate a new OpenPGP key in Ubuntu is to use the <em>Passwords and Encryption Keys</em> tool.
+ The easiest way to generate a new OpenPGP key in Ubuntu is to use the
+ <em>Passwords and Encryption Keys</em> tool. If you are using Ubuntu
+ 10.04 or an earlier version, it is located at
+ <em>Applications > Accessories > Passwords and Encryption Keys</em>.
+ In Ubuntu 10.10 and later versions, it is located at
+ <em>System > Preferences > Passwords and Encryption Keys</em>.
</p>
<p>
- <strong>Step 1:</strong> Open <em>Applications > Accessories > Passwords and Encryption Keys</em>.
+ <strong>Step 1:</strong> open <em>Passwords and Encryption Keys</em>.
</p>
<p>
<strong>Step 2:</strong> Select <em>File > New</em>, select <em>PGP Key</em> and then follow the on-screen instructions.
</p>
- <p>Now you'll see your new key listed in the <em>Passwords and Encryption Keys</em> tool.
+ <p>Now you'll see your new key listed in the
+ <em>Passwords and Encryption Keys</em> tool.
+ </p>
<a name="publish"></a>
<h2>Publishing your key</h2>
@@ -50,28 +55,67 @@
<p>Before you add your key to Launchpad, you need to push it to the Ubuntu keyserver.</p>
- <p><strong>Step 1:</strong> Open a terminal and type:</p>
-
- <p><code>gpg --list-keys</code></p>
-
- <p><strong>Step 2:</strong> You'll see a list of OpenPGP keys in your system, including the one you've just created, which look something like this:</p>
-
- <p><code>pub 1024D/12345678 2007-01-26<br />
- uid Geoffrey Hayes (My OpenPGP key) <geoffrey@xxxxxxxxxx><br />
- sub 2048g/9ABCDEF1 2007-01-26</code></p>
-
- <p>In the example above, <code>1024D/12345678</code> is the key's public id. We need the second part, i.e. <code>12345678</code>. Copy that part of your key's public id.</p>
-
- <p><strong>Step 3:</strong> Enter:</p>
-
- <p><code>gpg --send-keys --keyserver keyserver.ubuntu.com 12345678</code></p>
-
- <p><strong>Note:</strong> Replace <em>12345678</em> with the public key id you copied in the step 2.</p>
-
- <p>If successful, GPG will display a message similar to:</p>
-
- <p><code>gpg: sending key 12345678 to hkp server keyserver.ubuntu.com</code></p>
-
- <p>It can take up to ten minutes before your key is available to Launchpad. After that time, you're ready to <a href="/+help/import-pgp-key.html">import your new key into Launchpad</a>!</p>
+ <h3>Using <em>Passwords and Encryption Keys</em></h3>
+
+ <p>
+ <strong>Step 1:</strong> Open <em>Passwords and Encryption Keys</em>
+ </p>
+
+ <p>
+ <strong>Step 2:</strong> Select the <em>My Personal Keys</em> tab,
+ select your key.
+ </p>
+
+ <p>
+ <strong>Step 3:</strong> Select Remote > Sync and Publish Keys from
+ the menu. Choose the <em>Sync</em> button. (You may need to add
+ http://keyserver.ubuntu.com:11371 to your key servers if you are not
+ using Ubuntu.)
+ </p>
+
+ <p>
+ It can take up to thirty minutes before your key is available to
+ Launchpad. After that time, you're ready to
+ <a href="/+help/import-pgp-key.html">import your new key into
+ Launchpad</a>!
+ </p>
+
+ <h2>Renewing your key</h2>
+
+ <p>
+ You may have set your key to expire. You can update your key and
+ republish it.
+ </p>
+
+ <p>
+ <strong>Step 1:</strong> Open <em>Passwords and Encryption Keys</em>
+ </p>
+
+ <p>
+ <strong>Step 2:</strong> Select the <em>My Personal Keys</em> tab,
+ select your key, and open the property window by pressing Space Bar
+ our double clicking with your pointer.
+ </p>
+
+ <p>
+ <strong>Step 3:</strong> Set a new expiration date or choose never.
+ </p>
+
+ <p>
+ See the <em>Publishing your key</em> section above.
+ </p>
+
+ <h2>More about GPG</h2>
+
+ <p>
+ <a href="https://help.launchpad.net/YourAccount/ImportingYourPGPKey";
+ target="_blank">Launchpad Help ></a>
+ has more information about using OpenPGP with Launchpad and provides
+ examples using the GPG command found on most Linux distributions.
+ Read the
+ <a href="https://help.ubuntu.com/community/GnuPrivacyGuardHowto";
+ target="_blank">Ubuntu community's guide to OpenPGP keys ></a>
+ to learn about how to other uses.
+ </p>
</body>
</html>
=== modified file 'lib/lp/registry/templates/person-editpgpkeys.pt'
--- lib/lp/registry/templates/person-editpgpkeys.pt 2010-03-11 16:09:29 +0000
+++ lib/lp/registry/templates/person-editpgpkeys.pt 2010-10-27 19:51:28 +0000
@@ -153,7 +153,8 @@
<h2>Import an OpenPGP key</h2>
<p>To start using an OpenPGP key with your Launchpad account, simply
- paste its fingerprint below.
+ paste its fingerprint below. The key must be registered with with
+ an Ubuntu key server.
(<a href="/+help/import-pgp-key.html" target="help">How to get the
fingerprint</a>)
</p>
