Reorganize common and specific documentation
Specific contributor guides have directories for their own specific documentation. It's now more obvious which documentation is common and being pulled in which guides. Change-Id: Iea9622fff58cf5c8806f5ae59198245902632551
This commit is contained in:
Mike Perez
parent
04ff3a3996
commit
3f2cd4cb80
|
|
@ -6,7 +6,7 @@ Code & Documentation Contributor Guide
|
|||
:caption: Code and Documentation Contributors
|
||||
:maxdepth: 2
|
||||
|
||||
irc
|
||||
accounts
|
||||
git
|
||||
setup-gerrit
|
||||
/common/irc
|
||||
/common/accounts
|
||||
/common/git
|
||||
/common/setup-gerrit
|
||||
|
|
@ -28,7 +28,7 @@ Sign Up
|
|||
<https://www.openstack.org/legal/community-code-of-conduct/>`_.
|
||||
#. Complete the application.
|
||||
|
||||
.. image:: _assets/account-setup/2.png
|
||||
.. image:: /_assets/account-setup/2.png
|
||||
|
||||
|
||||
Setup Your Bug Tracker Account
|
||||
|
|
@ -63,7 +63,7 @@ Sign Up
|
|||
#. Fill in your email address, name, password, and accepting the terms of
|
||||
services.
|
||||
|
||||
.. image:: _assets/account-setup/1.png
|
||||
.. image:: /_assets/account-setup/1.png
|
||||
|
||||
|
||||
Launchpad
|
||||
|
|
@ -38,7 +38,7 @@ Edit Nick Name Settings
|
|||
#. From the list of **Networks** you should see Freenode. Select that and click
|
||||
'edit'.
|
||||
|
||||
.. image:: _assets/irc/linux/1.png
|
||||
.. image:: /_assets/irc/linux/1.png
|
||||
|
||||
|
||||
Edit Server Settings
|
||||
|
|
@ -47,7 +47,7 @@ Edit Server Settings
|
|||
#. Make sure that **Use SSL for all the servers on this network** is
|
||||
checked.
|
||||
|
||||
.. image:: _assets/irc/linux/2.png
|
||||
.. image:: /_assets/irc/linux/2.png
|
||||
|
||||
Troubleshooting
|
||||
^^^^^^^^^^^^^^^
|
||||
|
|
@ -61,7 +61,7 @@ If all goes well we should get a dialog window indicating the connection to
|
|||
freenode has completed, and what to do next.. For now we'll select "Nothing,
|
||||
I'll join a channel later."
|
||||
|
||||
.. image:: _assets/irc/linux/3.png
|
||||
.. image:: /_assets/irc/linux/3.png
|
||||
|
||||
When you login to the server for the first time with your nickname, its being
|
||||
used by you, but it's still not registered yet.
|
||||
|
|
@ -76,7 +76,7 @@ address::
|
|||
|
||||
/msg nickserv register mysecretpassword test@domain.com
|
||||
|
||||
.. image:: _assets/irc/linux/4.png
|
||||
.. image:: /_assets/irc/linux/4.png
|
||||
|
||||
If all goes well you should receive a message back instantly that the nick name
|
||||
is registered by you and an activation email will be sent to the email address
|
||||
|
|
@ -95,7 +95,7 @@ need to tell Hexchat to communicate our password over upon connecting.
|
|||
#. In the **Password** put in the password we picked in the previous
|
||||
step and click close.
|
||||
|
||||
.. image:: _assets/irc/linux/5.png
|
||||
.. image:: /_assets/irc/linux/5.png
|
||||
|
||||
|
||||
Done
|
||||
|
|
@ -135,13 +135,13 @@ Add A New Connection
|
|||
#. For the **Chat Server Port** type in **6697** and check the **SSL
|
||||
Connection** box.
|
||||
|
||||
.. image:: _assets/irc/macos/1.png
|
||||
.. image:: /_assets/irc/macos/1.png
|
||||
:width: 50%
|
||||
|
||||
If all goes well in the second window we should see our our new connection and
|
||||
our client connected.
|
||||
|
||||
.. image:: _assets/irc/macos/2.png
|
||||
.. image:: /_assets/irc/macos/2.png
|
||||
:width: 50%
|
||||
|
||||
Troubleshooting
|
||||
|
|
@ -153,7 +153,7 @@ Troubleshooting
|
|||
* Click **disconnect** and click **connect** to retry connecting with the
|
||||
new nick name.
|
||||
|
||||
.. image:: _assets/irc/macos/3.png
|
||||
.. image:: /_assets/irc/macos/3.png
|
||||
:width: 50%
|
||||
|
||||
|
||||
|
|
@ -179,7 +179,7 @@ your own password and email address::
|
|||
|
||||
register mysecretpassword test@domain.com
|
||||
|
||||
.. image:: _assets/irc/macos/4.png
|
||||
.. image:: /_assets/irc/macos/4.png
|
||||
:width: 90%
|
||||
|
||||
If all goes well you should receive a message back instantly that the nick name
|
||||
|
|
@ -196,7 +196,7 @@ need to tell Colloquy to communicate our password over upon connecting.
|
|||
click the **info** icon.
|
||||
#. In the **Password** field type your password.
|
||||
|
||||
.. image:: _assets/irc/macos/5.png
|
||||
.. image:: /_assets/irc/macos/5.png
|
||||
:width: 50%
|
||||
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ Individual Contributors
|
|||
this to contribute code & documentation. You will not be able to push patches
|
||||
to Gerrit without this.
|
||||
|
||||
.. image:: _assets/account-setup/3.png
|
||||
.. image:: /_assets/account-setup/3.png
|
||||
:scale: 70%
|
||||
:align: center
|
||||
|
||||
|
|
@ -68,7 +68,7 @@ If you are contributing on behalf of a company or organization.
|
|||
#. In Gerrit's `settings <https://review.openstack.org/#/settings/agreements>`_
|
||||
click the **New Contributor Agreement** link and sign the agreement.
|
||||
|
||||
.. image:: _assets/account-setup/3.png
|
||||
.. image:: /_assets/account-setup/3.png
|
||||
:scale: 70%
|
||||
:align: center
|
||||
|
||||
|
|
@ -38,7 +38,8 @@ examples of project team specific contributor guides are the `Nova team's
|
|||
Adding/Updating Content
|
||||
=======================
|
||||
Before you modify or add new content first get familiar with OpenStack's
|
||||
code/documentation practices. You can read the :doc:`../code-and-documentation`
|
||||
code/documentation practices. You can read the
|
||||
:doc:`/code-and-documentation/index`
|
||||
for getting started.
|
||||
|
||||
Once you've read through the guide, use git to clone the Contributor Guide
|
||||
|
|
@ -83,9 +84,9 @@ Examples of Good Documentation
|
|||
Use chapters that have already been accepted to get a feel of what we're
|
||||
looking for.
|
||||
|
||||
* :doc:`../irc`
|
||||
* :doc:`../git`
|
||||
* :doc:`../setup-gerrit`
|
||||
* :doc:`/common/irc`
|
||||
* :doc:`/common/git`
|
||||
* :doc:`/common/setup-gerrit`
|
||||
|
||||
How Can I Start Helping?
|
||||
========================
|
||||
|
|
@ -100,4 +101,4 @@ We want you to succeed! You can ask for help on `IRC Freenode
|
|||
for help on the `OpenStack Dev Mailing list
|
||||
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_ prefixing
|
||||
your email subject with '[contributor-guide]'. If you're not familiar with
|
||||
these ways of communicating, read the :doc:`../code-and-documentation`.
|
||||
these ways of communicating, read the :doc:`/code-and-documentation/index`.
|
||||
|
|
|
|||
|
|
@ -10,8 +10,8 @@ The OpenStack Contributor Guide
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
code-and-documentation
|
||||
users
|
||||
code-and-documentation/index
|
||||
users/index
|
||||
contributing/index
|
||||
|
||||
Indices and tables
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Users' Contributor Guide
|
|||
:caption: User Contributors
|
||||
:maxdepth: 2
|
||||
|
||||
irc
|
||||
accounts
|
||||
git
|
||||
setup-gerrit
|
||||
/common/irc
|
||||
/common/accounts
|
||||
/common/git
|
||||
/common/setup-gerrit
|
||||
Loading…
Reference in New Issue