Commit Graph

96 Commits

Author SHA1 Message Date
Roman Popelka a3aa76698f Fix pep8 job issues
It appears that some rules in jsonschema and flake8
are now more strict. This patch propose fixes, so
that pep8 job passes.

Change-Id: I0a7c533dd0c576e564749e5d83242fb1b050f74f
2023-04-27 12:37:44 +02:00
Zuul 57378220d1 Merge "Release 2022.11 guidelines" 2022-11-03 11:35:59 +00:00
Zuul 4238fb8851 Merge "Document 2022.06 guidelines" 2022-11-03 09:23:44 +00:00
Martin Kopec 9935fadf67 Release 2022.11 guidelines
Steps 8 to 9 of our Internal Process Documentation [1].
The commit also edits the Internal Process Documentation to describe
the needed steps in order to make a release.

[1] https://docs.opendev.org/openinfra/interop/latest/process/InternalProcessDoc.html#release-process-starting-1-month-before-ptg

Change-Id: If01ceff7b74fc4b5df0aa68ef8b14249deb79851
2022-10-22 17:28:59 +02:00
Lukáš Piwowarski 75de33251e Migrate to demjson3
It looks like the demjson package is no longer maintained [1][2]. The
last version was released in 2015.

This patch migrates to demjson3 which is a fork of the demjson library
compatible with python3.

[1] https://github.com/dmeranda/demjson/issues/40
[2] https://pypi.org/project/demjson/

Change-Id: Ibb176d942d401662ab6e565313e81b84238d1d76
2022-10-20 13:40:56 +02:00
Martin Kopec 79f8d631eb Document 2022.06 guidelines
We forgot to document the latest guidelines and include them in our
project's documentation. This patch fixes that plus it modifies
the tools/jsonToRst.py so that it takes into account the 2 new programs,
added in the 2022.06 guidelines as next ones.
In order to avoid this mistake in the future, the Internal Process
Documentation is extended about the steps required to document a guideline.

Change-Id: I0447adb2685a0766f7935e47816cee57a50e6d77
2022-10-11 16:23:02 +02:00
Martin Kopec f0e9133040 Add Internal Process Documentation
The commit adds a doc pointing out the internal actions needed
in order to make a release. It's based on the 2021A process, however,
it focuses more on the internal actions (within the IWG group).
This should help us not to forget anything when proposing a new
guideline plus it will help new contributors to get oriented quickly.

Change-Id: I89f5d3f20e95472573baba540dea9374441c4ad5
2022-06-05 11:39:29 +02:00
Martin Kopec 856349fe1e Convert 2021.11 guidelines to .rst
The patch converts the 2021.11 guidelines to a .rst file so that
it can be included in the documentation.

The patch also fixes a few links pointing to the old interop
namespace (osf/) - seems like we accidentally reverted some of the
changes.
Apart from that the patch unifies target_approval format for
shared_file_system add-on so that it matches the format of other
add-ons.

The patch then copies all 2021.11 files to their "next" versions so
that we can build a new guideline on the top of the previous one.

Change-Id: I1dea3743ca6bf657313299177aabe69ddf234784
2021-12-09 20:38:19 +00:00
Martin Kopec da047b3db7 Add contributing page and some updates
The commit adds contributing page for easier orientation
in our projects.

Change-Id: Iff202064e3fe1b4651f73e22ec0733f191c3ecaf
2021-11-15 14:30:45 +00:00
Martin Kopec 6413ec8e86 Publish docs to docs.opendev.org
docs.opendev.org will provide easier access to the doc pages
in comparison to the Gitea (opening the doc files in the repo).

Change-Id: Iecc6d745f1a35e701ff86060169c489556cac9c3
2021-10-20 06:51:24 +00:00
Martin Kopec 6cb143addd Prettify .rst docs
Fixing a few links as the original ones were returning 404.
The commit fixes .rst syntax issues to make the pages
render "nicer". The commit changes only format of the .rst
code, the content of the pages is not changed at all.

