[seahorse/wip/userdocs: 256/416] help: Add <desc> elements, shorten titles
- From: Aruna Sankaranarayanan <arunasank src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [seahorse/wip/userdocs: 256/416] help: Add <desc> elements, shorten titles
- Date: Sun, 16 Mar 2014 20:50:59 +0000 (UTC)
commit ba861fde7d8f09753471d9e6245adcbc85867418
Author: Aruna Sankaranarayanan <arunasank src gnome org>
Date: Thu Jul 18 22:54:39 2013 +0530
help: Add <desc> elements, shorten titles
help/C/backup-keys.page | 1 +
help/C/connect-other-computer.page | 5 +++--
help/C/create-pgp-key.page | 2 +-
help/C/create-ssh-key.page | 2 +-
help/C/key-delete.page | 3 ++-
help/C/key-disabling.page | 4 ++--
help/C/key-expiration-setting.page | 2 +-
help/C/key-expired.page | 2 +-
help/C/key-fingerprint.page | 5 +++--
help/C/key-photoid.page | 5 +++--
help/C/key-recommend-description.page | 5 +++--
help/C/key-select-type.page | 2 +-
help/C/key-servers-what-are-they.page | 5 +++--
help/C/key-signing.page | 3 ++-
help/C/key-strength-define.page | 2 +-
help/C/key-strength-select.page | 3 ++-
help/C/key-userid.page | 3 ++-
help/C/keys-export.page | 2 +-
help/C/keys-import.page | 2 +-
help/C/keys-keep-secure.page | 4 ++--
help/C/keys-publish.page | 4 ++--
help/C/keys-retrieve-remote.page | 4 ++--
help/C/keys-subkeys.page | 4 ++--
help/C/keys-sync.page | 3 ++-
help/C/passwords-control-access.page | 2 +-
help/C/passwords-keyring-make-default.page | 3 ++-
help/C/passwords-update-keyring-password.page | 17 ++++++++++++-----
help/C/passwords-view.page | 8 +++++---
help/C/pgp-key-advanced-options.page | 2 +-
help/C/ssh-key-create-vs-setup.page | 6 +++---
help/C/ssh-login.page | 6 ++++--
help/C/userid-add.page | 6 +++---
help/C/what-diff-private-public.page | 5 ++---
help/C/what-is-certificate-key.page | 2 +-
help/C/what-is-keyring.page | 2 +-
help/C/what-is-pgp-key.page | 2 +-
help/C/what-is-ssh-key.page | 1 +
37 files changed, 81 insertions(+), 58 deletions(-)
---
diff --git a/help/C/backup-keys.page b/help/C/backup-keys.page
index 109063a..c248e3e 100644
--- a/help/C/backup-keys.page
+++ b/help/C/backup-keys.page
@@ -15,6 +15,7 @@
<years>2013</years>
</credit>
+ <desc>Keep a copy of your keys and certificates to protect them.</desc>
</info>
<title>Securely back-up your keys</title>
diff --git a/help/C/connect-other-computer.page b/help/C/connect-other-computer.page
index 71a49fd..dee7ae4 100644
--- a/help/C/connect-other-computer.page
+++ b/help/C/connect-other-computer.page
@@ -13,10 +13,11 @@
<email>jwcampbell gmail com</email>
</credit>
- <desc></desc>
+ <desc>Use SSH keys to connect to another computer without entering a
+ password.</desc>
</info>
- <title>Use SSH keys to connect to another computer without entering a password</title>
+ <title>Connect to other computers</title>
<p>Short introductory text...</p>
diff --git a/help/C/create-pgp-key.page b/help/C/create-pgp-key.page
index fcf2887..ef8bb6a 100644
--- a/help/C/create-pgp-key.page
+++ b/help/C/create-pgp-key.page
@@ -14,7 +14,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Create PGP keys for encrypting and signing emails.</desc>
</info>
<title>Create a new PGP key</title>
diff --git a/help/C/create-ssh-key.page b/help/C/create-ssh-key.page
index 7ae22eb..388045b 100644
--- a/help/C/create-ssh-key.page
+++ b/help/C/create-ssh-key.page
@@ -14,7 +14,7 @@
<years>2011</years>
</credit>
- <desc></desc>
+ <desc>Create SSH keys to login to other computers.</desc>
</info>
<title>Create a new SSH key</title>
diff --git a/help/C/key-delete.page b/help/C/key-delete.page
index 5799939..703f2aa 100644
--- a/help/C/key-delete.page
+++ b/help/C/key-delete.page
@@ -15,7 +15,8 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Delete local copies of your keys or the keys of people you
+ communicate with.</desc>
</info>
<title>Delete an existing key</title>
diff --git a/help/C/key-disabling.page b/help/C/key-disabling.page
index 37b87b5..6358fd2 100644
--- a/help/C/key-disabling.page
+++ b/help/C/key-disabling.page
@@ -14,10 +14,10 @@
<years>2011</years>
</credit>
- <desc></desc>
+ <desc>Revoke your keys to prevent them from being used.</desc>
</info>
- <title>Disable a key that you no longer wish to use.</title>
+ <title>Disable keys</title>
<p>Short introductory text...</p>
diff --git a/help/C/key-expiration-setting.page b/help/C/key-expiration-setting.page
index 8014b67..368bc47 100644
--- a/help/C/key-expiration-setting.page
+++ b/help/C/key-expiration-setting.page
@@ -17,7 +17,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Set and change expiry dates for PGP keys.</desc>
</info>
<title>Expiry dates for PGP keys</title>
diff --git a/help/C/key-expired.page b/help/C/key-expired.page
index 61fb46d..4d528ef 100644
--- a/help/C/key-expired.page
+++ b/help/C/key-expired.page
@@ -15,7 +15,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Can I still use it? Can expiration dates be changed?</desc>
</info>
<title>What happens if my key expires?</title>
diff --git a/help/C/key-fingerprint.page b/help/C/key-fingerprint.page
index 6fe807e..c8c7e25 100644
--- a/help/C/key-fingerprint.page
+++ b/help/C/key-fingerprint.page
@@ -15,10 +15,11 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>What is the key fingerprint? Why is it important? How can I check
+ it?</desc>
</info>
- <title>What is a key fingerprint?</title>
+ <title>Key fingerprint</title>
<p>The fingerprint of a key is a unique sequence of alphabets and numbers
that identifies the key. Just like the thumbprints of two different people,
diff --git a/help/C/key-photoid.page b/help/C/key-photoid.page
index 53bf780..9e9ddb9 100644
--- a/help/C/key-photoid.page
+++ b/help/C/key-photoid.page
@@ -15,10 +15,11 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Include a photo ID with your existing keys so that people can
+ identify them easily.</desc>
</info>
- <title>Attach your photo to an existing key</title>
+ <title>Attach a photo to your key</title>
<p>You can attach a photo ID to your PGP keys so that everyone can verify the
ownership of your keys after looking at your photo. Though a key with an
diff --git a/help/C/key-recommend-description.page b/help/C/key-recommend-description.page
index 3c9cf19..cdd2b7b 100644
--- a/help/C/key-recommend-description.page
+++ b/help/C/key-recommend-description.page
@@ -14,10 +14,11 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Use a good key description to make your keys easily accessible to
+ your friends and family.</desc>
</info>
- <title>What should I use for the key description?</title>
+ <title>Key description?</title>
<comment>
<cite date="2011-10-23" href="mailto:jwcampbell gmail com">Jim Campbell</cite>
diff --git a/help/C/key-select-type.page b/help/C/key-select-type.page
index e39c4e7..cfc962b 100644
--- a/help/C/key-select-type.page
+++ b/help/C/key-select-type.page
@@ -15,7 +15,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>DSA-Elgamal or RSA? What are sign only keys?</desc>
</info>
<title>Select key encryption type</title>
diff --git a/help/C/key-servers-what-are-they.page b/help/C/key-servers-what-are-they.page
index 4a61c97..05f6d99 100644
--- a/help/C/key-servers-what-are-they.page
+++ b/help/C/key-servers-what-are-they.page
@@ -15,10 +15,11 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Use key servers to <link xref="keys-publish">publish</link> keys and
+ <link xref="keys-retrieve-remote">retrieve</link> remote keys.</desc>
</info>
- <title>What are key servers?</title>
+ <title>Key servers</title>
<p>Key servers are computers that help you to store and retrieve
public keys. When you create a new public key you can
diff --git a/help/C/key-signing.page b/help/C/key-signing.page
index 2734210..45ce444 100644
--- a/help/C/key-signing.page
+++ b/help/C/key-signing.page
@@ -15,7 +15,8 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Sign keys that you trust and ask your friends to sign your
+ keys.</desc>
</info>
<title>Why do keys require a signature?</title>
diff --git a/help/C/key-strength-define.page b/help/C/key-strength-define.page
index db76552..07505ab 100644
--- a/help/C/key-strength-define.page
+++ b/help/C/key-strength-define.page
@@ -14,7 +14,7 @@
<email>aruna evam gmail com</email>
</credit>
- <desc></desc>
+ <desc>What should I know to create reasonably strong keys?</desc>
</info>
<title>What does key strength mean?</title>
diff --git a/help/C/key-strength-select.page b/help/C/key-strength-select.page
index 9134144..c7fd767 100644
--- a/help/C/key-strength-select.page
+++ b/help/C/key-strength-select.page
@@ -15,7 +15,8 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Choose the right key strength depending on how long you want your key
+ to be valid.</desc>
</info>
<title>What key strength should I use?</title>
diff --git a/help/C/key-userid.page b/help/C/key-userid.page
index 46ded07..21e0a63 100644
--- a/help/C/key-userid.page
+++ b/help/C/key-userid.page
@@ -16,7 +16,8 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Create keys with good user IDs and learn to add and remove user
+ IDs.</desc>
</info>
<title>What is a user ID?</title>
diff --git a/help/C/keys-export.page b/help/C/keys-export.page
index 26ae29a..898ecbe 100644
--- a/help/C/keys-export.page
+++ b/help/C/keys-export.page
@@ -20,7 +20,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Why should I export my keys? In what format are keys exported?</desc>
</info>
<title>Export your keys</title>
diff --git a/help/C/keys-import.page b/help/C/keys-import.page
index 27c1fa9..878ccda 100644
--- a/help/C/keys-import.page
+++ b/help/C/keys-import.page
@@ -20,7 +20,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>When do I import keys? How do I import keys?</desc>
</info>
<title>Import keys</title>
diff --git a/help/C/keys-keep-secure.page b/help/C/keys-keep-secure.page
index bc4e3ff..674c444 100644
--- a/help/C/keys-keep-secure.page
+++ b/help/C/keys-keep-secure.page
@@ -14,10 +14,10 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Some basic guidelines to secure your keys.</desc>
</info>
- <title>Keep your SSH and PGP keys secure</title>
+ <title>Keep your keys secure</title>
<comment>
<cite date="2011-10-23" href="mailto:jwcampbell gmail com">Jim Campbell</cite>
diff --git a/help/C/keys-publish.page b/help/C/keys-publish.page
index dfd1218..8eecf99 100644
--- a/help/C/keys-publish.page
+++ b/help/C/keys-publish.page
@@ -15,10 +15,10 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Make your keys downloadable from key servers.</desc>
</info>
- <title>How can I publish my public keys?</title>
+ <title>Publish your public keys</title>
<p>After you <link xref="create-pgp-key">create</link> your PGP keypair you
can choose to publish the <em>Public key</em> on it. This makes the key
diff --git a/help/C/keys-retrieve-remote.page b/help/C/keys-retrieve-remote.page
index 7025a2a..d333725 100644
--- a/help/C/keys-retrieve-remote.page
+++ b/help/C/keys-retrieve-remote.page
@@ -15,10 +15,10 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Import public keys of those you communicate with.</desc>
</info>
- <title>How to retrieve remote keys?</title>
+ <title>Retrieve remote keys</title>
<p>You may want to import the <em>Public keys</em> of people you frequently
communicate with to make it easier to encrypt messages to them.
diff --git a/help/C/keys-subkeys.page b/help/C/keys-subkeys.page
index 54c8d70..181c40e 100644
--- a/help/C/keys-subkeys.page
+++ b/help/C/keys-subkeys.page
@@ -15,10 +15,10 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Why are subkeys important? Where are they used?</desc>
</info>
- <title>What are subkeys?</title>
+ <title>Subkeys</title>
<p>Though it is very important to keep your keys safe, it can become quite
tedious to do so when you have many keys. <app>Passwords and Keys</app>
diff --git a/help/C/keys-sync.page b/help/C/keys-sync.page
index 338d816..7b80036 100644
--- a/help/C/keys-sync.page
+++ b/help/C/keys-sync.page
@@ -15,7 +15,8 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Have your local key copies update every change made to the key on the
+ key server.</desc>
</info>
<title>Sync your keys</title>
diff --git a/help/C/passwords-control-access.page b/help/C/passwords-control-access.page
index 38ac913..dbb2e7e 100644
--- a/help/C/passwords-control-access.page
+++ b/help/C/passwords-control-access.page
@@ -14,7 +14,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Lock or password protect your password keyrings.</desc>
</info>
<title>Control access to your passwords.</title>
diff --git a/help/C/passwords-keyring-make-default.page b/help/C/passwords-keyring-make-default.page
index de4e0b6..9715c10 100644
--- a/help/C/passwords-keyring-make-default.page
+++ b/help/C/passwords-keyring-make-default.page
@@ -14,7 +14,8 @@
<years>2013</years>
</credit>
- <desc>Make one of your newly created password keyrings the default in <app>Passwords and
Keys</app>.</desc>
+ <desc>Make one of your newly created password keyrings the default in
+ <app>Passwords and Keys</app>.</desc>
</info>
<title>Change the default password keyring</title>
diff --git a/help/C/passwords-update-keyring-password.page b/help/C/passwords-update-keyring-password.page
index 2a8813a..d8867dd 100644
--- a/help/C/passwords-update-keyring-password.page
+++ b/help/C/passwords-update-keyring-password.page
@@ -16,12 +16,15 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Keep updating your keyring passwords to ensure that they are
+ protected well.</desc>
+
</info>
<title>Update the keyring password</title>
- <p>Your <link xref="passwords-keyring-create">password keyring</link> can be updated at any time.</p>
+ <p>Your <link xref="passwords-keyring-create">password keyring</link> can be
+ updated at any time.</p>
<steps>
<title>To update the password for your password keyring:</title>
@@ -29,13 +32,17 @@
<p>Select the password keyring of your choice from the list.</p>
</item>
<item>
- <p>Right click on the selected password keyring and select <gui>Change Password</gui>.</p>
+ <p>Right click on the selected password keyring and select
+ <gui>Change Password</gui>.</p>
</item>
<item>
- <p>Type your old password to authenticate yourself and press <gui
style="continue">Continue</gui>.</p>
+ <p>Type your old password to authenticate yourself and press
+ <gui style="continue">Continue</gui>.</p>
</item>
<item>
- <p>In the new dialog, type your new password, retype it to confirm the new password and press <gui
style="button">Continue</gui> to finish.</p>
+ <p>In the new dialog, type your new password, retype it to confirm the
+ new password and press <gui style="button">Continue</gui> to
+ finish.</p>
</item>
</steps>
diff --git a/help/C/passwords-view.page b/help/C/passwords-view.page
index a8a9d03..96355a4 100644
--- a/help/C/passwords-view.page
+++ b/help/C/passwords-view.page
@@ -15,10 +15,12 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Use <app>Passwords and Keys</app> to check a stored password you have
+ forgotten.</desc>
+
</info>
- <title>View passwords that are stored by <app>Passwords and Keys</app></title>
+ <title>View stored passwords</title>
<p>Some of your passwords are automatically stored in
<app>Passwords and Keys</app> while others have to be
@@ -35,7 +37,7 @@
left panel, select the password keyring which contains the password you
require.</p>
<note style="info">
- <p>Only unlocked keyrings automatically show passwords stored in them
+ <p>Only unlocked keyrings automatically show passwords stored in them,
on selection. To unlock a keyring, click the small picture of a closed
lock near the name of the password keyring or right click on the locked
keyring and select <gui>Unlock</gui>. This prompts you to enter the
diff --git a/help/C/pgp-key-advanced-options.page b/help/C/pgp-key-advanced-options.page
index 87f81be..5fb1b21 100644
--- a/help/C/pgp-key-advanced-options.page
+++ b/help/C/pgp-key-advanced-options.page
@@ -15,7 +15,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Select the right key type, expiration date and key strength.</desc>
</info>
<title>Advanced PGP key options</title>
diff --git a/help/C/ssh-key-create-vs-setup.page b/help/C/ssh-key-create-vs-setup.page
index 71a372b..6d27122 100644
--- a/help/C/ssh-key-create-vs-setup.page
+++ b/help/C/ssh-key-create-vs-setup.page
@@ -1,6 +1,6 @@
<page xmlns="http://projectmallard.org/1.0/";
type="topic" style="task"
- id="key-create-vs-setup">
+ id="ssh-key-create-vs-setup">
<info>
<link type="guide" xref="index#ssh-keys"/>
@@ -13,10 +13,10 @@
<email>jwcampbell gmail com</email>
</credit>
- <desc></desc>
+ <desc>How do I create a new SSH key and set it up?</desc>
</info>
- <title>Should I setup my key, or just create it?</title>
+ <title>SSH key creation and setup</title>
<p>Short introductory text...</p>
diff --git a/help/C/ssh-login.page b/help/C/ssh-login.page
index 51cad5c..294979e 100644
--- a/help/C/ssh-login.page
+++ b/help/C/ssh-login.page
@@ -14,10 +14,12 @@
<years>2011</years>
</credit>
- <desc></desc>
+ <desc>Use an SSH key to login to another computer without a
+ password.</desc>
+
</info>
- <title>Use an SSH key to login to another computer without a password</title>
+ <title>Login to other computers</title>
<comment>
<cite date="2011-06-17" href="mailto:jwcampbell gmail com">Jim Campbell</cite>
diff --git a/help/C/userid-add.page b/help/C/userid-add.page
index 96c6e77..27296c5 100644
--- a/help/C/userid-add.page
+++ b/help/C/userid-add.page
@@ -16,11 +16,11 @@
<years>2013</years>
</credit>
- <desc>Have different user IDs while communicating with different
- people.</desc>
+ <desc>Having many user IDs helps you to use the same key to communicate
+ with different people.</desc>
</info>
- <title>Add a user ID to an existing key</title>
+ <title>Add extra user IDs to a key</title>
<p>A key can have multiple user IDs. This is helpful when you want to
communicate with several people and one of them does not recognize, say, the
diff --git a/help/C/what-diff-private-public.page b/help/C/what-diff-private-public.page
index d6a7647..374e3c8 100644
--- a/help/C/what-diff-private-public.page
+++ b/help/C/what-diff-private-public.page
@@ -15,11 +15,10 @@
<years>2013</years>
</credit>
- <!-- TODO Insert pictures to that illustrate these concepts -->
-
+ <desc>How is a public key different from a private key?</desc>
</info>
- <title>How is a Public key different from a Private key?</title>
+ <title>Public key vs private key</title>
<p>Although <em>Public Keys</em> and <em>Private Keys</em> are both referred
to as <em>keys</em>, it helps to think of them a bit differently. Try to
diff --git a/help/C/what-is-certificate-key.page b/help/C/what-is-certificate-key.page
index 634fdb8..c962dbf 100644
--- a/help/C/what-is-certificate-key.page
+++ b/help/C/what-is-certificate-key.page
@@ -15,7 +15,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Do my keys require a certificate?</desc>
</info>
<title>What is a certificate?</title>
diff --git a/help/C/what-is-keyring.page b/help/C/what-is-keyring.page
index 2940cf6..5e71231 100644
--- a/help/C/what-is-keyring.page
+++ b/help/C/what-is-keyring.page
@@ -14,7 +14,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>How can I use a keyring?</desc>
</info>
<title>What is a keyring?</title>
diff --git a/help/C/what-is-pgp-key.page b/help/C/what-is-pgp-key.page
index 70fd68e..a69d8da 100644
--- a/help/C/what-is-pgp-key.page
+++ b/help/C/what-is-pgp-key.page
@@ -15,7 +15,7 @@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Why should I create a PGP key?</desc>
</info>
<title>What is a PGP key?</title>
diff --git a/help/C/what-is-ssh-key.page b/help/C/what-is-ssh-key.page
index 4f20754..bdacde9 100644
--- a/help/C/what-is-ssh-key.page
+++ b/help/C/what-is-ssh-key.page
@@ -14,6 +14,7 @@
<years>2013</years>
</credit>
+ <desc>Why should I create an SSH key? What can it be used for?</desc>
</info>
<title>What is a Secure Shell key?</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
