From faea392eb649e399b48a57065d766e977580de47 Mon Sep 17 00:00:00 2001
From: Adam Gandelman <adamg@ubuntu.com>
Date: Fri, 5 Jun 2015 14:13:23 -0700
Subject: [PATCH] Rename ./doc/ -> ./docs/, update dev docs

Renames doc -> docs, should help get readthedocs integration working correctly.

Also updates the developer quickstart guide.

Change-Id: I179df0891957b56823ba72d0816a9a46e816b2ff
---
 {doc => docs}/.gitignore                        |   0
 {doc => docs}/Makefile                          |   0
 {doc => docs}/source/_static/neutron-akanda.png | Bin
 .../source/_static/neutron-canonical.png        | Bin
 {doc => docs}/source/appliance.rst              |   0
 {doc => docs}/source/architecture.rst           |   0
 {doc => docs}/source/conf.py                    |   0
 {doc => docs}/source/contribute.rst             |   0
 {doc => docs}/source/developer_quickstart.rst   |  16 ++++++++++++++--
 {doc => docs}/source/index.rst                  |   0
 {doc => docs}/source/operation.rst              |   0
 {doc => docs}/source/reference.rst              |   0
 {doc => docs}/source/rug.rst                    |   0
 {doc => docs}/source/sample_boot.dot            |   0
 {doc => docs}/source/worker_diagram.dot         |   0
 setup.cfg                                       |   4 ++--
 16 files changed, 16 insertions(+), 4 deletions(-)
 rename {doc => docs}/.gitignore (100%)
 rename {doc => docs}/Makefile (100%)
 rename {doc => docs}/source/_static/neutron-akanda.png (100%)
 rename {doc => docs}/source/_static/neutron-canonical.png (100%)
 rename {doc => docs}/source/appliance.rst (100%)
 rename {doc => docs}/source/architecture.rst (100%)
 rename {doc => docs}/source/conf.py (100%)
 rename {doc => docs}/source/contribute.rst (100%)
 rename {doc => docs}/source/developer_quickstart.rst (75%)
 rename {doc => docs}/source/index.rst (100%)
 rename {doc => docs}/source/operation.rst (100%)
 rename {doc => docs}/source/reference.rst (100%)
 rename {doc => docs}/source/rug.rst (100%)
 rename {doc => docs}/source/sample_boot.dot (100%)
 rename {doc => docs}/source/worker_diagram.dot (100%)

diff --git a/doc/.gitignore b/docs/.gitignore
similarity index 100%
rename from doc/.gitignore
rename to docs/.gitignore
diff --git a/doc/Makefile b/docs/Makefile
similarity index 100%
rename from doc/Makefile
rename to docs/Makefile
diff --git a/doc/source/_static/neutron-akanda.png b/docs/source/_static/neutron-akanda.png
similarity index 100%
rename from doc/source/_static/neutron-akanda.png
rename to docs/source/_static/neutron-akanda.png
diff --git a/doc/source/_static/neutron-canonical.png b/docs/source/_static/neutron-canonical.png
similarity index 100%
rename from doc/source/_static/neutron-canonical.png
rename to docs/source/_static/neutron-canonical.png
diff --git a/doc/source/appliance.rst b/docs/source/appliance.rst
similarity index 100%
rename from doc/source/appliance.rst
rename to docs/source/appliance.rst
diff --git a/doc/source/architecture.rst b/docs/source/architecture.rst
similarity index 100%
rename from doc/source/architecture.rst
rename to docs/source/architecture.rst
diff --git a/doc/source/conf.py b/docs/source/conf.py
similarity index 100%
rename from doc/source/conf.py
rename to docs/source/conf.py
diff --git a/doc/source/contribute.rst b/docs/source/contribute.rst
similarity index 100%
rename from doc/source/contribute.rst
rename to docs/source/contribute.rst
diff --git a/doc/source/developer_quickstart.rst b/docs/source/developer_quickstart.rst
similarity index 75%
rename from doc/source/developer_quickstart.rst
rename to docs/source/developer_quickstart.rst
index 83c500d..4097094 100644
--- a/doc/source/developer_quickstart.rst
+++ b/docs/source/developer_quickstart.rst
@@ -53,20 +53,32 @@ and enable the relevant services::
     ADMIN_PASSWORD=secret
     END
 
+You may wish to SSH into the appliance VMs for debugging purposes. The RUG will
+enable access for the 'akanda' user for a specified public key.  This may be
+specified by setting AKANDA_APPLIANCE_SSH_PUBLIC_KEY variable in your devstack
+config to point to an existing public key.  The default is
+$HOME/.ssh/id_rsa.pub.
+
 Building a Custom Service VM
 ++++++++++++++++++++++++++++
 
 By default, the Akanda plugin downloads a pre-built official Akanda image.  To
-build your own from source, enable ``BUILD_AKANDA_DEV_APPLIANCE`` and specify
+build your own from source, enable ``BUILD_AKANDA_APPLIANCE_IMAGE`` and specify
 a repository and branch to build from::
 
     cat >>/opt/stack/devstack/local.conf <<END
 
-    BUILD_AKANDA_DEV_APPLIANCE=True
+    BUILD_AKANDA_APPLIANCE_IMAGE=True
     AKANDA_APPLIANCE_REPO=http://github.com/stackforge/akanda-appliance.git
     AKANDA_APPLIANCE_BRANCH=master
     END
 
+To build the appliance using locally modified ``akanda-appliance`` code, you
+may point devstack at the local git checkout by setting the
+AKANDA_APPLIANCE_DIR variable.  Ensure that any changes you want included in
+the image build have been committed to the repository and it is checked out
+to the proper commit.
+
 Deploying
 +++++++++
 
diff --git a/doc/source/index.rst b/docs/source/index.rst
similarity index 100%
rename from doc/source/index.rst
rename to docs/source/index.rst
diff --git a/doc/source/operation.rst b/docs/source/operation.rst
similarity index 100%
rename from doc/source/operation.rst
rename to docs/source/operation.rst
diff --git a/doc/source/reference.rst b/docs/source/reference.rst
similarity index 100%
rename from doc/source/reference.rst
rename to docs/source/reference.rst
diff --git a/doc/source/rug.rst b/docs/source/rug.rst
similarity index 100%
rename from doc/source/rug.rst
rename to docs/source/rug.rst
diff --git a/doc/source/sample_boot.dot b/docs/source/sample_boot.dot
similarity index 100%
rename from doc/source/sample_boot.dot
rename to docs/source/sample_boot.dot
diff --git a/doc/source/worker_diagram.dot b/docs/source/worker_diagram.dot
similarity index 100%
rename from doc/source/worker_diagram.dot
rename to docs/source/worker_diagram.dot
diff --git a/setup.cfg b/setup.cfg
index 4cb3e1f..4e32703 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -7,8 +7,8 @@ author = Akanda
 home-page = http://akanda.io
 
 [build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
+source-dir = docs/source
+build-dir = docs/build
 all_files = 1
 
 [pbr]