diff --git a/README.md b/README.md deleted file mode 100644 index 44d2f11a..00000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -TripleO Documentation -===================== - -TripleO documentation. diff --git a/README.rst b/README.rst index 3509252c..53253039 100644 --- a/README.rst +++ b/README.rst @@ -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 `__. + +You can find out more about TripleO at the `TripleO +Wiki `__. + +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 `__. + +General information about contributing to the OpenStack documentation +available at `OpenStack Documentation 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 `__ + +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. diff --git a/setup.cfg b/setup.cfg index 8ff3761c..436aabc7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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