diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index aa973351..a6523e5d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,35 @@ -If you would like to contribute to the development of OpenStack, you must -follow the steps in this page: +Contributor Guidelines +====================== - https://docs.openstack.org/infra/manual/developers.html +The source repository for this project can be found at: -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow -section of this documentation to learn how changes to OpenStack should be -submitted for review via the Gerrit tool: + https://opendev.org/openstack/manila-tempest-plugin - https://docs.openstack.org/infra/manual/developers.html#development-workflow +Pull requests submitted through GitHub are not monitored. -Pull requests submitted through GitHub will be ignored. +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -Bugs should be filed on Launchpad, not GitHub: + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html - https://bugs.launchpad.net/manila-tempest-plugin +Bugs should be filed against the Manila project on Launchpad: + + https://bugs.launchpad.net/manila + +For more specific information about contributing to this repository, see the +manila contributor guide. That guide has information regarding the team's task +trackers, communicating with other project developers and contacting the +core team. It also has plenty of tips and tricks to get started with a +development environment to contribute to, and test changes within this +tempest plugin repository: + + https://docs.openstack.org/manila/latest/contributor/contributing.html + +Information regarding running tests from this repository is here: + + https://docs.openstack.org/manila/latest/contributor/tempest_tests.html + +This project makes extensive use of tempest-lib, a stable interface to the +Tempest project. You can read more about it here: + + https://docs.openstack.org/tempest/latest/library.html diff --git a/HACKING.rst b/HACKING.rst index cd3c49c8..da529fb2 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,4 +1,6 @@ -openstack Style Commandments -=============================================== +OpenStack Style Commandments +============================ -Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ +Read the OpenStack Style Commandments here: + + https://docs.openstack.org/hacking/latest/ diff --git a/README.rst b/README.rst index de0ec321..cf2f7fba 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,10 @@ manila-tempest-plugin ===================== -Tempest plugin manila-tempest-plugin +This repository contains a `Tempest`_ `test plugin`_ to verify the +functionality of the `OpenStack Shared File System Service`_, Manila. -Tempest plugin to test Manila's features +See `contributor information`_ to learn more. * Free software: Apache license * Documentation: https://docs.openstack.org/manila/latest/ @@ -12,7 +13,7 @@ Tempest plugin to test Manila's features * Source: https://opendev.org/openstack/manila-tempest-plugin * Bugs: https://bugs.launchpad.net/manila -Features --------- - -* TODO +.. _Tempest: https://docs.openstack.org/tempest +.. _test plugin: https://docs.openstack.org/tempest/latest/plugin.html +.. _contributor information: CONTRIBUTING.rst +.. _OpenStack Shared File System Service: https://docs.openstack.org/manila \ No newline at end of file diff --git a/manila_tempest_tests/README.rst b/manila_tempest_tests/README.rst deleted file mode 100644 index 7569d961..00000000 --- a/manila_tempest_tests/README.rst +++ /dev/null @@ -1,6 +0,0 @@ -==================== -Tempest Integration -==================== - -This directory contains Tempest tests to cover Manila project. -