Browse Source

Merge pull request #16023 from mikebrow/12854-update-irc-webpage

refresh where to chat page; and add IRCCloud to IRC Quickstart
moxiegirl 9 years ago
parent
commit
8855bf3500

+ 107 - 36
docs/project/get-help.md

@@ -30,11 +30,11 @@ community members and developers.
       <p>
         IRC a direct line to our most knowledgeable Docker users.
         The <code>#docker</code> and <code>#docker-dev</code> group on 
-        <strong>irc.freenode.net</strong>. IRC was first created in 1988. 
+        <strong>chat.freenode.net</strong>. IRC was first created in 1988. 
         So, it is a rich chat protocol but it can overwhelm new users. You can search
         <a href="https://botbot.me/freenode/docker/#" target="_blank">our chat archives</a>.
       </p>
-      Read our IRC quickstart guide below for an easy way to get started.
+      Use our IRC quickstart guide below for easy ways to get started with IRC.
     </td>
   </tr>
   <tr>
@@ -67,22 +67,28 @@ community members and developers.
 </table>
 
 
-## IRC Quickstart
+# IRC Quickstart 
 
-IRC can also be overwhelming for new users. This quickstart shows you 
-the easiest way to connect to IRC. 
+The following instructions show you how to register with two web based IRC
+tools. Use one illustrated here or find another. While these instructions are
+only for two IRC web clients there are many IRC Clients available on most
+platforms.
 
-1. In your browser open <a href="http://webchat.freenode.net" target="_blank">http://webchat.freenode.net</a>
+## Webchat 
 
-    ![Login screen](/project/images/irc_connect.png)
+Using Webchat from Freenode.net is a quick and easy way to get chatting. To
+register:
 
+1. In your browser open <a href="https://webchat.freenode.net" target="_blank">https://webchat.freenode.net</a>
+
+    ![Login to webchat screen](/project/images/irc_connect.png)
 
 2. Fill out the form.
 
     <table class="no-zebra" style="width: auto">
       <tr>
         <td><b>Nickname</b></td>
-        <td>The short name you want to be known as in IRC.</td>
+        <td>The short name you want to be known as on IRC chat channels.</td>
       </tr>
       <tr>
         <td><b>Channels</b></td>
@@ -94,60 +100,125 @@ the easiest way to connect to IRC.
       </tr>
     </table>
 
-3. Click "Connect".
-
-    The system connects you to chat. You'll see a lot of text. At the bottom of
-    the display is a command line. Just above the command line the system asks 
-    you to register.
+3. Click on the "Connect" button.
 
-    ![Login screen](/project/images/irc_after_login.png)
+    The browser connects you to Webchat. You'll see a lot of text. At the bottom of
+    the Webchat web page is a command line bar. Just above the command line bar
+    a message is shown asking you to register.
 
+    ![Registration needed screen](/project/images/irc_after_login.png)
 
-4. In the command line, register your nickname.
+4. Register your nickname by entering the following command in the
+command line bar:
 
-        /msg NickServ REGISTER password youremail@example.com
+        /msg NickServ REGISTER yourpassword youremail@example.com
 
-    ![Login screen](/project/images/register_nic.png)
+    ![Registering screen](/project/images/register_nic.png)
 
-    The IRC system sends an email to the address you
-    enter. The email contains instructions for completing your registration.
+    This command line bar is also the entry field that you will use for entering 
+    chat messages into IRC chat channels after you have registered and joined a
+    chat channel. 
+    
+    After entering the REGISTER command, an email is sent to the email address
+    that you provided. This email will contain instructions for completing
+    your registration.
 
-5. Open your mail client and look for the email.
+5. Open your email client and look for the email.
 
     ![Login screen](/project/images/register_email.png)
 
-6. Back in the browser, complete the registration according to the email.
+6. Back in the browser, complete the registration according to the email
+by entering the following command into the webchat command line bar:
 
