[OpenStack-docs] [user-guide] Python SDK examples

Monty Taylor mordred at inaugust.com
Mon May 30 20:05:25 UTC 2016


On 05/24/2016 09:07 AM, Anne Gentle wrote:
> Hi all,
> 
> I want to follow up on a question from the docs meeting about the Python
> SDK examples that were in the User Guide. This spec [1] indicated they
> should be moved to developer.openstack.org
> <http://developer.openstack.org>, but doesn't indicate which guide they
> could become a part of or if it should be a standalone guide. I looked
> at the examples and they are from the novaclient, keystoneclient,
> neutronclient, and so on. Example code at [2]. While it's nice to
> centrally locate this info, it might be better to rewrite the examples
> to use openstackclient.
> 
> I think it's correct to move the content to api-site, though I'd like
> someone to determine if the files can fit into the API Quick Start
> (perhaps with a title change) or as a standalone guide.
> 
> Also, should someone revise the examples to use openstackclient? If so,
> then would it make sense to patch the python-openstackclient repo? [3]
> Copying Brian and Everett to see if they have opinions. Output is here
> [4] for easier readability.
> 
> Thanks,
> Anne
> 
> 1.
>  http://specs.openstack.org/openstack/docs-specs/specs/mitaka/user-guides-mitaka-reorg.html
> 2.
> http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide/source/sdk_authenticate_against_networking_endpoint.rst


> 3. http://git.openstack.org/cgit/openstack/python-openstackclient
> 4. http://docs.openstack.org/user-guide/sdk_authenticate_against_identity_endpoint.html

The code examples (in 2 and 4) are incorrect anyway, even using *client.
I'll send in a change to fix them to at least be correct for *client. I
also agree that we should likely have the examples be using the sdk and
not *client - but I'll leave that to someone else for now.

> -- 
> Anne Gentle
> www.justwriteclick.com <http://www.justwriteclick.com>
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 




More information about the OpenStack-docs mailing list