[seahorse] docs: Removed summary ssh and pgp pages. Added about-ssh about-pgp and pub-priv pages.



commit 8efa91b554bb7f49efe877aef5c951b24cdf8aa6
Author: Jim Campbell <jcampbell gnome org>
Date:   Sat Nov 22 22:03:52 2014 -0600

    docs: Removed summary ssh and pgp pages. Added about-ssh about-pgp and pub-priv pages.
    
    This is the first set of commits related to refactoring the Seahorse help to make it easier to find
    relevant topics. There's some added content, but it's largely just reorganizing the help.

 help/C/about-diff-private-public.page |   54 +++++++++++++++++++++++++++++++++
 help/C/about-pgp.page                 |   45 +++++++++++++++++++++++++++
 help/C/about-ssh.page                 |   41 +++++++++++++++++++++++++
 help/C/concepts.page                  |   25 +++++++++++++++
 help/C/passwords.page                 |   30 ------------------
 help/C/pgp.page                       |   30 ------------------
 help/C/ssh.page                       |   31 -------------------
 7 files changed, 165 insertions(+), 91 deletions(-)
---
diff --git a/help/C/about-diff-private-public.page b/help/C/about-diff-private-public.page
new file mode 100644
index 0000000..47439fc
--- /dev/null
+++ b/help/C/about-diff-private-public.page
@@ -0,0 +1,54 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="about-diff-private-public">
+  <info>
+    <link type="guide" xref="concepts" group="second"/>
+    <link type="seealso" xref="about-ssh"/>
+
+    <revision pkgversion="3.8" date="2013-02-26" status="incomplete"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jwcampbell gmail com</email>
+      <years>2013</years>
+    </credit>
+
+    <desc>A public key is used to encrypt communication. A private key is
+    used to decrypt it.</desc>
+  </info>
+
+  <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
+  think of a <em>Public Key</em> as being like a padlock, and a
+  <em>Private Key</em> as being like a key that unlocks the padlock.</p>
+
+  <section id="public-private-example">
+    <title>An Example: Sending a Secret Message in a Box</title>
+
+  <p>Let's use an example to see how this works. Imagine that you want your
+  friend to send you a secret message in a box. You could give your friend a
+  box and a padlock, but only you would have the key that unlocks the
+  padlock.</p>
+
+  <p>Your friend could put their message in the box, lock the padlock, and
+  then send you the locked box in the mail. When you receive it, you would use
+  your key to unlock the box.</p>
+
+  <p>This is similar to how a <em>Public Key</em> and a <em>Private Key</em>
+  work. Like the padlock, you can freely give out your <em>Public Key</em>.
+  This will make it easy for anyone to securely encrypt, or lock, a message
+  that they want to send to you.</p>
+  
+  <p>On the other hand, a <em>Private Key</em> is like the key that allows you
+  to decrypt, or unlock, the padlock. Because the <em>Private Key</em> is used
+  to decrypt secure messages, you will want to keep your <em>Private Key</em>
+  safe.</p>
+  
+  </section>
+
+</page>
diff --git a/help/C/about-pgp.page b/help/C/about-pgp.page
new file mode 100644
index 0000000..dab012a
--- /dev/null
+++ b/help/C/about-pgp.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="about-pgp">
+
+  <info>
+    <link type="guide" xref="concepts" group="first"/>
+    <link type="seealso" xref="about-ssh"/>
+    <revision version="0.1" date="2011-10-23" status="stub"/>
+    <revision pkgversion="3.9" version="0.1" date="2013-07-03" status="review"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author copyright">
+      <name>Aruna Sankaranarayanan</name>
+      <email its:translate="no">aruna evam gmail com</email>
+      <years>2013</years>
+    </credit>
+
+    <desc>PGP keys are used to sign and encrypt emails and files.</desc>
+  </info>
+
+  <title>What is a PGP key?</title>
+
+  <p>A PGP key is a public encryption key. A PGP key can be used to sign and
+  encrypt emails and files. When you create a PGP key, a keypair having a
+  public key and a private key is generated. You can share the public key with
+  anyone who wishes to send you  encrypted messages or files, but the private
+  key must be known only to you and used to decrypt received messages.</p>
+
+<section id="encryption-signing">
+  <title>Encrypt and sign data using PGP keys</title>
+
+  <p><app>Passwords and Keys</app> is a key management application. Though it
+  cannot be used to encrypt or sign files and messages, you can use it to
+  <link xref="pgp-sign">sign</link> trustworthy keys.</p>
+
+  <p>To secure your communication, you can use email clients like
+  <app>Evolution</app> that provide
+  <link href="help:evolution/mail-encryption-gpg-signing-encrypting">encryption
+  and signing</link> services.</p>
+
+</section>
+
+</page>
diff --git a/help/C/about-ssh.page b/help/C/about-ssh.page
new file mode 100644
index 0000000..5fb3479
--- /dev/null
+++ b/help/C/about-ssh.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="about-ssh">
+
+  <info>
+    <link type="guide" xref="concepts" group="first"/>
+    <revision version="0.1" date="2011-10-23" status="stub"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jwcampbell gmail com</email>
+      <years>2013</years>
+    </credit>
+
+    <desc>SSH keys are used to login to a remote computer, once a secure
+    connection has been established.</desc>
+  </info>
+
+  <title>What is a Secure Shell key?</title>
+
+  <p>A <em>Secure Shell key</em>, often just called an <em>SSH key</em>,
+  helps you create a secure connection over an unsecured network.</p>
+
+  <list>
+    <title>An SSH key actually consists of two parts:</title>
+    <item><p>A public key, which is widely available.</p></item>
+    <item><p>A private key, which is kept secret. The private key is used
+    to unlock messages encrypted with a corresponding public key.</p></item>
+  </list>
+
+  <p>The advantage of using an <em>SSH key</em> to create a connection between
+  computers is that only the <em>Public key</em> needs to be sent over
+  the network. Transmissions encrypted with a <em>Public key</em> can only be
+  decoded by unlocking them with the corresponding <em>Private key</em> and a
+  password. Because only the public key is sent over the network, the key's
+  password is kept secret.</p>
+
+</page>
diff --git a/help/C/concepts.page b/help/C/concepts.page
new file mode 100644
index 0000000..c401cdd
--- /dev/null
+++ b/help/C/concepts.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="guide" style="2column" 
+      id="concepts">
+
+  <info>
+    <link type="guide" xref="index"/>
+
+    <revision pkgversion="3.14" date="2014-10-26" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell</name>
+      <email its:translate="no">jcampbell gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Learn terms and concepts that are relevant to managing passwords and
+    keys.</desc>
+  </info>
+
+  <title>Key Concepts and Terms</title>
+
+</page>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]