diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index c8df4e9..146cd80 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -9,6 +9,7 @@ Code & Documentation Contributor Guide /common/irc /common/accounts /common/git + /common/communication /common/setup-gerrit /common/task-tracking /common/i18n diff --git a/doc/source/common/communication.rst b/doc/source/common/communication.rst new file mode 100644 index 0000000..a7d90d4 --- /dev/null +++ b/doc/source/common/communication.rst @@ -0,0 +1,51 @@ +############# +Communication +############# + +IRC +=== +While working with OpenStack, IRC is the best way to get help or support +others. Details of IRC communication are described in :ref:`setup-irc`. + +Wiki Pages +========== + +Each project and working group has its own `wiki page +`__. +Wiki pages are a secondary source of information. They hold information that is +subject to more change than the info provided in the project's documentation +i.e. meeting agendas, team members, etc. + +Etherpads +========= + +Etherpad is a simple collaborative text editor. It is used as a common place to +have people in a project collaborate on larger projects and planning of events. +There is no master list of etherpads - it is harder to find what you are +looking for without having looked at it before or without asking for the URL. +It is recommended to bookmark the important etherpads for later reference. +The staring page of the OpenStack `Etherpad `_. + +.. _communication-mailing-lists: + +Mailing Lists (ML) +================== + +There are more than 40 different ML's. These are listed in the `mailman page +`__. +Mailing lists are a way for people to communicate to a larger group than those +that are on IRC. All emails on these lists are archived and available on the +`Mailing Lists `_ wiki. +The same page describes how to subscribe to a list and describes some popular +lists. + +Ask OpenStack +============= + +`Ask OpenStack `__ is a question and answer site +for OpenStack users and developers. It provides answer to almost every +question a new contributor can run into. It is possible to collect karma points +by asking or answering questions. The questions are moderated by Ask OpenStack +users with high Karma points. More info about Ask OpenStack is available on +its `about page `__ and on the `ask +moderators wiki `__. diff --git a/doc/source/common/irc.rst b/doc/source/common/irc.rst index b37aa6e..55d0a7a 100644 --- a/doc/source/common/irc.rst +++ b/doc/source/common/irc.rst @@ -1,3 +1,5 @@ +.. _setup-irc: + ######### Setup IRC ######### @@ -220,6 +222,8 @@ United States work hours and it might be a while before they respond. IRC Channels ============ +Each project and working group has its own IRC channel. The common syntax for +naming the IRC channels is: #openstack-. The list of OpenStack related IRC channels is maintained on a `wiki page `__. @@ -227,9 +231,14 @@ IRC Meetings ============ In OpenStack all the meetings are happening on a variety of IRC -channels. Check the `list of meetings -`__ for meetings times, IRC channels, -and archives of meetings. +channels (e.g. #openstack-meeting, #openstack-meeting-cp, etc.). Check the +`list of meetings `__ for meetings times, IRC +channels, and archives of meetings. + +.. note:: + There are a finite number of meeting channels so that meetings are + spread around. This is enforced by infra. The #openstack-meeting-cp + channel is special in that it is dedicated to cross project efforts. IRC Archives ============ diff --git a/doc/source/operators/index.rst b/doc/source/operators/index.rst index e9ac79e..a8c467b 100644 --- a/doc/source/operators/index.rst +++ b/doc/source/operators/index.rst @@ -8,6 +8,7 @@ Operators' Contributor Guide /common/irc /common/accounts + /common/communication /common/git /common/setup-gerrit /operators/participate diff --git a/doc/source/operators/participate.rst b/doc/source/operators/participate.rst index 729fee9..436d6b9 100644 --- a/doc/source/operators/participate.rst +++ b/doc/source/operators/participate.rst @@ -8,12 +8,17 @@ Operators have a Dedicated `mailing list `_ to subscribe. You can also read the archives which contain plenty of valuable information. +More generic information about mailing lists can be found in the Communication +page's :ref:`communication-mailing-lists` section. IRC Channels ============ There is the #openstack-operators channel on Freenode IRC for live conversations and `Operators' team meeting `_. +On top of the #openstack-operators channel there are several others. More +generic information about IRC channels can be found in the :ref:`irc-channels` +section of the IRC page. Meet Ups ======== diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 95d2a1f..4c0ed5a 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -8,5 +8,6 @@ Users' Contributor Guide /common/irc /common/accounts + /common/communication /common/git /common/setup-gerrit