From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Thu, 16 Aug 2018 19:35:59 +0000 (-0400)
Subject: Tune initial Freenode docs
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F85%2F12285%2F2;p=releng%2Fdocs.git

Tune initial Freenode docs

- Move LF channel details to it's own section.
- Use <> to indicate REQUIRED fields as [] is for OPTIONAL.
- Reword some of the text to be more clear.

Change-Id: I076df768655e06c90fc337736e03a058e392d356
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/freenode.rst b/docs/freenode.rst
index 58f7aea..9ee2e90 100644
--- a/docs/freenode.rst
+++ b/docs/freenode.rst
@@ -1,18 +1,26 @@
-.. _lfdocs-freenode:
+.. _freenode:
 
 ############
 Freenode IRC
 ############
 
-Freenode, is an IRC network used to discuss peer-directed projects.
+Freenode, is an IRC network used to discuss peer-directed projects. Freenode is
+a popular choice for Open Source project collaboration and having your project
+use this network makes it easy to cross collaborate with other communities.
 
-``#lf-releng`` is the Linux Foundation Releng channel for asking general questions
-about jjb / lftools / packer / etc...
+The Linux Foundation operates :ref:`support channels
+<freenode-lf-channels>` to provide community help.
 
-.. note::
+.. important::
+
+   Due to prolonged SPAM attacks on Freenode, all Linux Foundation project
+   channels now require registered accounts to join.
+   :ref:`Register <freenode-register>` your account with the instructions below.
+
+.. _freenode-register:
 
-      Due to prolonged SPAM attacks on freenode, all Linux Foundation project
-      channels now require registered accounts to join.
+Register your username
+======================
 
 To register you must set your nick, register it and authenticate.
 
@@ -20,31 +28,55 @@ Set your IRC nick:
 
 .. code-block:: none
 
-      /nick [username]
+   /nick <username>
 
 Register your IRC nick:
 
 .. code-block:: none
 
-      /msg NickServ REGISTER [password] [youremail@example.com]
+   /msg NickServ REGISTER <password> <youremail@example.com>
 
 To Authenticate:
 
 .. code-block:: none
 
-      /msg NickServ IDENTIFY [username] [password]
+   /msg NickServ IDENTIFY <username> <password>
 
 
 .. note::
 
-      If you are already registred and encounter
-      "-!- Nick YourNick is already in use"
-      you will need to ghost your nick:
+   If you are already registered and encounter
+   "-!- Nick YourNick is already in use"
+   you will need to ghost your nick:
+
+   .. code-block:: none
+
+      /msg NickServ ghost <username> <password>
+
+   This command kicks whoever is using your nick allowing you to take it back.
+
+Your IRC client will have a way of automating your login identification
+please refer to the docs of your IRC client for instructions.
+
+For further details on the Freenode registration process,
+please see https://freenode.net/kb/answer/registration
+
+
+.. _freenode-lf-channels:
 
-      .. code-block:: none
+Linux Foundation Channels
+=========================
 
-            /msg NickServ ghost [username] [password]
+The Linux Foundation operates the following channels on IRC. We recommend
+project developers to at least join the ``#lf-releng`` channel for releng or
+CI related questions.
 
-Your IRC client will have a way of automating your login
-please refer to their docs for instructions.
-For further info please see https://freenode.net/kb/answer/registration
+================ ==============================================================
+Channel          Details
+================ ==============================================================
+#lf-docs         For cross community documentation collaboration.
+#lf-releng       Linux Foundation Release Engineering channel for asking
+                 general support questions as well as LF projects such as
+                 jjb / lftools / packer / etc...
+#lf-unregistered Redirect channel for unauthenicated users.
+================ ==============================================================