Change-Id: Icf0da2d7d1b42b065639c9105fbc16e1999bf630
2021-10-20 06:47:54 +00:00
Martin Kopec 791c95309e Add documented guidelines
Document latest guidelines / convert them from .json to .rst
so that they can be included in the documentation.
The patch converts all guidelines since 2018 when this convert
happend for the last time.
The patch also enables pep8 job on doc changes as there is a .rst
check implemented within tox' pep8 env.

Change-Id: I8a65dfb15c5572bedf1bbf36bfa2143df47010bb
2021-10-20 06:41:15 +00:00
Martin Kopec 4b0c80a4ef Edit interop repo links and source in guidelines
interop repository has been moved from openstack/ namespace
to osf/ one and now it's moved to openinfra/ by [1].
This commit fixes the links pointing to interop repository
so that they point to the current source.

We also reorganized the guidelines recently by [2] and moved
them to a specific directory. This commit fixes the links
within the guidelines so that they point to the current
guideline location.

[1] https://review.opendev.org/c/openstack/project-config/+/808479
[2] https://review.opendev.org/c/osf/interop/+/796413

Depends-On: https://review.opendev.org/c/openinfra/ansible-role-refstack-client/+/814383
Change-Id: I3193252181758bde9da6c4c69f927055b64f902d
2021-10-18 09:29:26 +00:00
Zuul ed52675b8c Merge "Update process to reflect that human-readable format of the guidelines is optional but encouraged." 2021-07-09 13:52:48 +00:00
Arkady Kanevsky 0e3a1c3149 Update process to reflect that human-readable format of the guidelines
is optional but encouraged.

Change-Id: I0953b2975ad358a098def003b46dcc0d584ff82c
2021-07-06 10:41:58 -05:00
Arkady Kanevsky 25604eeba5 Created an Archive directory in Process one.
Moved 3 obsolite files that are no longer referenced by Interop governence
wiki https://wiki.openstack.org/wiki/Governance/InteropWG into it.

Change-Id: Ieaa2b4c1222cdd4682e72b64eb1210505b5a0e7d
2021-07-03 22:44:32 -05:00
Arkady Kanevsky c4b58a776e 2021A process approved by the OIF board
Change-Id: Ic62f0dd8403e49aeb2b93d5121153e8d7dfc1173
2021-07-02 09:29:52 -05:00
Zuul 407352c872 Merge "Make procedure.rst from 2016.08 more generic" 2021-06-21 22:08:15 +00:00
Zuul 4a026f275b Merge "Removed requirement that one of WG co-chairs is nominated and elected by the OIF Board." 2021-06-21 16:44:48 +00:00
Martin Kopec 1c53d9f357 Make procedure.rst from 2016.08 more generic
The patch moves procedure.rst defined in 2016.08 directory to
the doc/source/process location to make it clear that it applies
on all guidelines since 2017.01 to present.

Change-Id: Ia1bcd508cbbf734248e29eeb8de48b50f0eb3ef0
2021-06-21 12:10:50 +00:00
Zuul 33ca7669a2 Merge "Major update of Interop WG process rules." 2021-06-18 19:01:55 +00:00
Arkady Kanevsky 7c16d452dd Removed requirement that one of WG co-chairs is nominated and elected by the OIF Board.
1. There is no legal document in OpenStack that requires that. It was done intially to have a better rapport between the OpenStack board and Interop WG.
2. The Board member was useful to ramp up interop WG and get participation from vendors. We are at the different time in OpenStack maturity now.
3. The Board changed from OpenStack to Open Infrastructure with many non-openstack projects. So to have a board member on each OpenInfra project is not scalable.
4. Board trusts that 4 entities that are on Approval Committee adequetly represent Board view, since TC and Foundation staff for Marketplace are present.

