Add contributing page and some updates
The commit adds contributing page for easier orientation in our projects. Change-Id: Ida438dd72ffd004e858f21065f8c65fde4d7a23a
This commit is contained in:
Martin Kopec
parent
bb0e985734
commit
8daea3e908
34
CONTRIBUTING.rst
Normal file
34
CONTRIBUTING.rst
Normal file
@ -0,0 +1,34 @@
|
||||
The source repository for this project can be found at:
|
||||
|
||||
https://opendev.org/openinfra/refstack
|
||||
|
||||
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||
to set up and use Gerrit:
|
||||
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
Documentation of the project can be found at:
|
||||
|
||||
https://docs.opendev.org/openinfra/refstack/latest/
|
||||
|
||||
Bugs should be filed on Storyboard:
|
||||
|
||||
https://storyboard.openstack.org/#!/project/openinfra/refstack
|
||||
|
||||
Patches against this project can be found at:
|
||||
|
||||
https://review.opendev.org/q/project:openinfra/refstack
|
||||
|
||||
To communicate with us you may use one of the following means:
|
||||
|
||||
**Mailing List:**
|
||||
Get in touch with us via `email <mailto:openstack-discuss@lists.openstack.org>`_.
|
||||
Use [refstack] in your subject.
|
||||
|
||||
**IRC:**
|
||||
We're at #refstack channel on OFTC network.
|
||||
`Setup IRC <https://docs.openstack.org/contributors/common/irc.html>`_
|
||||
|
||||
**Meetings:**
|
||||
`Visit this link <https://meetings.opendev.org/#Interop_Working_Group_Meeting>`_
|
||||
for the meeting information.
|
||||
18
README.rst
18
README.rst
@ -10,9 +10,6 @@ What is RefStack?
|
||||
Community Test results for OpenStack.
|
||||
- User interface to display individual test run results.
|
||||
|
||||
Overview
|
||||
########
|
||||
|
||||
RefStack intends on being THE source of tools for interoperability testing
|
||||
of OpenStack clouds.
|
||||
|
||||
@ -21,6 +18,9 @@ refstack-client, that helps to verify interoperability of their cloud
|
||||
with other OpenStack clouds. It does so by validating any cloud
|
||||
implementation against the OpenStack Tempest API tests.
|
||||
|
||||
Refstack's Use Case
|
||||
###################
|
||||
|
||||
**RefStack and Interop Working Group** - The prototypical use case for RefStack
|
||||
provides the Interop Working Group - formerly known as DefCore committee - the
|
||||
tools for vendors and other users to run API tests against their clouds to
|
||||
@ -46,6 +46,8 @@ into the distro or cloud.
|
||||
* documentation: https://docs.opendev.org/openinfra/refstack/latest/
|
||||
* repository: https://opendev.org/openinfra/refstack
|
||||
* reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack
|
||||
* bugs: https://storyboard.openstack.org/#!/project/openinfra/refstack
|
||||
* Web-site: https://refstack.openstack.org
|
||||
|
||||
* **refstack-client**
|
||||
refstack-client contains the tools you will need to run the
|
||||
@ -54,12 +56,10 @@ into the distro or cloud.
|
||||
* documentation: https://docs.opendev.org/openinfra/refstack-client/latest/
|
||||
* repository: https://opendev.org/openinfra/refstack-client
|
||||
* reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack-client
|
||||
* bugs: https://storyboard.openstack.org/#!/project/openinfra/refstack-client
|
||||
|
||||
Get involved!
|
||||
Get Involved!
|
||||
#############
|
||||
|
||||
* Mailing List: openstack-discuss@lists.openstack.org
|
||||
* IRC: #refstack on OFTC
|
||||
* Wiki: https://wiki.openstack.org/wiki/Governance/InteropWG
|
||||
* Meetings: See the wiki page for meeting info
|
||||
* Web-site: https://refstack.openstack.org
|
||||
See the `CONTRIBUTING <https://docs.opendev.org/openinfra/refstack/latest/contributing.html>`_
|
||||
guide on how to get involved.
|
||||
|
||||
@ -1,65 +0,0 @@
|
||||
========
|
||||
RefStack
|
||||
========
|
||||
|
||||
What is RefStack?
|
||||
#################
|
||||
|
||||
- Toolset for testing interoperability between OpenStack clouds.
|
||||
- Database backed website supporting collection and publication of
|
||||
Community Test results for OpenStack.
|
||||
- User interface to display individual test run results.
|
||||
|
||||
Overview
|
||||
########
|
||||
|
||||
RefStack intends on being THE source of tools for interoperability testing
|
||||
of OpenStack clouds.
|
||||
|
||||
RefStack provides users in the OpenStack community with a Tempest wrapper,
|
||||
refstack-client, that helps to verify interoperability of their cloud
|
||||
with other OpenStack clouds. It does so by validating any cloud
|
||||
implementation against the OpenStack Tempest API tests.
|
||||
|
||||
**RefStack and Interop Working Group** - The prototypical use case for RefStack
|
||||
provides the Interop Working Group - formerly known as DefCore committee - the
|
||||
tools for vendors and other users to run API tests against their clouds to
|
||||
provide the WG with a reliable overview of what APIs and capabilities are
|
||||
being used in the marketplace. This will help to guide the Interop
|
||||
Working Group defined capabilities and help ensure interoperability across
|
||||
the entire OpenStack ecosystem. It can also be used to validate clouds
|
||||
against existing capability lists, giving you assurance that your cloud
|
||||
faithfully implements OpenStack standards.
|
||||
|
||||
**Value add for openstack distro or solution vendors** - Vendors can use
|
||||
RefStack to demonstrate that their distros, and/or their customers' installed
|
||||
clouds remain OpenStack compliant after their software has been incorporated
|
||||
into the distro or cloud.
|
||||
|
||||
**RefStack consists of two parts:**
|
||||
|
||||
* **refstack-api**
|
||||
Our API isn't just for us to collect data from private and public cloud
|
||||
vendors. It can be used by vendors in house to compare interoperability
|
||||
data over time.
|
||||
|
||||
* documentation: https://docs.opendev.org/openinfra/refstack/latest/
|
||||
* repository: https://opendev.org/openinfra/refstack
|
||||
* reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack
|
||||
|
||||
* **refstack-client**
|
||||
refstack-client contains the tools you will need to run the
|
||||
Interop Working Group tests.
|
||||
|
||||
* documentation: https://docs.opendev.org/openinfra/refstack-client/latest/
|
||||
* repository: https://opendev.org/openinfra/refstack-client
|
||||
* reviews: https://review.opendev.org/#/q/status:open+project:openinfra/refstack-client
|
||||
|
||||
Get involved!
|
||||
#############
|
||||
|
||||
* Mailing List: openstack-discuss@lists.openstack.org
|
||||
* IRC: #refstack on OFTC
|
||||
* Wiki: https://wiki.openstack.org/wiki/Governance/InteropWG
|
||||
* Meetings: See the wiki page for meeting info
|
||||
* Web-site: https://refstack.openstack.org
|
||||
5
doc/source/contributing.rst
Normal file
5
doc/source/contributing.rst
Normal file
@ -0,0 +1,5 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
@ -7,14 +7,13 @@
|
||||
Welcome to RefStack's documentation!
|
||||
====================================
|
||||
|
||||
.. include:: README.rst
|
||||
|
||||
|
||||
Content:
|
||||
--------
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview
|
||||
contributing
|
||||
refstack
|
||||
run_in_docker/index
|
||||
vendor_product_management/index
|
||||
|
||||
2
doc/source/overview.rst
Normal file
2
doc/source/overview.rst
Normal file
@ -0,0 +1,2 @@
|
||||
.. include:: ../../README.rst
|
||||
|
||||
Loading…
Reference in New Issue
Block a user