From 233864ff32af10a2c927cdbca3475b537c8e6808 Mon Sep 17 00:00:00 2001 From: Steven Dake Date: Wed, 2 Sep 2015 22:33:01 -0700 Subject: [PATCH] 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 --- README.rst | 8 ++++---- {docs => doc}/ansible-deployment.rst | 0 {docs => doc}/cinder-guide.rst | 0 {docs => doc}/conf.py | 0 {docs => doc}/dev-quickstart.rst | 0 {docs => doc}/devenv-heat.rst | 0 {docs => doc}/devenv-vagrant.rst | 0 {docs => doc}/image-building.rst | 0 {docs => doc}/index.rst | 0 {docs => doc}/kollanet.png | Bin {docs => doc}/swift-readme.rst | 0 setup.cfg | 6 +++--- 12 files changed, 7 insertions(+), 7 deletions(-) rename {docs => doc}/ansible-deployment.rst (100%) rename {docs => doc}/cinder-guide.rst (100%) rename {docs => doc}/conf.py (100%) rename {docs => doc}/dev-quickstart.rst (100%) rename {docs => doc}/devenv-heat.rst (100%) rename {docs => doc}/devenv-vagrant.rst (100%) rename {docs => doc}/image-building.rst (100%) rename {docs => doc}/index.rst (100%) rename {docs => doc}/kollanet.png (100%) rename {docs => doc}/swift-readme.rst (100%) diff --git a/README.rst b/README.rst index 7bcc693c82..a6051221fb 100644 --- a/README.rst +++ b/README.rst @@ -21,9 +21,9 @@ Getting Started =============== Please get started by reading the `Developer -Quickstart `__ +Quickstart `__ followed by the `Ansible Deployment -Guide `__. +Guide `__. Docker Images ------------- @@ -31,7 +31,7 @@ Docker Images The `Docker images `__ are built by the Kolla project maintainers. A detailed process for contributing to the images can be found in the `image building -guide `__. +guide `__. Images reside in the Docker Hub `Kollaglue repo `__. @@ -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. diff --git a/docs/ansible-deployment.rst b/doc/ansible-deployment.rst similarity index 100% rename from docs/ansible-deployment.rst rename to doc/ansible-deployment.rst diff --git a/docs/cinder-guide.rst b/doc/cinder-guide.rst similarity index 100% rename from docs/cinder-guide.rst rename to doc/cinder-guide.rst diff --git a/docs/conf.py b/doc/conf.py similarity index 100% rename from docs/conf.py rename to doc/conf.py diff --git a/docs/dev-quickstart.rst b/doc/dev-quickstart.rst similarity index 100% rename from docs/dev-quickstart.rst rename to doc/dev-quickstart.rst diff --git a/docs/devenv-heat.rst b/doc/devenv-heat.rst similarity index 100% rename from docs/devenv-heat.rst rename to doc/devenv-heat.rst diff --git a/docs/devenv-vagrant.rst b/doc/devenv-vagrant.rst similarity index 100% rename from docs/devenv-vagrant.rst rename to doc/devenv-vagrant.rst diff --git a/docs/image-building.rst b/doc/image-building.rst similarity index 100% rename from docs/image-building.rst rename to doc/image-building.rst diff --git a/docs/index.rst b/doc/index.rst similarity index 100% rename from docs/index.rst rename to doc/index.rst diff --git a/docs/kollanet.png b/doc/kollanet.png similarity index 100% rename from docs/kollanet.png rename to doc/kollanet.png diff --git a/docs/swift-readme.rst b/doc/swift-readme.rst similarity index 100% rename from docs/swift-readme.rst rename to doc/swift-readme.rst diff --git a/setup.cfg b/setup.cfg index 678776679e..86514738fe 100644 --- a/setup.cfg +++ b/setup.cfg @@ -24,7 +24,7 @@ data_files = share/kolla/ansible = ansible/* share/kolla/devenv = devenv/* share/kolla/docker = docker/* - share/kolla/docs = docs/* + share/kolla/doc = doc/* share/kolla/etc_examples = etc/* share/kolla/vagrant = vagrant/* share/kolla = tools/init-runonce @@ -45,5 +45,5 @@ setup-hooks = [build_sphinx] all_files = 1 -build-dir = docs/build -source-dir = docs/ +build-dir = doc/build +source-dir = doc/