Add contributing page and some updates

The commit adds contributing page for easier orientation
in our projects.

Change-Id: Iff202064e3fe1b4651f73e22ec0733f191c3ecaf
This commit is contained in:
Martin Kopec 2021-11-07 16:58:32 +00:00
parent 6413ec8e86
commit da047b3db7
9 changed files with 100 additions and 30 deletions

34
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,34 @@
The source repository for this project can be found at:
https://opendev.org/openinfra/interop
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/interop/latest/
Bugs should be filed on Storyboard:
https://storyboard.openstack.org/#!/project/openinfra/interop
Patches against this project can be found at:
https://review.opendev.org/q/project:openinfra/interop
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 [interop] in your subject.
**IRC:**
We're at #openstack-interop 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.

View File

@ -7,7 +7,7 @@ Interop Working Group Commandments
documents in the following recommended order:
- `Core Definition <doc/source/process/CoreDefinition.rst>`_
- `OpenStack Interop WG Process 2016A <doc/source/process/2016A.rst>`_
- `OpenStack Interop WG Process 2021A <doc/source/process/2021A.rst>`_
- Step 3: Read on

View File

@ -1,6 +1,6 @@
=================================================
=============================================
Understanding the Interoperability Guidelines
=================================================
=============================================
This repository contains files managed by the Interop Working
Group that provide guidance for the OpenStack community.
@ -16,20 +16,35 @@ Are you a vendor who wants to get a license to use the OpenStack trademark
and logo? Consult `OpenStack Interop
<https://www.openstack.org/brand/interop/>`_.
The /doc/source/process directory contains details about the
Interop Working Group process.
The `Process Documentation <https://docs.opendev.org/openinfra/interop/latest/process/index.html>`_
page contains details about theInterop Working Group process.
The /doc/source/schema directory contains details about the JSON schema
versions used to express Guidelines.
The `Schema Documentation <https://docs.opendev.org/openinfra/interop/latest/schema/index.html>`_
page contains details about the JSON schema versions used to express Guidelines.
The /doc/source/guidelines directory contains RST versions of the
Interop Guidelines approved by the OpenStack Board of Directors.
The `Guideline Documentation <https://docs.opendev.org/openinfra/interop/latest/guidelines/index.html>`_
page contains RST versions of the Interop Guidelines approved by the OpenStack
Board of Directors.
:Core Definition: doc/source/process/CoreDefinition.rst
:Process Goverance: doc/source/process/2021A.rst (please check for latest)
:Designated Sections: doc/source/process/DesignatedSections.rst
:Core Criteria: doc/source/process/CoreCriteria.rst
:Interop WG Governance: doc/source/process/GovernanceProcess.rst
:Platform and Components: doc/source/process/PlatformCap.rst
:Interop WG Cycles: doc/source/process/ProcessCycles.rst
:Terminology: doc/source/process/Lexicon.rst
**Another Useful Resources**
`Core Definition <https://docs.opendev.org/openinfra/interop/latest/process/CoreDefinition.html>`_
`Process Governance <https://docs.opendev.org/openinfra/interop/latest/process/2021A.html>`_
`Designated Sections <https://docs.opendev.org/openinfra/interop/latest/process/DesignatedSections.html>`_
`Interop WG Governance <https://docs.opendev.org/openinfra/interop/latest/process/GovernanceProcess.html>`_
`Terminology <https://docs.opendev.org/openinfra/interop/latest/process/Lexicon.html>`_
Tools for Interoperability Testing
==================================
`refstack client <https://docs.opendev.org/openinfra/refstack-client/latest/>`_
contains the tools you will need to run the Interop Working Group tests.
`refstack server <https://refstack.openstack.org>`_ is our API to collect
interoperability test results from private and public cloud vendors.
`See more <https://docs.opendev.org/openinfra/refstack/latest/>`_ about the
project.
Get Involved!
=============
See the `CONTRIBUTING <https://docs.opendev.org/openinfra/interop/latest/contributing.html>`_
guide on how to get involved.

View File

@ -0,0 +1,5 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

5
doc/source/hacking.rst Normal file
View File

@ -0,0 +1,5 @@
=======
Hacking
=======
.. include:: ../../HACKING.rst

View File

@ -1,5 +1,3 @@
.. OpenStack Defcore documentation master file
Interop Working Group Documentation
===================================
@ -19,6 +17,17 @@ interoperability by creating the minimum standards for products labeled
Our mission is to define "OpenStack Core" that is supported by all
implementations as chartered by the by-laws.
Tools for Interoperability Testing
----------------------------------
* `refstack <https://docs.opendev.org/openinfra/refstack/latest/>`_
is a user interface to display individual test run results, it is deployed
`at this page <https://refstack.openstack.org/#/>`_.
* `refstack-client <https://docs.opendev.org/openinfra/refstack-client/latest/>`_
is a command line utility that allows user to execute Tempest test runs based
on the specified configuration. When finished running Tempest, it can send
the test results to the RefStack server.
Content:
--------
@ -28,3 +37,5 @@ Content:
process/index
schema/index
guidelines/index
contributing
hacking

View File

@ -2,8 +2,6 @@
Designated Sections
===================
.. contents::
Designated Sections Illustration
================================

View File

@ -1,11 +1,13 @@
Governance Process
==================
* Meetings details and agendas are available on
`Interop WG wiki page
<https://wiki.openstack.org/wiki/Governance/InteropWG>`_ page and open to community.
* Meetings details and agendas are available in
`the etherpad page <https://etherpad.opendev.org/p/interop>`_ and are open
to the community.
* Meeting info is available at:
https://meetings.opendev.org/#Interop_Working_Group_Meeting
* Members are expected to do their homework. We will not be rehashing
due to time limits. Minutes from prior meetings will be posted to the
`Interop WG wiki page
<https://wiki.openstack.org/wiki/Governance/InteropWG>`_.
due to time limits. Minutes from prior meetings are available in
`the etherpad page <https://etherpad.opendev.org/p/interop>`_.

View File

@ -43,7 +43,7 @@ all required tests, please contact RefStack team at
<openstack-discuss@lists.openstack.org> for assistance or consider filing a
request to have the tests flagged.
Please refer to `HACKING <../HACKING.rst>`_ for information on valid
Please refer to `HACKING <../hacking.rst>`_ for information on valid
reasons to flag a test and how to file a flag request. Results from
modified tests cannot be accepted as valid for trademark licensing
purposes.
@ -51,8 +51,8 @@ purposes.
Recommended Test Procedure
##########################
Follow steps mentioned in the refstack-client's README.rst:
https://opendev.org/openinfra/refstack-client
Follow steps mentioned in the refstack-client's documentation:
https://docs.opendev.org/openinfra/refstack-client/latest/readme.html
* Follow 'Environment setup' section to clone and install refstack-client