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 <