openstack
/
syntribos
Code Issues Proposed changes

Fixing some documentation nits 

Fixing some documentation nits and tweaking the example config
file.

Change-Id: I01435a4a15eb682fc7ee8369430b0c285835a308
This commit is contained in:
Rahul Nair 2016-09-08 11:47:45 -05:00
parent dfc61fe94c
commit e1644ce56d
4 changed files with 65 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.rst
View File

@ -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=<yourpassword>
# Optional, only needed if Keystone V3 API is used
#user_id=<youruserid>
# Optional, api version if required.
# Optional, api version if required
#version=v2.0
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
#[alt_user]
#
# Optional, Used for cross auth tests (-t AUTH)
#
endpoint=http://localhost:5000
#endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
[logging]
#
@ -468,7 +481,8 @@ Breaking changes, feature requests, and other non prioritized work should
first be submitted as a blueprint `here <https://blueprints.launchpad.net/syntribos>`__
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.

25
doc/source/configuration.rst
View File

@ -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=<yourpassword>
# Optional, only needed if Keystone V3 API is used
#user_id=<youruserid>
# Optional, api version if required.
# Optional, api version if required
#version=v2.0
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
#[alt_user]
#
# Optional, Used for cross auth tests (-t AUTH)
#
endpoint=http://localhost:5000
#endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
[logging]
#

8
doc/source/contributing.rst
View File

@ -1,5 +1,5 @@
Contributing Guidelines
========================
=======================
1. Follow all the `OpenStack Style Guidelines <http://docs.openstack.org/developer/hacking/>`__
(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 <https://blueprints.launchpad.net/syntribos>`__
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.

28
examples/configs/keystone.conf
View File

@ -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=<location_of_payload_dir>
endpoint=http://localhost:5000
username=<yourusername>
password=<yourpassword>
# Optional, unless keystone V3 API is used
# Optional, only needed if Keystone V3 API is used
#user_id=<youruserid>
#domain_name=<domain_name>
#domain_id=<domain_id>
# Optional, api version if required.
# Optional, api version if required
#version=v2.0
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
#[alt_user]
#
# Optional, only used for cross auth tests (-t AUTH)
# Optional, Used for cross auth tests (-t AUTH)
#
#endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
# Optional, for getting scoped tokens
#user_id=<alt_userid>
# If user id is not known
# For V3 API
#domain_name=<name_of_the_domain>
#project_name=<name_of_the_project>
# For Keystone V2 API
#tenant_name=<name_of_the_project>
[logging]
#