From 8c2f2a91bcd4d40abdf4f653fc7ac84ab0a7d6d1 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Tue, 31 Mar 2015 16:02:02 +0100 Subject: [PATCH] Update to readme to reference doc source more generally This patch updates the readme file to reference the documentation more generally, both in terms of the source and in terms of the version. Change-Id: Id2f47278905d8f2d1347da337109a80db9369eec --- README.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 471b3ab2ec..0aa4c47ebe 100644 --- a/README.rst +++ b/README.rst @@ -31,7 +31,7 @@ Basic Setup: 4. Fill in your ``openstack_deploy/openstack_user_config.yml``, ``openstack_deploy/user_secrets.yml`` and ``openstack_deploy/user_variables.yml`` files which you've just copied to your ``/etc/`` directory. 5. Generate all of your random passwords executing ``scripts/pw-token-gen.py --file /etc/openstack_deploy/user_secrets.yml``. 6. Accomplish all of the host networking that you want to use within the deployment. See the ``etc/network`` directory in this repository for an example network setup. - 7. When ready change to the ``playbooks/`` directory and execute your desired plays. IE: + 7. When ready change to the ``playbooks/`` directory and execute your desired plays. IE: .. code-block:: bash @@ -54,7 +54,10 @@ Bugs and Blueprints Everything we do is in launchpad and gerrit. If you'd like to raise a bug, feature request, or are looking for ways to contribute please go to "https://launchpad.net/openstack-ansible". -Official Documentation ----------------------- +Documentation +------------- -Comprehensive installation guides, including FAQs and release notes, can be found at "http://docs.rackspace.com/rpc/api/v9/bk-rpc-installation/content/rpc-common-front.html" < Note that these docs may not be up-to-date with the current release of this repository however they are still a good source of documentation. +While no os-ansible-deployment community documentation exists (yet), other than the .rst files present in this repository, comprehensive installation guides for Rackspace Private Cloud (an opinionated version of os-ansible-deployment) are available at "http://www.rackspace.com/knowledge_center/getting-started/rackspace-private-cloud". + +Note: + These docs may not be up-to-date with the current release of this repository however they are still a good source of documentation.