Change-Id: I9a045de3e1b93c471aebff8757a8bae9674c7c6f
2021-06-18 13:24:57 -05:00
ArkadyKanevsky 9e13d77e3b Fixed a few typos.
Change-Id: Ie3e5d5949e27b116f905e3b98b88fa597604bc18
2021-06-04 12:44:05 -05:00
ArkadyKanevsky 73f5222876 Major update of Interop WG process rules.
Created new named TrademarkProgram.rst.
Kept old doc CoreDefintion.rst that is replaced by
TrademarkProgram.rst.
Core Defintion is no longer defined by TC.
Removed old reference to Havana and Grizzly release.
Updated meeting info.
Add coverage for Add-on programs.
Added coverage to drivers and vendor plugins, cleaned up language
for laternative implementation.
Added that board delegated its approval of guidelines
to the Approval Committee.
Any process changes need to get approved by the Board.

Change-Id: Ie439e1c8ff015621bf8936994173c095f0d08970
2021-06-04 12:31:37 -05:00
ArkadyKanevsky 33160b11c8 Created new process 2021A to replace 2017A one
https://opendev.org/osf/interop/src/branch/master/doc/source/process/2017A.rst
Transition guidelines approval process from tha OIF board to
committee consisting of Interop WG, Refstack, TC and Foundation
Marketplace manager.
Add-on programs are formally included.
Updated index file.

Change-Id: Ic55f40dd5f61eefed12f458593f39bc883c41bd9
2021-05-31 20:30:31 -05:00
Zuul 388bba60ff Merge "Removing duplicate clouse and cleaning meeting info." 2021-04-16 17:43:13 +00:00
ArkadyKanevsky 070927cc45 Removing duplicate clouse and cleaning meeting info.
This commit fixes the meeting information and provide correct link
to meeting wiki page. Also removes duplicate clouse.

Change-Id: I52d4c49194f7e4bec2406f03dbf1fd4e9c724683
2021-04-16 09:24:27 -05:00
Zuul 3a23f5f6bd Merge "Fix the sentence in GovernanceProcess.rst" 2021-04-14 19:31:52 +00:00
zhouxinyong 7f16f01f61 Fix the sentence in GovernanceProcess.rst
Change-Id: Ie48b9462b9402ed4999a39b3cab7b7c1a2fd0cff
2021-03-31 14:26:30 +00:00
Noor Muhammad Malik 0f4c804f88 Fixing typos in the documentation
While reading some of the documentation in the Interop Github repo
I found a few typos in the docs and thought I'd fix them upstream.

Change-Id: If7ff117e6634c1ceac19591d2b78844bd398681d
2020-06-17 19:10:21 +05:00
Artem Goncharov 6a5adfc915 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I16040e384b553ffb7d19dcda2363f3f07ce7855e
2019-05-08 12:20:31 +00:00
Artem Goncharov 469f9fbebd Fix pep8 and docs build problems
- fix few pep8 complains
- integrated upper-constraints
- uncapped Sphinx to use upper-constraints cap
- removed deprecated oslosphinx

Change-Id: I1abffe16975e5e2c9ca1059dd866d605b9485bf9
2019-05-08 14:10:39 +02:00
Mark T. Voelker a4c22aaded Fix docs gate jobs
Due to [1] we need to make some updates to our tox setup.

[1]
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I476781d57a999a0c6e40b6dca4115fff0432a5c9
2018-03-21 12:29:26 -04:00
Mark T. Voelker d70af95229 Approve 2018.02, supersede 2017.01
The Board of Directors will meet on Feb. 26, 2018 at the PTG
in Dublin to vote on the 2018.02 Guideline proposal.  The Board
report can be found at:

https://docs.google.com/document/d/1kgmdHTb0ve340sdwO8-8-vKTaCqFSNtGxSBvSwofeJE/edit#heading=h.yjel5gfxgg3h

This patchset should be merged if and when the Board approves the
new Guideline.  It marks 2018.02 as approved and 2017.01 as
superseded.

