Eva Balycheva b53ff5d12c Refactoring of docs during Mitaka cycle

This patch improves Zaqar documentation and fixes currently existing
bugs.

Bugs this patch currently addresses and solutions:

Short names for documentation locations used in this commit message:
GitRepo - https://github.com/openstack/zaqar/
Contributor Docs - http://docs.openstack.org/developer/zaqar/
Wiki - https://wiki.openstack.org/wiki/Zaqar/

1. DRY violation and spreaded information for contributors bug.
The information for Zaqar contributors is spreaded/duplicated across
GitRepo, Contributor Docs and Wiki.
Examples of DRY violation are these three articles:
https://wiki.openstack.org/wiki/Zaqar/Give_Zaqar_a_try,
https://github.com/openstack/zaqar/blob/master/README.rst,
http://docs.openstack.org/developer/zaqar/development-environment.html

Example of spreaded information is: "zaqar/tests/functional/README.rst"
Normally the contributor want to see the information from this file in
"doc/source/running_tests.rst".

Solution: move useful missing information for contributors from Wiki and
GitRepo to Contributor Docs, then replace all contributor information in
Wiki and GitRepo with links to Contributor Docs.

2. Outdated information, missing new information and broken links bug.
Example is "test_suite.rst":
a. It still states that Zaqar test suite lives in two directories -
"tests" and "zaqar/tests", but now it's not true.
b. Doesn't contain information about how test invocation is organized,
what really happens when "tox -e py27" command executes.

Solution: replace outdated information with new, fix broken links if
possible, add useful missing information.

3. Style and formatting bugs.
The reference is http://docs.openstack.org/contributor-guide/.

Many documents in Contributor Docs have wrong line wrapping - some lines
are wrapped too short and some are wrapped too long.
Lines must wrap at 79 characters, exceptions are code and links.
Example is "first_review.rst" which lines are not wrapped at all.

Enumerated lists must be written using "#. " syntax.
Example with wrong enumerated list is "development.environment.rst".

Some inline elements must be styled according to:
http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html
Example with wrong styling of inline elements is
"development.environment.rst" where many paths and file names are not
marked with `` (double backticks).

By default code inserts are implicitly styled with python syntax.
There are many places in Contributor Docs where console (bash) code is
wrongly styled with python syntax.

Also there are some failed attempts to apply a formatting in Contributor
Docs. For example there is a broken list in "first_review.rst" at line
52.

Solution: fix broken formatting, apply proper style where it is needed.

Some of these bugs fixes closes few bug reports from:
https://etherpad.openstack.org/p/zaqar-mitaka-docs

Change-Id: Id668684248bdee03eb43b537dc2c6bb2a68ed23d

2016-01-07 17:05:09 +03:00

1.7 KiB

Raw Blame History

Project hosting with Launchpad

Launchpad hosts the Zaqar project. The Zaqar project homepage on Launchpad is http://launchpad.net/zaqar.

Launchpad credentials

Creating a login on Launchpad is important even if you don't use the Launchpad site itself, since Launchpad credentials are used for logging in on several OpenStack-related sites. These sites include:

Wiki

Gerrit (see gerrit)

Jenkins (see jenkins)

Mailing list

The developers mailing list address is openstack-dev@lists.openstack.org. This is a common mailing list across all OpenStack projects. To participate in the mailing list:

Subscribe at http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

The mailing list archives are at http://lists.openstack.org/pipermail/openstack-dev.

Bug tracking

Report Zaqar bugs at https://bugs.launchpad.net/zaqar

Feature requests (Blueprints)

Zaqar uses Launchpad Blueprints to track feature requests. Blueprints are at https://blueprints.launchpad.net/zaqar.

Technical support (Answers)

Zaqar uses Launchpad Answers to track Zaqar technical support questions. The Zaqar Answers page is at https://answers.launchpad.net/zaqar.

Note that Ask OpenStack (which is not hosted on Launchpad) can also be used for technical support requests.

You can also reach us in #openstack-zaqar IRC channel at irc.freenode.org.

1.7 KiB Raw Blame History