diff --git a/.zuul.yaml b/.zuul.yaml index 178fcab9..e80bbc85 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -22,10 +22,17 @@ - release-notes-jobs check: jobs: - - python-mistralclient-devstack-dsvm + - python-mistralclient-devstack-dsvm: + irrelevant-files: &doc-irrelevant-files + - ^.*\.rst$ + - ^.*\.yaml$ - openstack-tox-cover: voting: false + irrelevant-files: *doc-irrelevant-files + - openstackclient-check-plugins: + irrelevant-files: *doc-irrelevant-files gate: jobs: - - python-mistralclient-devstack-dsvm + - python-mistralclient-devstack-dsvm: + irrelevant-files: *doc-irrelevant-files diff --git a/README.rst b/README.rst index b6744610..abb4f8db 100644 --- a/README.rst +++ b/README.rst @@ -37,16 +37,16 @@ Command Line Interface (CLI) library. Installation ------------ -First of all, clone the repo and go to the repo directory: +First of all, clone the repo and go to the repo directory:: $ git clone https://git.openstack.org/openstack/python-mistralclient.git $ cd python-mistralclient -Then just run: +Then just run:: $ pip install -e . -or +or:: $ pip install -r requirements.txt $ python setup.py install @@ -56,7 +56,7 @@ Running Mistral client ---------------------- If Mistral authentication is enabled, provide the information about OpenStack -auth to environment variables. Type: +auth to environment variables. Type:: $ export OS_AUTH_URL=http://:5000/v2.0 $ export OS_USERNAME=admin @@ -65,18 +65,18 @@ auth to environment variables. Type: $ export OS_MISTRAL_URL=http://:8989/v2 (optional, by default URL=http://localhost:8989/v2) -and in the case that you are authenticating against keystone over https: +and in the case that you are authenticating against keystone over https:: $ export OS_CACERT= .. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But server supports only v3.* -To make sure Mistral client works, type: +To make sure Mistral client works, type:: $ mistral workbook-list -You can see the list of available commands typing: +You can see the list of available commands typing:: $ mistral --help