Change-Id: I93291e54bc56e41977a2b19ed30b733013a0c837
2018-03-03 10:36:19 +00:00
gaofei 7cd8ab1456 Fix spell errors in document
Fix spell errors in document
Trivial fix.

Change-Id: I028f7440fdc255dcf1edce2bd7d962e71673cac0
2018-02-07 16:33:53 +08:00
Mark T. Voelker 02698b5411 Fix "superceded" typo in schema
Clouds are hard.  English, doubly so.  We have a longstanding
spelling error in the schema: "superceded" should be spelled
"superseded".  This patch corrects it and updates all the documents
the typo was propagated to over time.

Change-Id: I72f24bf026919f4ccce0ce0c42e1c33c4042aca4
2017-09-12 09:38:36 -06:00
Chris Hoge 88c94ca7e0 2017.09 Interop Guideline Approved by Board of Directors
Co-authored-by: Chris Hoge <chris@openstack.org>
Co-authored-by: Mark T. Voelker <mvoelker@vmware.com>

Change-Id: I6582124284c66f032649ea7f580f8c7040cd1415
2017-09-10 21:20:39 -06:00
Chris Hoge b3d697fe21 Changed extensions to add-ons
Change-Id: Ieb0769ec0b78cd8c9edee9ef2de3685301a0f80b
2017-09-06 10:03:35 -07:00
Mark T. Voelker 48283e9da5 Change 2017.08 -> 2017.09
The Board of Directors deferred it's August 2017 meeting until
September, so the Guideline we intended to ask approval for in August
will now not be voted on until September.  Guidelines are named by
the year and month of their approval, so this patch updates references
to "2017.08" to "2017.09".

Change-Id: If7e19ea4524b7c944d503cbda73052ef0b0f55d0
2017-08-17 14:00:57 -04:00
Chris Hoge 32d10c8a57 Interop WG 2.0 Guideline Schema
Version 2.0 of the Guideline Schema used by the Inteop WG.
Includes the 2.0 schema, documentation, and an update of the
current next.json schema to the proposed 2.0 standard.

Open questions:
  * make required_since optional?
  * make idempotent_id optional?
  * change date of approval to match more generic dates?
  * components structured correctly? redundancy with designated sections?
  * splitting platforms and extensions up into different fields for better
    granularity?

Change-Id: I552408d1426ee9f7f5f350f2f7333f8e33884db4
2017-07-25 16:36:00 -05:00
Mark T. Voelker e60481879b Create 2017.08 Guideline
Create the 2017.08 Guideline candidate, to be moved from review to
approved status if and when approved by the OpenStack Foundation
Board of Directors.  A vote is expected at the August 22, 2017
Board meeting.

Note: this patch also adds back test information for two Capabilities
that were deprecated (and keeps them marked as not required).  The
tests associated with these were inadvertently removed in
Iabb1d0820300442e407d8b92dfb575ac71471d06 but should instead have
simply had their "required-since" status nullified, as removing
them entirely breaks the jsonToRst.py script and leaves users
unable to easily find the tests that are no longer required due to
the deprecation.

Change-Id: Ifce3fe1e3401e7f887ddeae2a41078dca7e16625
2017-06-22 16:29:56 -07:00
loooosy 7e6500f85e Fix html_last_updated_fmt for Python3
Html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.

