Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖CAEP proposal v2: expectations and timelines #1501

Merged
merged 1 commit into from
Oct 10, 2019

Conversation

vincepri
Copy link
Member

@vincepri vincepri commented Oct 9, 2019

Signed-off-by: Vince Prignano vincepri@vmware.com

What this PR does / why we need it:
This PR iterates on the CAEP template making it more aligned with the expectations we (as a community) would like to have a fully fleshed out proposal before it becomes a PR to this repository.

In more details, this PR:

  • Cleans the template to be more direct and explicit.
  • Removes duplicated sections.
  • Adds Glossary section with a link to the Cluster API book glossary.
  • Rewrites the non-goals section as Non-Goals/Future Work, to be clear none of the points are blocking other folks' work.
  • Makes it more clear of expectations for the Proposal section, such as details about the design, implementation, and having diagrams to refer to.
  • Makes the Implementation Details section required.
  • Makes most parts of Additional Details section optional. This section was called "Design Details" in the KEP template, although doesn't really align with how Cluster API has operated so far and being in alpha.
  • Promotes the Upgrade Strategy section to be required and top level.
  • Provides a clear timeline in Implementation History.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 9, 2019
@vincepri
Copy link
Member Author

vincepri commented Oct 9, 2019

/assign @timothysc @ncdc @detiber

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 9, 2019
@vincepri
Copy link
Member Author

vincepri commented Oct 9, 2019

/assign @justinsb @justaugustus

as well, for more feedback

Copy link
Contributor

@ncdc ncdc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable, thanks!

docs/proposals/YYYYMMDD-template.md Outdated Show resolved Hide resolved
docs/proposals/YYYYMMDD-template.md Outdated Show resolved Hide resolved
docs/proposals/YYYYMMDD-template.md Outdated Show resolved Hide resolved
@vincepri vincepri force-pushed the caep-proposal-v2 branch 2 times, most recently from 8cedeee to 684b938 Compare October 9, 2019 19:05
@vincepri
Copy link
Member Author

vincepri commented Oct 9, 2019

Once we reach consensus if this gets merged, I'll make sure to reach out to folks writing proposals and CC them here

1. **Create a PR.**
1. **Merge early.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't necessarily like the idea of removing the Merge early concept, otherwise we are likely to get hung up on bikeshedding before getting proposals in.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the timeline below, I expressed that proposals ideas should be communicated in an issue or community meeting for initial feedback. Originally, the merge early was to get just motivation and goals in place, which so far hasn't been enough to get consensus.

docs/proposals/YYYYMMDD-template.md Show resolved Hide resolved
docs/proposals/YYYYMMDD-template.md Show resolved Hide resolved
docs/proposals/YYYYMMDD-template.md Show resolved Hide resolved
This is where we get down to the nitty gritty of what the proposal actually is.

### User Stories [optional]
- What is the plan for implementing this feature?
- What data model changes, additions or removals are required?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't data model changes be listed under implementation details?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked at the bootstrap proposal, and those are part of the Proposal

- What data model changes, additions or removals are required?
- How does it impact user experience?
- Provide a scenario, or example.
- Use diagrams to communicate concepts, flows of execution, and states.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems more in line with implementation details than the high level proposal description.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

docs/proposals/YYYYMMDD-template.md Outdated Show resolved Hide resolved
[conformance tests]: https://github.com/kubernetes/community/blob/master/contributors/devel/conformance-tests.md

### Upgrade / Downgrade Strategy
### Upgrade / Downgrade Strategy [optional]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should likely keep this as required going forward.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do this in another PR? I would like to think together through the items listed under there and make it more explicit what we'd expect users to write up here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps just add upgrade strategy. Downgrade is fraught with peril.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm, anything else we should add to the notes?

Signed-off-by: Vince Prignano <vincepri@vmware.com>
Copy link
Member

@timothysc timothysc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

PSA @fabriziopandini - FYI on slight format update.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 10, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: timothysc, vincepri

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:

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 k8s-ci-robot merged commit 0b70358 into kubernetes-sigs:master Oct 10, 2019
@vincepri
Copy link
Member Author

/cc @detiber @chuckha @amy @noamran @michaelgugino @juan-lee @CecileRobertMichon @justaugustus @randomvariable @rudoi @dennisme @liztio @frapposelli

for updating the in-flight proposals with the new format and expectations

@k8s-ci-robot
Copy link
Contributor

@vincepri: GitHub didn't allow me to request PR reviews from the following users: dennisme, noamran.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @detiber @chuckha @amy @noamran @michaelgugino @juan-lee @CecileRobertMichon @justaugustus @randomvariable @rudoi @dennisme @liztio @frapposelli

for updating the in-flight proposals with the new format and expectations

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.

Copy link
Member

@frapposelli frapposelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants