Misc documentation updates #6486

haircommander · 2023-01-04T19:27:31Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

more details in each commit

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

none

mrunalp · 2023-01-04T19:51:24Z

Looks great! Will let others review as well before we tag it.

haircommander · 2023-01-04T19:56:54Z

In accordance with the policy as defined, this PR has a week voting period where folks can +1/-1 it before we merge

@nalind @giuseppe @umohnani8 @saschagrunert @fidencio @kolyshkin PTAL

lbocinco · 2023-01-05T09:37:05Z

GOVERNANCE.md

+### Community Member

-### How to become a reviewer
+* Anyone can and is encouraged to be a community member! The CRI-O community eagerly accepts PRs, issues, new users and questions.


This might be a good place to add also things that you don't mention in reviewer/maintainer sections and encourage users to participate more in the community, and become contributor, like helping with improving documentation, or improving website, evangelize the project by writing blog, etc. CNCF has good examples in their template under community participant

jrvaldes

@haircommander Thanks for working on this. I added a suggestion, PTAL.

jrvaldes · 2023-01-06T19:51:40Z

GOVERNANCE.md

-CRI-O, being a project whose purpose is linked to fulfilling the needs of Kubernetes, has a governance structure that mirrors many SIGs and sub-projects of Kubernetes. This document highlights important aspects of, and serves as a summary of the [Kubernetes' community documentation](https://www.kubernetes.dev/docs).
+- [Values](#values)
+- [Contribution Tiers](#contribution-tiers)
+- [Becoming a Maintainer](#becoming-a-maintainer)


This section is no longer present in the proposed structure of the document. I suggest removing it or explicitly adding the subsections of Contribution Tiers.

jrvaldes · 2023-01-06T20:07:03Z

GOVERNANCE.md


 * If a community member would like to take on a more active role in the community, and one day become an approver, becoming a reviewer is a good first step.
 * Becoming a reviewer allows someone to build trust with the community and deepen their knowledge of the code base.
 * To become a reviewer, one should file an issue with [this template](https://github.com/cri-o/cri-o/issues/new?assignees=&labels=area%2Fgithub-membership&template=membership.yml&title=REQUEST%3A+New+membership+for+%3Cyour-GH-handle%3E).


Looks like the membership.yml template is no longer there, use the following URL to leverage the current template.

https://github.com/cri-o/cri-o/issues/new?template=reviewer.yml&title=REQUEST%3A+New+reviewer+status+for+%3Cyour-GH-handle%3E

haircommander · 2023-01-09T18:44:27Z

great catches @jrvaldes @lenicatko, thanks! I have adopted your feedback and squashed the changes

jrvaldes · 2023-01-09T19:02:27Z

LTGM

codecov · 2023-01-09T19:23:50Z

Codecov Report

Merging #6486 (437d7bb) into main (006639a) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6486   +/-   ##
=======================================
  Coverage   42.49%   42.49%           
=======================================
  Files         128      128           
  Lines       14944    14944           
=======================================
  Hits         6350     6350           
  Misses       7904     7904           
  Partials      690      690

haircommander · 2023-01-11T19:07:10Z

@nalind @giuseppe @umohnani8 @saschagrunert @fidencio @kolyshkin PTAL

TomSweeneyRedHat · 2023-01-13T20:11:37Z

GOVERNANCE.md


-## Emeritus Approver
+#### Distinction between top-level approvers and sub-tree approvers
+Through the mechanism of the OWNERS file, it’s possible to define sub-tree approvers for areas of specialty. For the purposes of this document, when “approvers” is mentioned, sub-tree approvers are not automatically included, though they could be. One way this happens is if a section of code that a sub-tree approver is responsible for has a security vulnerability, they will be included in the discussions. However, they need not necessarily be included if there is not such a vulnerability.


Suggested change

Through the mechanism of the OWNERS file, it’s possible to define sub-tree approvers for areas of specialty. For the purposes of this document, when “approvers” is mentioned, sub-tree approvers are not automatically included, though they could be. One way this happens is if a section of code that a sub-tree approver is responsible for has a security vulnerability, they will be included in the discussions. However, they need not necessarily be included if there is not such a vulnerability.

Through the mechanism of the OWNERS file, it’s possible to define sub-tree approvers for areas of specialty. One way this happens is if a section of code that a sub-tree approver is responsible for has a security vulnerability, they will be included in the discussions. However, they need not necessarily be included if there is no such vulnerability. For the purposes of this document, when “approvers” is mentioned, sub-tree approvers are not automatically included, though they could be.

and maybe: "when "approvers" is" to "when the word "approvers" is"

I have dropped the security section as upon reading again I found it clunky

TomSweeneyRedHat · 2023-01-13T20:13:23Z

GOVERNANCE.md

-* In order to maintain an active reviewers and approvers list, the CRI-O team has a right to demote an approver or reviewer if they appear inactive for one year.
+### Demotion
+
+* In order to maintain an active reviewers and approvers list, the CRI-O team has a right to demote an approver or reviewer if they appear inactive for two years.


two years seems too long. I'd go a year, maybe 6 months. YMMV

I will drop to one

TomSweeneyRedHat · 2023-01-13T20:16:06Z

GOVERNANCE.md

-* A weekly meeting is held to discuss CRI-O development. It is open to everyone.
-* It is generally run by an approver.
-* The details to join the meeting are on the [wiki](https://github.com/cri-o/cri-o/wiki/CRI-O-Weekly-Meeting).
+There is an alias on github that one can use to ping all of the CRI-O reviewers and approvers: "@cri-o/cri-o-maintainers".


Suggested change

There is an alias on github that one can use to ping all of the CRI-O reviewers and approvers: "@cri-o/cri-o-maintainers".

There is an alias on GitHub that one can use to ping all of the CRI-O reviewers and approvers: "@cri-o/cri-o-maintainers".

TomSweeneyRedHat · 2023-01-13T20:17:11Z

GOVERNANCE.md


-* This document was partially based off of [Envoy's GOVERNANCE.md](https://github.com/envoyproxy/envoy/blob/main/GOVERNANCE.md) file. Some credit goes to the maintainers of the Envoy project.
-* As mentioned above, credit is also due to the Kubernetes community documentation, which also served as a foundation.
+Thanks to the Jaeger Project, the Envoy project, the Kubernetes community documentation, and the CNCF for portions and structure of this document.


maybe add links to each of these?

haircommander · 2023-01-16T18:40:56Z

In addition to addressing @TomSweeneyRedHat 's comments, I have also added a new commit adding a new tier of contributor: org member, which is a position that currently exists but was not documented, nor was the process of becoming one defined. This was done by inspiration from a slack thread, thanks Shunli (whose github handle I don't know yet)

littlejawa · 2023-01-17T09:20:47Z

roadmap.md

+Often, though not always, CRI-O will attempt to support new features in Kubernetes while they’re in the Alpha stage, though sometimes this target is missed and support is added while the feature is in Beta.
+To track the features that may be added to CRI-O from upstream, one can watch SIG-Node’s KEPs for a given release.
+If a particular feature interests you, the CRI-O community recommends you open an issue in CRI-O so it can be included in the Milestone for that given release.
+CRI-O maintainers are involved in SIG-Node in driving various upstream initiatives that can be tracked in the SIG-Node planning document.


There are multiple references of SIG-Node, but no link to it. Maybe adding a link here (or at the first occurrence of "SIG-Node") would be nice to help track those initiatives?

I added a couple of links embellishing references I made, PTAL @littlejawa :)

openshift-ci · 2023-01-18T08:17:41Z

@littlejawa: changing LGTM is restricted to collaborators

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

haircommander · 2023-01-18T14:19:41Z

/retest

Signed-off-by: Peter Hunt~ <[email protected]>

to account for folks who are members of the cri-o organizaiton but do not yet qualify as reviewers. Signed-off-by: Peter Hunt~ <[email protected]>

saschagrunert

LGTM

openshift-ci · 2023-01-19T08:40:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: haircommander, littlejawa, saschagrunert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [haircommander,saschagrunert]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

haircommander · 2023-01-19T14:16:02Z

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

openshift-ci · 2023-01-19T14:16:13Z

@haircommander: Overrode contexts on behalf of haircommander: ci/kata-jenkins, ci/prow/ci-rhel-integration, ci/prow/e2e-gcp-ovn

Details

In response to this:

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

saschagrunert · 2023-01-20T08:06:50Z

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

openshift-ci · 2023-01-20T08:07:00Z

@saschagrunert: Overrode contexts on behalf of saschagrunert: ci/kata-jenkins, ci/prow/ci-rhel-integration, ci/prow/e2e-gcp-ovn

Details

In response to this:

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

saschagrunert · 2023-01-20T08:16:06Z

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

openshift-ci · 2023-01-20T08:16:15Z

@saschagrunert: Overrode contexts on behalf of saschagrunert: ci/kata-jenkins, ci/prow/ci-rhel-integration, ci/prow/e2e-gcp-ovn

Details

In response to this:

/override ci/prow/e2e-gcp-ovn
/override ci/prow/ci-rhel-integration
/override ci/kata-jenkins

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

saschagrunert · 2023-01-20T09:14:11Z

/override ci/prow/e2e-aws-ovn

openshift-ci · 2023-01-20T09:14:17Z

@saschagrunert: Overrode contexts on behalf of saschagrunert: ci/prow/e2e-aws-ovn

Details

In response to this:

/override ci/prow/e2e-aws-ovn

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

saschagrunert · 2023-01-20T09:40:01Z

/override ci/prow/ci-crun-e2e
/override ci/prow/ci-rhel-e2e

openshift-ci · 2023-01-20T09:40:09Z

@saschagrunert: Overrode contexts on behalf of saschagrunert: ci/prow/ci-crun-e2e, ci/prow/ci-rhel-e2e

Details

In response to this:

/override ci/prow/ci-crun-e2e
/override ci/prow/ci-rhel-e2e

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

haircommander requested a review from mrunalp as a code owner January 4, 2023 19:27

openshift-ci bot added the release-note-none Denotes a PR that doesn't merit a release note. label Jan 4, 2023

haircommander changed the title ~~Misc documentation fixes~~ Misc documentation updates Jan 4, 2023

openshift-ci bot added dco-signoff: yes Indicates the PR's author has DCO signed all their commits. kind/documentation Categorizes issue or PR as related to documentation. labels Jan 4, 2023

openshift-ci bot requested review from QiWang19 and wgahnagl January 4, 2023 19:28

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 4, 2023

lbocinco reviewed Jan 5, 2023

View reviewed changes

jrvaldes reviewed Jan 6, 2023

View reviewed changes

haircommander force-pushed the documentation-fixes branch from a1014c8 to 58aca45 Compare January 9, 2023 18:43

TomSweeneyRedHat reviewed Jan 13, 2023

View reviewed changes

haircommander force-pushed the documentation-fixes branch from 58aca45 to cb0fc3b Compare January 16, 2023 18:39

littlejawa reviewed Jan 17, 2023

View reviewed changes

haircommander force-pushed the documentation-fixes branch from cb0fc3b to 8751b8e Compare January 17, 2023 22:08

littlejawa approved these changes Jan 18, 2023

View reviewed changes

update GOVERNANCE.md file

ae97122

Signed-off-by: Peter Hunt~ <[email protected]>

haircommander added 6 commits January 18, 2023 16:25

add a public roadmap

35cce86

Signed-off-by: Peter Hunt~ <[email protected]>

README: add roadmap

700fe65

Signed-off-by: Peter Hunt~ <[email protected]>

Add MAINTAINERS.md document

dbf1ee9

Signed-off-by: Peter Hunt~ <[email protected]>

mention MAINTAINERS file in GOVERNANCE

0059f24

Signed-off-by: Peter Hunt~ <[email protected]>

CoC: replace with CNCF one

8fc1e91

Signed-off-by: Peter Hunt~ <[email protected]>

GOVERNANCE: add org member tier

437d7bb

to account for folks who are members of the cri-o organizaiton but do not yet qualify as reviewers. Signed-off-by: Peter Hunt~ <[email protected]>

haircommander force-pushed the documentation-fixes branch from 8751b8e to 437d7bb Compare January 18, 2023 21:26

saschagrunert approved these changes Jan 19, 2023

View reviewed changes

openshift-ci bot assigned saschagrunert Jan 19, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 19, 2023

openshift-merge-robot merged commit 86bda2b into cri-o:main Jan 20, 2023

littlejawa mentioned this pull request Jan 26, 2023

REQUEST: New reviewer status for littlejawa #6578

Closed

4 tasks

	There is an alias on github that one can use to ping all of the CRI-O reviewers and approvers: "@cri-o/cri-o-maintainers".
	There is an alias on GitHub that one can use to ping all of the CRI-O reviewers and approvers: "@cri-o/cri-o-maintainers".

Misc documentation updates #6486

Misc documentation updates #6486

Uh oh!

Conversation

haircommander commented Jan 4, 2023

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Uh oh!

mrunalp commented Jan 4, 2023

Uh oh!

haircommander commented Jan 4, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrvaldes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

haircommander commented Jan 9, 2023

Uh oh!

jrvaldes commented Jan 9, 2023

Uh oh!

codecov bot commented Jan 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

haircommander commented Jan 11, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

haircommander commented Jan 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jan 18, 2023

Uh oh!

haircommander commented Jan 18, 2023

Uh oh!

saschagrunert left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jan 19, 2023

Uh oh!

haircommander commented Jan 19, 2023

Uh oh!

openshift-ci bot commented Jan 19, 2023

Uh oh!

saschagrunert commented Jan 20, 2023

Uh oh!

openshift-ci bot commented Jan 20, 2023

Uh oh!

saschagrunert commented Jan 20, 2023

Uh oh!

openshift-ci bot commented Jan 20, 2023

Uh oh!

saschagrunert commented Jan 20, 2023

Uh oh!

openshift-ci bot commented Jan 20, 2023

Uh oh!

saschagrunert commented Jan 20, 2023

codecov bot commented Jan 9, 2023 •

edited

Loading