Add documentation outlining the workflow process for opening a SIG-NET-PEP or NPEP #119

npinaeva · 2023-06-23T14:46:39Z

Add "Enhancement Proposals" page explaining how to create NPEPs.
Add Meeting details to the "Community, discussion, contribution, and support" section, since this section is now linked from the enhancements page for existing ways to connect.
Add npep folder and template.
Most of the content is based on Gateway API src <3.

Closes #95

netlify · 2023-06-23T14:46:43Z

✅ Deploy Preview for kubernetes-sigs-network-policy-api ready!

Name	Link
🔨 Latest commit	`18433de`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-network-policy-api/deploys/649bf0930943bf000789e0e0
😎 Deploy Preview	https://deploy-preview-119--kubernetes-sigs-network-policy-api.netlify.app/enhancements
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

k8s-ci-robot · 2023-06-23T14:46:47Z

Welcome @npinaeva!

It looks like this is your first PR to kubernetes-sigs/network-policy-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/network-policy-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-06-23T14:46:48Z

Hi @npinaeva. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

Add some issue templates to which is being completed as part of #119

astoycos · 2023-06-23T17:33:11Z

/ok-to-test

astoycos · 2023-06-23T17:34:31Z

@npinaeva When this merges let's get you into the ORG :) https://github.com/kubernetes/org

astoycos

Some nits and questions but otherwise this looks really good @npinaeva

astoycos · 2023-06-27T18:04:51Z

site-src/enhancements.md

+
+### 3. Create a first PR for your NPEP
+NPEP process is supposed to be iterative, adding more details with every iteration.
+To start this process, create a PR adding `npep-<issue number>.md` file in [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)


Suggested change

To start this process, create a PR adding `npep-<issue number>.md` file in [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)

To start this process, create a PR adding `npep-<issue number>.md` file in the [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)

astoycos · 2023-06-27T18:05:04Z

site-src/enhancements.md

+### 3. Create a first PR for your NPEP
+NPEP process is supposed to be iterative, adding more details with every iteration.
+To start this process, create a PR adding `npep-<issue number>.md` file in [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)
+using [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md). Further we describe a number of 


Suggested change

using [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md). Further we describe a number of

using the [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md) as a starting point. Further we describe a number of

astoycos · 2023-06-27T18:07:56Z

site-src/enhancements.md

+using [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md). Further we describe a number of 
+suggested iterations for an NPEP to make sure every version has a specific goal and limited scope.
+
+### 4. Agree on the Goals


So each of these steps will in theory be in a single PR, should we have some sort of PR naming convention i.e GoalDevelopment-NPEP93 or something like that?

That is what Statuses are used for in GEP, I have added 3 statuses for every stage, and Status field to NPEP to signal on which stage every NPEP is

astoycos · 2023-06-27T18:09:05Z

site-src/enhancements.md

+* Bug fixes
+* Small changes (API validation, documentation, fixups). It is always
+  possible that the reviewers will determine a "small" change ends up
+  requiring a GEP.


Suggested change

requiring a GEP.

requiring a NPEP.

astoycos · 2023-06-27T18:09:38Z

site-src/enhancements.md

+alternatives. Be sure to document all of these in the NPEP, and why we decided
+against them.
+
+### 6. Make API changes


Should we note here that this step shouldn't alter the NPEP itself?

good point! now with the statuses, status change will be required, but it is usually also useful to add links about how this NPEP was implemented, I added this to the description

* Add some issue templates Add some issue templates to which is being completed as part of #119 * Add enhancement label

Add Meeting details to the "Community, discussion, contribution, and support" section, since this section is now linked from the enhancements page for existing ways to connect. Add npep folder and template. Most of the content is based on Gateway API src <3. Signed-off-by: Nadia Pinaeva <npinaeva@redhat.com>

astoycos · 2023-06-28T14:27:09Z

/lgtm
/approve

Thanks @npinaeva!

k8s-ci-robot · 2023-06-28T14:27:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: astoycos, npinaeva

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [astoycos]

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

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 23, 2023

k8s-ci-robot requested review from astoycos and Dyanngg June 23, 2023 14:46

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 23, 2023

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 23, 2023

astoycos mentioned this pull request Jun 23, 2023

Add some issue templates #120

Merged

astoycos added a commit that referenced this pull request Jun 23, 2023

Add some issue templates

cec8772

Add some issue templates to which is being completed as part of #119

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 23, 2023

astoycos reviewed Jun 27, 2023

View reviewed changes

astoycos added a commit that referenced this pull request Jun 27, 2023

Add some issue templates (#120)

5ee80a1

* Add some issue templates Add some issue templates to which is being completed as part of #119 * Add enhancement label

npinaeva force-pushed the npep-docs branch from de30533 to 18433de Compare June 28, 2023 08:34

k8s-ci-robot assigned astoycos Jun 28, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 28, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 28, 2023

k8s-ci-robot merged commit fdf177d into kubernetes-sigs:master Jun 28, 2023

npinaeva deleted the npep-docs branch June 29, 2023 15:04

npinaeva mentioned this pull request Jul 12, 2023

REQUEST: New membership for npinaeva kubernetes/org#4325

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation outlining the workflow process for opening a SIG-NET-PEP or NPEP #119

Add documentation outlining the workflow process for opening a SIG-NET-PEP or NPEP #119

npinaeva commented Jun 23, 2023 •

edited

Loading

netlify bot commented Jun 23, 2023 •

edited

Loading

k8s-ci-robot commented Jun 23, 2023

k8s-ci-robot commented Jun 23, 2023

astoycos commented Jun 23, 2023

astoycos commented Jun 23, 2023

astoycos left a comment

astoycos Jun 27, 2023

astoycos Jun 27, 2023

astoycos Jun 27, 2023

npinaeva Jun 28, 2023

astoycos Jun 27, 2023

astoycos Jun 27, 2023

npinaeva Jun 28, 2023

astoycos commented Jun 28, 2023

k8s-ci-robot commented Jun 28, 2023

	To start this process, create a PR adding `npep-<issue number>.md` file in [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)
	To start this process, create a PR adding `npep-<issue number>.md` file in the [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)

	using [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md). Further we describe a number of
	using the [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md) as a starting point. Further we describe a number of

Add documentation outlining the workflow process for opening a SIG-NET-PEP or NPEP #119

Add documentation outlining the workflow process for opening a SIG-NET-PEP or NPEP #119

Conversation

npinaeva commented Jun 23, 2023 • edited Loading

netlify bot commented Jun 23, 2023 • edited Loading

✅ Deploy Preview for kubernetes-sigs-network-policy-api ready!

k8s-ci-robot commented Jun 23, 2023

k8s-ci-robot commented Jun 23, 2023

astoycos commented Jun 23, 2023

astoycos commented Jun 23, 2023

astoycos left a comment

Choose a reason for hiding this comment

astoycos Jun 27, 2023

Choose a reason for hiding this comment

astoycos Jun 27, 2023

Choose a reason for hiding this comment

astoycos Jun 27, 2023

Choose a reason for hiding this comment

npinaeva Jun 28, 2023

Choose a reason for hiding this comment

astoycos Jun 27, 2023

Choose a reason for hiding this comment

astoycos Jun 27, 2023

Choose a reason for hiding this comment

npinaeva Jun 28, 2023

Choose a reason for hiding this comment

astoycos commented Jun 28, 2023

k8s-ci-robot commented Jun 28, 2023

npinaeva commented Jun 23, 2023 •

edited

Loading

netlify bot commented Jun 23, 2023 •

edited

Loading