From c74009025f097a6a8743cc4e20a70dd29a6e558d Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Sat, 10 Nov 2012 15:57:59 -0800 Subject: [PATCH] tweaking docs to fix link to wiki Keystone page updated docstrings to remove two errors reformatted front page header to be consistent added links to autogenerated python documentation Change-Id: I59fddc12ff458bbd0102a40d4d85903ab6bd6394 --- doc/source/community.rst | 9 ++++++++- doc/source/index.rst | 4 ++-- keystone/common/bufferedhttp.py | 2 ++ keystone/policy/backends/rules.py | 16 ++++++++-------- keystone/token/core.py | 7 ++++--- 5 files changed, 24 insertions(+), 14 deletions(-) diff --git a/doc/source/community.rst b/doc/source/community.rst index 975d1bdc22..a4ca44ebb7 100644 --- a/doc/source/community.rst +++ b/doc/source/community.rst @@ -56,7 +56,7 @@ blueprint, or collaborate with others. `OpenStack Wiki `_ -* `useful keystone project links `_ +* `useful keystone project links `_ Keystone on Launchpad --------------------- @@ -68,6 +68,13 @@ code is hosted on GitHub * `Keystone Project Page on Launchpad `_ * `Keystone Source Repository on GitHub `_ +Within launchpad, we use +`blueprints `_, to track feature +work, and track `bugs `_ as well. If +you are looking for a place to get started contributing to keystone, please +look at any bugs for keystone that are tagged as `low-hanging-fruit +`_. + OpenStack Blog -------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 6827fb7459..97b07793b8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,7 +48,7 @@ Getting Started community Man Pages ---------- +========= .. toctree:: :maxdepth: 1 @@ -72,7 +72,7 @@ Code Documentation .. toctree:: :maxdepth: 1 - modules + api/autoindex Indices and tables ================== diff --git a/keystone/common/bufferedhttp.py b/keystone/common/bufferedhttp.py index 8738cacadb..7461dc273d 100644 --- a/keystone/common/bufferedhttp.py +++ b/keystone/common/bufferedhttp.py @@ -129,6 +129,7 @@ def http_connect(ipaddr, port, device, partition, method, path, :param key_file Private key file (not needed if cert_file has private key) :param cert_file Certificate file (Keystore) :returns: HTTPConnection object + """ path = quote('/' + device + '/' + str(partition) + path) return http_connect_raw(ipaddr, port, device, partition, method, path, @@ -153,6 +154,7 @@ def http_connect_raw(ipaddr, port, method, path, headers=None, :param key_file Private key file (not needed if cert_file has private key) :param cert_file Certificate file (Keystore) :returns: HTTPConnection object + """ if ssl: conn = HTTPSConnection('%s:%s' % (ipaddr, port), key_file=key_file, diff --git a/keystone/policy/backends/rules.py b/keystone/policy/backends/rules.py index 92a90efac4..c0df430e99 100644 --- a/keystone/policy/backends/rules.py +++ b/keystone/policy/backends/rules.py @@ -79,20 +79,20 @@ def enforce(credentials, action, target): """Verifies that the action is valid on the target in this context. :param credentials: user credentials - :param action: string representing the action to be checked - - this should be colon separated for clarity. - i.e. compute:create_instance - compute:attach_volume - volume:attach_volume - + :param action: string representing the action to be checked, which + should be colon separated for clarity. :param target: dictionary representing the object of the action for object creation this should be a dictionary representing the location of the object e.g. {'tenant_id': object.tenant_id} - :raises: `exception.Forbidden` if verification fails. + Actions should be colon separated for clarity. For example: + + * compute:create_instance + * compute:attach_volume + * volume:attach_volume + """ init() diff --git a/keystone/token/core.py b/keystone/token/core.py index 56ef13fe99..05994538b0 100644 --- a/keystone/token/core.py +++ b/keystone/token/core.py @@ -56,9 +56,10 @@ class Driver(object): def token_to_key(self, token_id): """ Converts PKI tokens to their short form used for keys in Database tables, memcached, and other lookup tables. - returns: if given a PKI token, returns its hashed value - Otherwise, returns the passed-in value if given a UUID or - hash of a token. + + :returns: if given a PKI token, returns its hashed value + Otherwise, returns the passed-in value if given a UUID or + hash of a token. """ return cms.cms_hash_token(token_id)