From da047b3db759e0ff667b4839840340986ca18591 Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Sun, 7 Nov 2021 16:58:32 +0000 Subject: [PATCH] Add contributing page and some updates The commit adds contributing page for easier orientation in our projects. Change-Id: Iff202064e3fe1b4651f73e22ec0733f191c3ecaf --- CONTRIBUTING.rst | 34 ++++++++++++++++ HACKING.rst | 2 +- README.rst | 47 +++++++++++++++-------- doc/source/contributing.rst | 5 +++ doc/source/hacking.rst | 5 +++ doc/source/index.rst | 15 +++++++- doc/source/process/DesignatedSections.rst | 2 - doc/source/process/GovernanceProcess.rst | 14 ++++--- doc/source/process/procedure.rst | 6 +-- 9 files changed, 100 insertions(+), 30 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributing.rst create mode 100644 doc/source/hacking.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..1eda06b0 --- /dev/null +++ b/CONTRIBUTING.rst @@ -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 `_. +Use [interop] in your subject. + +**IRC:** +We're at #openstack-interop channel on OFTC network. +`Setup IRC `_ + +**Meetings:** +`Visit this link `_ +for the meeting information. diff --git a/HACKING.rst b/HACKING.rst index 89429ff2..2a0dbef6 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -7,7 +7,7 @@ Interop Working Group Commandments documents in the following recommended order: - `Core Definition `_ - - `OpenStack Interop WG Process 2016A `_ + - `OpenStack Interop WG Process 2021A `_ - Step 3: Read on diff --git a/README.rst b/README.rst index 1a5d9f75..1ea04931 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. -The /doc/source/process directory contains details about the -Interop Working Group process. +The `Process Documentation `_ +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 `_ +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 `_ +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 `_ +`Process Governance `_ +`Designated Sections `_ +`Interop WG Governance `_ +`Terminology `_ + +Tools for Interoperability Testing +================================== +`refstack client `_ +contains the tools you will need to run the Interop Working Group tests. + +`refstack server `_ is our API to collect +interoperability test results from private and public cloud vendors. +`See more `_ about the +project. + +Get Involved! +============= + +See the `CONTRIBUTING `_ +guide on how to get involved. diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 00000000..1f5ca23c --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/hacking.rst b/doc/source/hacking.rst new file mode 100644 index 00000000..067e21fb --- /dev/null +++ b/doc/source/hacking.rst @@ -0,0 +1,5 @@ +======= +Hacking +======= + +.. include:: ../../HACKING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 98f657a8..3e6b6b35 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 `_ + is a user interface to display individual test run results, it is deployed + `at this page `_. +* `refstack-client `_ + 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 diff --git a/doc/source/process/DesignatedSections.rst b/doc/source/process/DesignatedSections.rst index deb73f2f..c1416d90 100644 --- a/doc/source/process/DesignatedSections.rst +++ b/doc/source/process/DesignatedSections.rst @@ -2,8 +2,6 @@ Designated Sections =================== -.. contents:: - Designated Sections Illustration ================================ diff --git a/doc/source/process/GovernanceProcess.rst b/doc/source/process/GovernanceProcess.rst index 7b037bb8..1221f193 100644 --- a/doc/source/process/GovernanceProcess.rst +++ b/doc/source/process/GovernanceProcess.rst @@ -1,11 +1,13 @@ Governance Process ================== -* Meetings details and agendas are available on - `Interop WG wiki page - `_ page and open to community. +* Meetings details and agendas are available in + `the etherpad page `_ 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 - `_. + due to time limits. Minutes from prior meetings are available in + `the etherpad page `_. diff --git a/doc/source/process/procedure.rst b/doc/source/process/procedure.rst index ad535ed4..a554e63f 100755 --- a/doc/source/process/procedure.rst +++ b/doc/source/process/procedure.rst @@ -43,7 +43,7 @@ all required tests, please contact RefStack team at 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