diff options
| author | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2018-11-06 17:57:31 +0900 |
|---|---|---|
| committer | Takashi NATSUME <natsume.takashi@lab.ntt.co.jp> | 2018-11-07 04:01:40 +0000 |
| commit | ddf7c6e370f71741794b88297aaa43aaed9df6c4 (patch) | |
| tree | 95cce277f6d393eea8420f58d8a6460f5e2d29d0 /api-guide/source/users.rst | |
| parent | c295e395dc304b04d003641e852ae162879d382a (diff) | |
| download | nova-ddf7c6e370f71741794b88297aaa43aaed9df6c4.tar.gz | |
Improve formats of the Compute API guide
Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.
Improve some format in the guide.
e.g. Fix unnecessary bold characters.
Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459
Diffstat (limited to 'api-guide/source/users.rst')
| -rw-r--r-- | api-guide/source/users.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/api-guide/source/users.rst b/api-guide/source/users.rst index 7128a5ac66..e09cbb6d16 100644 --- a/api-guide/source/users.rst +++ b/api-guide/source/users.rst @@ -27,7 +27,7 @@ Keystone middleware is used to authenticate users and identify their roles. The Compute API uses these roles, along with oslo.policy, to decide what the user is authorized to do. -TODO - link to compute admin guide for details. +.. todo:: link to compute admin guide for details. Personas used in this guide =========================== @@ -47,11 +47,15 @@ cloud administrator permissions, such as a read-only role that is able to view a lists of servers for a specific tenant but is not able to perform any actions on any of them. -Note: this is not attempting to be an exhaustive set of personas that consider -various facets of the different users but instead aims to be a minimal set of -users such that we use a consistent terminology throughout this document. +.. note:: -TODO - could assign names to these users, or similar, to make it more "real". + This is not attempting to be an exhaustive set of personas that consider + various facets of the different users but instead aims to be a minimal set of + users such that we use a consistent terminology throughout this document. + +.. todo:: + + could assign names to these users, or similar, to make it more "real". Discovering Policy ================== @@ -59,4 +63,4 @@ Discovering Policy An API to discover what actions you are authorized to perform is still a work in progress. Currently this reported by a HTTP 403 error. -TODO - link to the doc on errors. +.. todo:: link to the doc on errors. |