e63bc9c0ab
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/65852673eba54e723401f2ef049673b2\n' Change-Id: Ied7ae786a47a2b523e68bd7c9d6554e9822a95a3
52 lines
1.7 KiB
ReStructuredText
52 lines
1.7 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/tripleo-docs.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
TripleO Documentation
|
|
=====================
|
|
|
|
This is the documentation source for the TripleO project. You can read
|
|
the generated documentation at `TripleO
|
|
Docs <http://docs.openstack.org/developer/tripleo-docs/>`__.
|
|
|
|
You can find out more about TripleO at the `TripleO
|
|
Wiki <https://wiki.openstack.org/wiki/TripleO>`__.
|
|
|
|
Getting Started
|
|
---------------
|
|
|
|
Documentation for the TripleO project is hosted on the OpenStack Gerrit
|
|
site. You can view all open and resolved issues in the
|
|
``openstack/tripleo-docs`` project at `TripleO
|
|
Reviews <https://review.openstack.org/#/q/project:openstack/tripleo-docs>`__.
|
|
|
|
General information about contributing to the OpenStack documentation
|
|
available at `OpenStack Documentation Contributor
|
|
Guide <http://docs.openstack.org/contributor-guide/>`__
|
|
|
|
Quick Start
|
|
-----------
|
|
|
|
The following is a quick set of instructions to get you up and running
|
|
by building the TripleO documentation locally. The first step is to get
|
|
your Python environment configured. Information on configuring is
|
|
available at `Python Project
|
|
Guide <http://docs.openstack.org/project-team-guide/project-setup/python.html>`__
|
|
|
|
Next you can generate the documentation using the following command. Be
|
|
sure to run all the commands from within the recently checked out
|
|
repository.
|
|
|
|
::
|
|
|
|
tox -edocs
|
|
|
|
Now you have the documentation generated for the various available
|
|
formats from the local source. The resulting documentation will be
|
|
available within the ``doc/build/`` directory.
|