From a8c7858863a9da39b32a4382a993e6423e508146 Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Wed, 23 Aug 2017 14:39:30 -0700 Subject: [PATCH] Add a CLI section to the Octavia docs Change-Id: I4a134771f2428439cfb6e1b697a6b8c1b16b220a --- doc/source/cli/index.rst | 10 ++++++++++ doc/source/index.rst | 1 + doc/source/reference/index.rst | 1 + doc/source/user/index.rst | 1 + 4 files changed, 13 insertions(+) create mode 100644 doc/source/cli/index.rst diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 0000000000..55a9e7432e --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,10 @@ +============================== +Octavia Command Line Interface +============================== + +Octavia has an OpenStack Client plugin available as the native Command Line +Interface (CLI). + +Please see the `python-octaviaclient documentation +`_ for documentation +on installing and using the CLI. diff --git a/doc/source/index.rst b/doc/source/index.rst index 5277dd02ad..745e238f04 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,6 +17,7 @@ is grouped into the following topic areas. admin/index.rst Octavia API Reference + cli/index.rst configuration/index.rst contributor/index.rst install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 978922f564..4fc759f49f 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -7,6 +7,7 @@ Octavia Reference :maxdepth: 1 * + Command Line Interface Reference Indices and Search ------------------ diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index c6b1d11613..a1980bca91 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -6,6 +6,7 @@ Octavia User :glob: :maxdepth: 1 + Command Line Interface Reference guides/* Indices and Search