-        /msg NickServ VERIFY REGISTER moxiegirl_ acljtppywjnr
+        /msg NickServ VERIFY REGISTER yournickname somecode
 
-7. Join the `#docker` group using the following command.
+    Your nickname is now registered to chat on freenode.net.
 
-        /j #docker
+[Jump ahead to tips to join a docker channel and start chatting](#tips)  
 
-    You can also join the `#docker-dev` group.
+## IRCCloud
 
-        /j #docker-dev
+IRCCloud is a web-based IRC client service that is hosted in the cloud. This is
+a Freemium product, meaning the free version is limited and you can pay for more
+features. To use IRCCloud:
+
+1. Select the following link:
+  <a href="https://www.irccloud.com/invite?channel=%23docker&amp;hostname=chat.freenode.net&amp;port=6697" target="_blank">Join the #docker channel on chat.freenode.net</a>
+
+    The following web page is displayed in your browser:
+
+    ![IRCCloud Register screen](/project/images/irccloud-join.png)
+  
+2. If this is your first time using IRCCloud enter a valid email address in the
+form. People who have already registered with IRCCloud can select the "sign in
+here" link. Additionally, people who are already registered with IRCCloud may
+have a cookie stored on their web browser that enables a quick start "let's go"
+link to be shown instead of the above form. In this case just select the
+"let's go" link and [jump ahead to start chatting](#start-chatting)
+
+3. After entering your email address in the form, check your email for an invite
+from IRCCloud and follow the instructions provided in the email. 
+
+4. After following the instructions in your email you should have an IRCCloud
+Client web page in your browser:
+
+    ![IRCCloud](/project/images/irccloud-register-nick.png)
+
+    The message shown above may appear indicating that you need to register your
+    nickname. 
+
+5. To register your nickname enter the following message into the command line bar
+at the bottom of the IRCCloud Client:
+        
+        /msg NickServ REGISTER yourpassword youremail@example.com
+
+    This command line bar is for chatting and entering in IRC commands.
+
+6. Check your email for an invite to freenode.net:
 
-8. To ask questions to the channel just type messages in the command line.
+    ![Login screen](/project/images/register_email.png)
+
+7. Back in the browser, complete the registration according to the email.
 
-	![Login screen](/project/images/irc_chat.png)
+        /msg NickServ VERIFY REGISTER yournickname somecode
 
-9. To quit, close the browser window.
+## Tips
 
+The procedures in this section apply to both IRC clients.
 
-### Tips and learning more about IRC
+### Set a nickname 
 
-Next time you return to log into chat, you'll need to re-enter your password 
+Next time you return to log into chat, you may need to re-enter your password 
 on the command line using this command:
 
-    /msg NickServ identify <password>
+      /msg NickServ identify <password>
 
-If you forget or lose your password see <a
+With Webchat if you forget or lose your password see <a
 href="https://freenode.net/faq.shtml#sendpass" target="_blank">the FAQ on
 freenode.net</a> to learn how to recover it.
 
+### Join a Docker Channel
+
+Join the `#docker` group using the following command in the command line bar of
+your IRC Client:
+
+        /j #docker
+
+You can also join the `#docker-dev` group:
+
+        /j #docker-dev
+
+### Start chatting
+
+To ask questions to the group just type messages in the command line bar:
+
+  ![Web Chat Screen](/project/images/irc_chat.png)
+
+## Learning more about IRC
+
 This quickstart was meant to get you up and into IRC very quickly. If you find 
-IRC useful there is a lot more to learn. Drupal, another open source project, 
-actually has <a href="https://www.drupal.org/irc/setting-up" target="_blank">
-written a lot of good documentation about using IRC</a> for their project 
+IRC useful there is more to learn. Drupal, another open source project, 
+has <a href="https://www.drupal.org/irc/setting-up" target="_blank">
+written some documentation about using IRC</a> for their project 
 (thanks Drupal!).
+

BIN
docs/project/images/irccloud-join.png


BIN
docs/project/images/irccloud-register-nick.png