Open Stack

On Tue, May 24, 2016 at 8:37 AM, Brian Curtin <brian.curtin at rackspace.com>
wrote:

> OpenStackClient would be for command-line guides, but OpenStack SDK could
> be used for ​code examples. I'm not really sure what documentation OSC
> has out there, but SDK has a start on per-service guides so we're pretty
> good there.
>
>
> In general: I don't work on OpenStackClient so I can't answer for them.
>
>
> Augh, so sorry. Totally mistyped openstackclient when I meant
openstacksdk. Sorry about that. Thanks for the quick response.

So, if your per-service guides are good, then maybe it's better to delete
these examples than to add to content technical debt. Does anyone have
opinions here? On the user-committee list we're also talking about
redesigning the landing page, perhaps we'll get some discussion on how to
enable more SDK examples.

Thanks,

Anne


> ------------------------------
> *From:* Anne Gentle <annegentle at justwriteclick.com>
> *Sent:* Tuesday, May 24, 2016 09:07
> *To:* openstack-docs at lists.openstack.org; Everett Toews; Brian Curtin
> *Subject:* [user-guide] Python SDK examples
>
> 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, 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
> --
> Anne Gentle
> www.justwriteclick.com
>



-- 
Anne Gentle
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160524/7331a0d7/attachment.html>