openstack
/
openstacksdk
Code Issues Proposed changes

Add proxy API reference to baremetal user guide 

Today was my first day with the openstacksdk docs, and it took me a
while to find the baremetal proxy API reference [1] after banging my head
against the examples in the user guide [2].

This commit adds a link to [1] at the top of [2] and makes clear that
the latter is just an exemplary subset of what can be done.

[1] https://docs.openstack.org/openstacksdk/latest/user/proxies/baremetal.html
[2] https://docs.openstack.org/openstacksdk/latest/user/guides/baremetal.html

Change-Id: If3e62da2f037b44cb057856e6566d68ef16ded8e
This commit is contained in:
Eric Fried 2019-03-15 16:51:50 -05:00
parent aa5080650b
commit 16f2dbe3b0
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/user/guides/baremetal.rst
View File

@ -11,6 +11,9 @@ below.
The primary resource of the Bare Metal service is the **node**.
Below are a few usage examples. For a reference to all the available methods,
see :doc:`/user/proxies/baremetal`.
CRUD operations
~~~~~~~~~~~~~~~