diff --git a/README.rst b/README.rst index 4cdcba8..c85d344 100644 --- a/README.rst +++ b/README.rst @@ -89,7 +89,7 @@ For adding new api please refer https://github.com/openstack/valence/blob/master valence-ui ---------- -valence-ui provides a Web based GUI interface that can be used to explore +valence-ui provides a Web-based GUI interface that can be used to explore Rack Scale Design (RSD) artifacts and compose/disassemble nodes. valence-ui is implemented using Node.js runtime environment and hosted through apache. valence-ui makes us of React.js javascript libaray and invoke Valence REST APIs through ajax REST calls. diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 10e7c38..33e12f8 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -165,7 +165,7 @@ node_property: type: array node_provision_state: description: | - The composed node state value set by other orchestation tool, use this value + The composed node state value set by other orchestration tool, use this value to help with orchestration software know its proviision progress. in: body required: true diff --git a/api-ref/source/valence-api-v1-nodes.inc b/api-ref/source/valence-api-v1-nodes.inc index 9f71c57..e5c2787 100644 --- a/api-ref/source/valence-api-v1-nodes.inc +++ b/api-ref/source/valence-api-v1-nodes.inc @@ -248,7 +248,7 @@ Resource attach/detach .. rest_method:: POST /v1/nodes/{node_ident}/action -Send a attach/detach cmd to a composed node. +Send an attach/detach cmd to a composed node. Normal response codes: 204 diff --git a/doc/source/developer-guide/add_new_api.rst b/doc/source/developer-guide/add_new_api.rst index 7626309..d73efc9 100644 --- a/doc/source/developer-guide/add_new_api.rst +++ b/doc/source/developer-guide/add_new_api.rst @@ -61,7 +61,7 @@ Consider we want to implement a new API /v1/example that returns "hello world" j LOG = logging.getLogger(__name__) - class Example(Resorce): + class Example(Resource): def get(self): LOG.debug("GET /example") return {“msg” : “hello world”} diff --git a/doc/source/developer-guide/add_new_unit_test.rst b/doc/source/developer-guide/add_new_unit_test.rst index 2f53e9a..f9526fa 100644 --- a/doc/source/developer-guide/add_new_unit_test.rst +++ b/doc/source/developer-guide/add_new_unit_test.rst @@ -36,9 +36,9 @@ Unit tests scripts are located in `/valence/tests/unit/ Implement a Unit Test Case ----------------------------- -Consider implementing an unit test case for our example unit module. +Consider implementing a unit test case for our example unit module. -To implement an unit test case for the example unit module, +To implement a unit test case for the example unit module, Create a class in valence/tests/unit/(directory)/test_(example).py, which inherits the TestCase class from unittest. diff --git a/doc/source/developer-guide/db_development.rst b/doc/source/developer-guide/db_development.rst index dfe2f7a..9f8ebf7 100644 --- a/doc/source/developer-guide/db_development.rst +++ b/doc/source/developer-guide/db_development.rst @@ -35,7 +35,7 @@ Add a model for db Models are defined in the valence/db/models.py file. A new model should be updated there. -To add a example model for Etcd db, we should create +To add an example model for Etcd db, we should create a class that inherits the ModelBase class in valence/db/models.py. .. NOTE:: diff --git a/valence/common/exception.py b/valence/common/exception.py index 304741e..2f586dc 100644 --- a/valence/common/exception.py +++ b/valence/common/exception.py @@ -53,7 +53,7 @@ class ValenceConfirmation(base.ObjectBase): """Valence Confirmation Message representation. Whenever confirmation response needs to send back to client - for successfull operation + for successful operation """ diff --git a/valence/flavors/flavors.py b/valence/flavors/flavors.py index dd2c683..373925d 100644 --- a/valence/flavors/flavors.py +++ b/valence/flavors/flavors.py @@ -37,9 +37,9 @@ def get_available_criteria(): def create_flavors(data): - """criteria : comma seperated generator names + """criteria : comma separated generator names - This should be same as thier file name) + This should be same as their file name) """ criteria = data["criteria"]