From e1644ce56de15ec248b669605647a67f4e7649b9 Mon Sep 17 00:00:00 2001 From: Rahul Nair Date: Thu, 8 Sep 2016 11:47:45 -0500 Subject: [PATCH] Fixing some documentation nits Fixing some documentation nits and tweaking the example config file. Change-Id: I01435a4a15eb682fc7ee8369430b0c285835a308 --- README.rst | 32 +++++++++++++++++++++++--------- doc/source/configuration.rst | 25 +++++++++++++++++++------ doc/source/contributing.rst | 8 ++++---- examples/configs/keystone.conf | 28 +++++++++++++++++++--------- 4 files changed, 65 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index 4d6f07bf..ce19f505 100644 --- a/README.rst +++ b/README.rst @@ -131,7 +131,9 @@ necessary fields like user credentials, log, template directory etc. [syntribos] + # # As keystone is being tested in the example, enter your + # # keystone auth endpoint url. endpoint=http://localhost:5000 # Set payload and templates path @@ -147,21 +149,32 @@ necessary fields like user credentials, log, template directory etc. password= # Optional, only needed if Keystone V3 API is used #user_id= - # Optional, api version if required. + # Optional, api version if required #version=v2.0 - + # Optional, for getting scoped tokens + #user_id= + # If user id is not known + # For V3 API + #domain_name= + #project_name= + # For Keystone V2 API + #tenant_name= #[alt_user] # # Optional, Used for cross auth tests (-t AUTH) # - - endpoint=http://localhost:5000 + #endpoint=http://localhost:5000 #username= #password= + # Optional, for getting scoped tokens #user_id= - - + # If user id is not known + # For V3 API + #domain_name= + #project_name= + # For Keystone V2 API + #tenant_name= [logging] # @@ -468,7 +481,8 @@ Breaking changes, feature requests, and other non prioritized work should first be submitted as a blueprint `here `__ for review. -Readme.rst is auto generated from docs by running `python readme.py` in the -`syntribos/scripts` directory. So when the README.rst needs to be updated; -modify the corresponding rst file in `syntribos/doc/source` and auto generate +Readme.rst is auto generated from docs by running ``python readme.py`` in the +``syntribos/scripts`` directory. So when the README.rst needs to be updated; +modify the corresponding rst file in ``syntribos/doc/source`` and auto generate the README. + diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index d3cee949..f1d8e5fc 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -50,7 +50,9 @@ necessary fields like user credentials, log, template directory etc. [syntribos] + # # As keystone is being tested in the example, enter your + # # keystone auth endpoint url. endpoint=http://localhost:5000 # Set payload and templates path @@ -66,21 +68,32 @@ necessary fields like user credentials, log, template directory etc. password= # Optional, only needed if Keystone V3 API is used #user_id= - # Optional, api version if required. + # Optional, api version if required #version=v2.0 - + # Optional, for getting scoped tokens + #user_id= + # If user id is not known + # For V3 API + #domain_name= + #project_name= + # For Keystone V2 API + #tenant_name= #[alt_user] # # Optional, Used for cross auth tests (-t AUTH) # - - endpoint=http://localhost:5000 + #endpoint=http://localhost:5000 #username= #password= + # Optional, for getting scoped tokens #user_id= - - + # If user id is not known + # For V3 API + #domain_name= + #project_name= + # For Keystone V2 API + #tenant_name= [logging] # diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 3c0d0c70..94f988da 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,5 +1,5 @@ Contributing Guidelines -======================== +======================= 1. Follow all the `OpenStack Style Guidelines `__ (e.g. PEP8, Py3 compatibility) @@ -21,7 +21,7 @@ Breaking changes, feature requests, and other non prioritized work should first be submitted as a blueprint `here `__ for review. -Readme.rst is auto generated from docs by running `python readme.py` in the -`syntribos/scripts` directory. So when the README.rst needs to be updated; -modify the corresponding rst file in `syntribos/doc/source` and auto generate +Readme.rst is auto generated from docs by running ``python readme.py`` in the +``syntribos/scripts`` directory. So when the README.rst needs to be updated; +modify the corresponding rst file in ``syntribos/doc/source`` and auto generate the README. diff --git a/examples/configs/keystone.conf b/examples/configs/keystone.conf index 3376ac62..7817f42c 100644 --- a/examples/configs/keystone.conf +++ b/examples/configs/keystone.conf @@ -1,8 +1,4 @@ [syntribos] -# -# End point URLs and versions of the services to be tested. -# - # As keystone is being tested in the example, enter your # keystone auth endpoint url. endpoint=http://localhost:5000 @@ -17,21 +13,35 @@ payload_dir= endpoint=http://localhost:5000 username= password= -# Optional, unless keystone V3 API is used +# Optional, only needed if Keystone V3 API is used #user_id= -#domain_name= -#domain_id= -# Optional, api version if required. +# Optional, api version if required #version=v2.0 +# Optional, for getting scoped tokens +#user_id= +# If user id is not known +# For V3 API +#domain_name= +#project_name= +# For Keystone V2 API +#tenant_name= #[alt_user] # -# Optional, only used for cross auth tests (-t AUTH) +# Optional, Used for cross auth tests (-t AUTH) # + #endpoint=http://localhost:5000 #username= #password= +# Optional, for getting scoped tokens #user_id= +# If user id is not known +# For V3 API +#domain_name= +#project_name= +# For Keystone V2 API +#tenant_name= [logging] #