openstack
/
tripleo-docs
Code Issues Proposed changes

Update README files for TripleO documentation 

* update README.md to make it easier to get started with TripleO doc contributions
* convert README.md to README.rst with pandoc
* nuke README.md so we don't duplicate information
* update setup.cfg to account for removal of README.md

Change-Id: I7611959b2ea2b19010f0ef05fa3d54d4abfab806
This commit is contained in:
Leif Madsen 2016-01-13 22:15:34 +00:00
parent 66517c6caf
commit 44092c30a3
3 changed files with 41 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,4 +0,0 @@
TripleO Documentation
=====================
TripleO documentation.

42
README.rst
View File

@ -1,4 +1,42 @@
TripleO Documentation
==================================
=====================
Here lies the documentation for all things TripleO
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.

2
setup.cfg
View File

@ -2,7 +2,7 @@
name = tripleo-docs
summary = TripleO documentation
description-file =
README.md
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://docs.openstack.org/tripleo-docs