From 3c2ff2a9c024383bc4f4310e8bf03ab427da2f11 Mon Sep 17 00:00:00 2001 From: Fernando Diaz Date: Sun, 6 Sep 2015 17:50:13 -0500 Subject: [PATCH] Fix barbican-client README.rst Current README.rst does not work off the bat. This patches fixes the documentation so that the user knows to setup Keystone so that the command will work. Change-Id: I8d49b2df08e17efe6f23e9fbf51a14b262a7420c --- README.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ac34477d..68317566 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ The full api is `documented in the official OpenStack documentation site >> from keystoneclient.auth import identity >>> from keystoneclient import session @@ -66,6 +66,12 @@ with keystone authentication: >>> print(retrieved_secret.payload) the magic words are squeamish ossifrage +.. note:: + + In order for the example above to work Barbican must be running and + configured to use the Keystone Middleware. For more information on + setting this up please visit: + http://docs.openstack.org/developer/barbican/setup/keystone.html [1]_ barbican - Command Line Client ------------------------------ @@ -172,3 +178,6 @@ The command line client is self-documenting. Use the --help flag to access the u * Documentation: http://docs.openstack.org/developer/python-barbicanclient * Source: http://git.openstack.org/cgit/openstack/python-barbicanclient * Bugs: http://bugs.launchpad.net/python-barbicanclient + +.. [1] Documentation in this link is currently incomplete. Please use the +`devstack setup. `__ \ No newline at end of file