Update get-help.md (#1910)

* Update get-help.md
This commit is contained in:
scjane 2017-02-23 02:29:56 +08:00 committed by Misty Stanley-Jones
parent d2d1d44a09
commit c14c418bbd
1 changed files with 49 additions and 51 deletions

View File

@ -69,26 +69,18 @@ platforms.
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>
1. In your browser open
[https://webchat.freenode.net](https://webchat.freenode.net){: target="_blank" class="_" }.
![Login to webchat screen](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 on IRC chat channels.</td>
</tr>
<tr>
<td><b>Channels</b></td>
<td><code>#docker</code></td>
</tr>
<tr>
<td><b>reCAPTCHA</b></td>
<td>Use the value provided.</td>
</tr>
</table>
| Field | Value |
|-----------|--------------------------------------------------------------|
| Nickname | The short name you want to be known as on IRC chat channels. |
| Channels | The list of channels to join. Start with `#docker`. |
| reCAPTCHA | A field to protect against spammers. Enter the value shown. |
3. Click on the "Connect" button.
@ -99,9 +91,9 @@ register:
![Registration needed screen](images/irc_after_login.png)
4. Register your nickname by entering the following command in the
command line bar:
command line bar:
```
```none
/msg NickServ REGISTER yourpassword youremail@example.com
```
@ -111,7 +103,7 @@ command line bar:
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
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.
@ -119,15 +111,16 @@ command line bar:
![Login screen](images/register_email.png)
6. Back in the browser, complete the registration according to the email by entering the following command into the webchat command line bar:
6. Back in the browser, complete the registration according to the email by entering
the following command into the webchat command line bar:
```
```none
/msg NickServ VERIFY REGISTER yournickname somecode
```
Your nickname is now registered to chat on freenode.net.
[Jump ahead to tips to join a docker channel and start chatting](get-help.md#tips)
[Jump ahead to tips to join a docker channel and start chatting](get-help.md#tips).
## IRCCloud
@ -135,47 +128,50 @@ 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>
1. Click
[here](https://www.irccloud.com/invite?channel=%23docker&amp;hostname=chat.freenode.net&amp;port=6697){: target="_blank" class="_" }
to join the `#docker` channel on chat.freenode.net.
The following web page is displayed in your browser:
![IRCCloud Register screen](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](get-help.md#start-chatting)
2. If this is your first time using IRCCloud, enter a valid email address in the
form.
If you already registered with IRCCloud, select the **sign in here** link.
You may have a cookie stored on your web browser that enables a quick
start **let's go** link instead of the above form. In this case, select the
**let's go** link and [jump ahead to start chatting](get-help.md#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.
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:
4. The instructions in the invite email take you to an IRCCloud Client web page in
your browser:
![IRCCloud](images/irccloud-register-nick.png)
The message shown above may appear indicating that you need to register your
The message shown above indicates 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:
5. To register your nickname, enter the following command into the command line bar
at the bottom of the IRCCloud client:
```
```none
/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:
6. Check your email for an invite to `freenode.net`:
![Login screen](images/register_email.png)
7. Back in the browser, complete the registration according to the email.
7. Complete the registration according to the email.
```
```none
/msg NickServ VERIFY REGISTER yournickname somecode
```
@ -188,7 +184,9 @@ The procedures in this section apply to both IRC clients.
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>
```none
/msg NickServ identify <password>
```
With Webchat if you forget or lose your password you'll need to join the
`#freenode` channel and request them to reset it for you.
@ -198,22 +196,22 @@ With Webchat if you forget or lose your password you'll need to join the
Join the `#docker` group using the following command in the command line bar of
your IRC Client:
/j #docker
```none
/j #docker
```
You can also join the `#docker-dev` group:
/j #docker-dev
You can also join the `#docker-dev` group.
### Start chatting
To ask questions to the group just type messages in the command line bar:
To ask questions to the group, type messages in the command line bar:
![Web Chat Screen](images/irc_chat.png)
## Learning more about IRC
## Learn more about IRC
This quickstart was meant to get you up and into IRC very quickly. If you find
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!).
This quickstart gets started with IRC. If you find
IRC useful, there is more to learn. Drupal, another open source project,
has
[a great IRC guide](https://www.drupal.org/irc/setting-up){: target="_blank" class="_" }.
(thanks Drupal!).