aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSteven Dake <stdake@cisco.com>2015-09-02 22:33:01 -0700
committerSteven Dake <stdake@cisco.com>2015-09-02 22:37:36 -0700
commit233864ff32af10a2c927cdbca3475b537c8e6808 (patch)
tree99a0f159b60f736faa09871db363ebd5da1f7d8d /README.rst
parent3ed7b3c3b4cb6c00cb9c3c55c9f00265e805d18f (diff)
downloadkolla-233864ff32af10a2c927cdbca3475b537c8e6808.tar.gz
kolla-233864ff32af10a2c927cdbca3475b537c8e6808.zip
Rename docs dir to doc for publishing
The publishing docs expect the documentation to be present in the /doc directory not the /docs directory. If the documentation is in the /docs directory, according to fungi the docs won't be published properly. Change-Id: I718fec7e69d298a5cb2376ca4e2455e12169566e Partially-Implements: blueprint kola-tox-doc
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 7bcc693c8..a6051221f 100644
--- a/README.rst
+++ b/README.rst
@@ -21,9 +21,9 @@ Getting Started
===============
Please get started by reading the `Developer
-Quickstart <https://github.com/stackforge/kolla/blob/master/docs/dev-quickstart.rst>`__
+Quickstart <https://github.com/stackforge/kolla/blob/master/doc/dev-quickstart.rst>`__
followed by the `Ansible Deployment
-Guide <https://github.com/stackforge/kolla/blob/master/docs/ansible-deployment.rst>`__.
+Guide <https://github.com/stackforge/kolla/blob/master/doc/ansible-deployment.rst>`__.
Docker Images
-------------
@@ -31,7 +31,7 @@ Docker Images
The `Docker images <https://docs.docker.com/userguide/dockerimages/>`__
are built by the Kolla project maintainers. A detailed process for
contributing to the images can be found in the `image building
-guide <https://github.com/stackforge/kolla/blob/master/docs/image-building.rst>`__.
+guide <https://github.com/stackforge/kolla/blob/master/doc/image-building.rst>`__.
Images reside in the Docker Hub `Kollaglue
repo <https://registry.hub.docker.com/repos/kollaglue/>`__.
@@ -71,7 +71,7 @@ Directories
Ansible.
- demos - Contains a few demos to use with Kolla.
- devenv - Contains an OpenStack-Heat based development environment.
-- docs - Contains documentation.
+- doc - Contains documentation.
- etc - Contains a reference etc directory structure which requires
configuration of a small number of configuration variables to achieve
a working All-in-One (AIO) deployment.