[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081

Change-Id: Ib7d6c25a22b70bd6210821a0784a1918049cc6d1
2017-06-19 11:28:45 +08:00
Chris Hoge bbe043c549 Fixed malformed 1.6.json schema
The 1.6.json schema included an error where an additionalProperties
tag was erroniously attached to a properties object, rather than
an object definition. A recent update to jsonschema improved
checking and flagged this previously uncaught error. This patch
fixes the malformed schema, and does not materially change the
content or intent of the original file.

Change-Id: I42c35b65aa622a2ea7205a728e8431b4f0e6daf6
Closes-Bug: #1664113
2017-02-13 09:19:21 -08:00
Jenkins 1075103536 Merge "Adding back removed capabilities to the report" 2017-01-25 15:55:50 +00:00
Egle Sigler 0957a4e5cf Adding back removed capabilities to the report
Adding missing capabilities to the report to match
the  2017.01.json guideline

Change-Id: I9abf4a785296e3d4185c9203e63088cedb9c0e87
2017-01-24 11:56:05 -06:00
Mark T. Voelker c3e9b6b4b2 Approve 2017.01, superceding 2016.01
This patch should be approved only if and when the OpenStack
Foundation Board of Directors votes to approve the proposed 2017.01
Guideline.  It does the following:

1.) Marks 2017.01 as "approved."

2.) Marks 2016.01 as "superceded."

3.) Adjusts the "replaces" target of next.json and it's target
    approval date to reflect work begining on the next Guideline.
    Note that the Board of Directors meeting list for 2017[1]
    hasn't yet been set, so the date listed here is approximate.

[1]
https://wiki.openstack.org/wiki/Governance/Foundation#OpenStack_Board_of_Director_Meetings

Change-Id: I566e52fdc82af57a5bf24bfd3db5d10a26887127
2017-01-23 23:45:06 -05:00
Mark T. Voelker d8fb682a2b Change doc references to DefCore
At the Board of Directors meeting on April 24, 2016 the Board of
Directors indicated that as DefCore has evolved it's focus on
interoperability and it's working structure, it's name may be a source
of some confusion to those outside of the community or who are new to
the community.  The Board made an informal request that the DefCore
Committee consider changing it's name to more clearly reflect it's focus
and structure.

This patch is the first step in that process.  It updates references
in various documents to change the name "DefCore Committee" to
"Interop Working Group" as agreed at the summer 2016 DefCore Committee
Sprint [1].

It should be noted that this patch should be considered a work in
progress to generate discussion until the new name is approved by
the DefCore Committee and the Board of Directors.  Should we elect
to go forward with the new name, some other actions will also need
to be taken, including but not limited to:

1. We will need to consider updating references on the OpenStack wiki.
2. We will need to consider updating the name of our IRC channel,
   mailing list, Launchpad project, and git repository.  Most of these
   changes will need to be carefully coordinated with the OpenStack
   Infrastructure team.
3. We will need to take into account external resources that point to
   DefCore artifacts, such as Foundation-maintained websites (such as:
   http://www.openstack.org/interop ).
4. We will need to coordinate with RefStack to minimize impact.
5. We will need to clearly communicate the name change to the rest of the
   community.

Note also that I've intentionally left many historical documents that
have been superceded (such as the 2015A process docs, Guidelines that
are no longer used, etc) in tact.  There seemed little value in
spending time on them and cluttering the patch with them since they're
now obsolete.

[1] https://etherpad.openstack.org/p/DefCoreSummer2016Sprint

Change-Id: I79d337c193e75c54d49f1d847468f6347e2ef2b3
2017-01-23 21:25:05 -05:00
Jenkins 80ff657d01 Merge "Create 2017.01 Guideline" 2017-01-23 20:21:13 +00:00
Mark T. Voelker 7114857581 Fix schema discrepency
The RST version of the schema allows for a state called "review".
However the JSON version has a state called "advisory" instead of
"review".  We're gating using the JSON and consider it authoritative,
so this patch corrects the RST to have states that match the JSON.

Change-Id: Iacff32594d07acfca9c25d65e22bec84e69bf5d8
2017-01-20 16:13:44 -05:00
Mark T. Voelker b797bacc61 Create 2017.01 Guideline
Create the 2017.01 Guideline candidate, to be merged if and when
approved by the OpenStack Foundation Board of Directors.  A vote
is expected at the January 24, 2017 Board meeting.

Change-Id: I8bd75de0967395cc1cfb9b247c3f442f9e08bab2
2017-01-20 16:12:36 -05:00