From c326ae041734dc309ef914138b614cdfae34bb4a Mon Sep 17 00:00:00 2001 From: Samriddhi Jain Date: Fri, 4 Aug 2017 04:11:23 +0530 Subject: [PATCH] Fill in content in CLI Documentation Added keystone-manage documentation from man pages to the placeholder created for CLI Documentation. Change-Id: I0e259c76d96c6479a6165c535bc49c032b2f41da --- doc/source/{man => cli}/commands.rst | 2 -- doc/source/cli/index.rst | 4 +--- doc/source/{man => cli}/keystone-manage.rst | 3 +-- doc/source/conf.py | 2 +- doc/source/configuration.rst | 10 ---------- doc/source/index.rst | 1 - doc/source/man/index.rst | 7 ------- 7 files changed, 3 insertions(+), 26 deletions(-) rename doc/source/{man => cli}/commands.rst (99%) rename doc/source/{man => cli}/keystone-manage.rst (99%) delete mode 100644 doc/source/man/index.rst diff --git a/doc/source/man/commands.rst b/doc/source/cli/commands.rst similarity index 99% rename from doc/source/man/commands.rst rename to doc/source/cli/commands.rst index fcb50465e5..b44f646dc7 100644 --- a/doc/source/man/commands.rst +++ b/doc/source/cli/commands.rst @@ -1,5 +1,3 @@ -:orphan: - General keystone-manage options: -------------------------------- diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index d23c86337a..714b67703a 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -18,6 +18,4 @@ CLI Documentation ================= -This section will eventually consist of documentation migrated from other -guides. This is a placeholder until content best suited for this guide is -migrated. +.. include:: keystone-manage.rst diff --git a/doc/source/man/keystone-manage.rst b/doc/source/cli/keystone-manage.rst similarity index 99% rename from doc/source/man/keystone-manage.rst rename to doc/source/cli/keystone-manage.rst index 93100d892e..0afbe2261d 100644 --- a/doc/source/man/keystone-manage.rst +++ b/doc/source/cli/keystone-manage.rst @@ -1,6 +1,5 @@ -=============== keystone-manage -=============== +~~~~~~~~~~~~~~~ --------------------------- Keystone Management Utility diff --git a/doc/source/conf.py b/doc/source/conf.py index 8036067c8e..33d1e3d756 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -127,7 +127,7 @@ modindex_common_prefix = ['keystone.'] # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' man_pages = [ - ('man/keystone-manage', 'keystone-manage', u'Keystone Management Utility', + ('cli/keystone-manage', 'keystone-manage', u'Keystone Management Utility', [u'OpenStack'], 1) ] diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 3b514c64d8..4043e715d3 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -865,16 +865,6 @@ return an empty list from your new database): values, or deployed keystone to a different endpoint, you will need to change the provided command accordingly. -``keystone-manage`` -=================== - -``keystone-manage`` is the command line tool which interacts with the Keystone -service to initialize and update data within Keystone. Generally, -``keystone-manage`` is only used for operations that cannot be accomplished -with the HTTP API, such data import/export and database migrations. - -.. include:: man/commands.rst - Supported clients ================= diff --git a/doc/source/index.rst b/doc/source/index.rst index 3076a779f0..43f32011de 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -61,7 +61,6 @@ please see the subsequent sections. :maxdepth: 2 getting-started/index.rst - man/index.rst code_documentation.rst indices-tables.rst diff --git a/doc/source/man/index.rst b/doc/source/man/index.rst deleted file mode 100644 index cba79b7013..0000000000 --- a/doc/source/man/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Man Pages -========= - -.. toctree:: - :maxdepth: 1 - - keystone-manage \ No newline at end of file