Skip to content
New issue

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

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

Already on GitHub? # to your account

Add initial enhancement templates #2

Merged
merged 1 commit into from
Aug 29, 2019

Conversation

derekwaynecarr
Copy link
Member

@derekwaynecarr derekwaynecarr commented Aug 23, 2019

Add initial enhancement template and repo content.

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 23, 2019

## Is My Thing an Enhancement?

A rough heuristic for an enhancement is anything that:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that anything with upgrade/downgrade impacts deserves an enhancement.

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, will update.

README.md Outdated
If you are not sure if the proposed work requires an enhancement, file an issue
and ask!

## When to Create a New Enhancement Issue
Copy link
Contributor

Choose a reason for hiding this comment

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

issue or PR?

README.md Outdated
Create an issue here once you:

- have circulated your idea to see if there is interest
- through Community Meetings, SIG meetings, or mailing lists
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have community meetings or sig meetings.

Copy link
Member Author

Choose a reason for hiding this comment

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

some groups do, but I am going to omit this for the moment, and we can have a place on how to reach out across mailing lists, slack, etc.

README.md Outdated
- have circulated your idea to see if there is interest
- through Community Meetings, SIG meetings, or mailing lists
- (optionally) have done a prototype in your own fork
- have identified people who agree to work on the enhancement
Copy link
Contributor

Choose a reason for hiding this comment

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

work on and maintain


## Quick start

1. Socialize an idea with others. Make sure others thing the work is worth
Copy link
Contributor

Choose a reason for hiding this comment

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

s/thing/think


### Do I put de# a particular directory?

If it has broad impact, place it in the root of this directory. If its
Copy link
Contributor

Choose a reason for hiding this comment

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

it's

- "/enhancements/our-past-effort.md"
---

# Title
Copy link
Contributor

Choose a reason for hiding this comment

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

this one can be title cased, right?

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 don't understand this comment.

@@ -0,0 +1,223 @@
---
title: Enhancement Template
Copy link
Contributor

Choose a reason for hiding this comment

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

and this is the dash delimited one.

logical description for the deployment, and how it handles the unique aspects
of the platform. Aim for single topic PRs to keep discussions focused. If you
disagree with what is already in a document, open a new PR with suggested
changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Only merge pieces of the doc that we agree with. Not attempts that you do not agree with. Otherwise these get really confusing to read.


### Version Skew Strategy

If applicable, how will the component handle version skew with other components?
Copy link
Contributor

Choose a reason for hiding this comment

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

We will always have skew. During an upgrade, two versions will be present with no guaranteed order.

@jeremyeder
Copy link
Contributor

Want to submit an enhancement in the next sprint or 2. Just checking to see when this will be finalized and merged.

@derekwaynecarr
Copy link
Member Author

You can submit an enhancement at any time. I would like to merge and iterate on this.

@derekwaynecarr
Copy link
Member Author

@deads2k i made majority of updates noted, would like to merge and iterate on this after.

@deads2k deads2k merged commit 3d72a4f into openshift:master Aug 29, 2019
openshift-merge-robot pushed a commit that referenced this pull request Oct 24, 2019
wking added a commit to wking/openshift-enhancements that referenced this pull request Nov 14, 2019
The broken link is from 881dbb7 (Add initial enhancement templates,
2019-08-23, openshift#2), with a sloppy copy from [1].  I'm fixing with a
verbatim copy from the KEP template (and dropping template-only stuff
from the user-workload-monitoring enhancement).  This is a bit of a
semantic change from what we had previously.  The OpenShift
vs. Kubernetes maturity levels are not clear to me.  OpenShift does
have docs on GA and later [2], and we do have docs on using Technology
Preview features [3], but I have not turned up docs for what
Technology preview means in terms of maturity/support.

But even if there is a Kubernetes / OpenShift maturity distinction,
OpenShift is going to expose Kubernetes features before they go
stable.  And we use v1beta1 and whatnot for OpenShift configs.  So I
don't think we can drop the Kubernetes maturity references altogether,
although we can add OpenShift maturity references in addition (once we
find out what to reference).

[1]: https://github.com/kubernetes/enhancements/blame/f1a799d5f4658ed29797c1fb9ceb7a4d0f538e93/keps/YYYYMMDD-kep-template.md#L216-L221
[2]: https://access.redhat.com/support/policy/updates/openshift/
[3]: https://docs.openshift.com/container-platform/4.2/nodes/clusters/nodes-cluster-enabling-features.html#nodes-cluster-features-about_nodes-cluster-enabling
#### Examples

These are generalized examples to consider, in addition to the aforementioned
[maturity levels][maturity-levels].
Copy link
Member

Choose a reason for hiding this comment

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

I've taken a stab at fixing this broken link in #114.

wking added a commit to wking/openshift-enhancements that referenced this pull request Nov 15, 2019
The bracketed openshift/docs is from 881dbb7 (Add initial
enhancement templates, 2019-08-23, openshift#2).  But a link makes it easy for
folks to see where changes should go, and is something that can be
updated by enhancements to link specific PRs as they check off this
box.
marun added a commit to marun/enhancements that referenced this pull request Jan 14, 2020
marun added a commit to marun/enhancements that referenced this pull request Feb 4, 2020
pedjak pushed a commit to pedjak/openshift-enhancements that referenced this pull request Mar 30, 2020
wking added a commit to wking/openshift-enhancements that referenced this pull request Aug 13, 2020
The broken link is from 881dbb7 (Add initial enhancement templates,
2019-08-23, openshift#2), with a sloppy copy from [1].  I'm fixing with a
verbatim copy from the KEP template (and dropping template-only stuff
from the user-workload-monitoring enhancement).  This is a bit of a
semantic change from what we had previously.  The OpenShift
vs. Kubernetes maturity levels are not clear to me.  OpenShift does
have docs on GA and later [2], and we do have docs on using Technology
Preview features [3], but I have not turned up docs for what
Technology preview means in terms of maturity/support.

But even if there is a Kubernetes / OpenShift maturity distinction,
OpenShift is going to expose Kubernetes features before they go
stable.  And we use v1beta1 and whatnot for OpenShift configs.  So I
don't think we can drop the Kubernetes maturity references altogether,
although we can add OpenShift maturity references in addition (once we
find out what to reference).

I also went through existing enhancements and removed useless copies
of the template boilerplate, to make it more clear that those
particular enhancements did not have anything to say about graduation
criteria.

[1]: https://github.com/kubernetes/enhancements/blame/f1a799d5f4658ed29797c1fb9ceb7a4d0f538e93/keps/YYYYMMDD-kep-template.md#L216-L221
[2]: https://access.redhat.com/support/policy/updates/openshift/
[3]: https://docs.openshift.com/container-platform/4.2/nodes/clusters/nodes-cluster-enabling-features.html#nodes-cluster-features-about_nodes-cluster-enabling
wking added a commit to wking/openshift-enhancements that referenced this pull request Aug 13, 2020
The broken link is from 881dbb7 (Add initial enhancement templates,
2019-08-23, openshift#2), with a sloppy copy from [1].  I'm fixing with a
verbatim copy from the KEP template (and dropping template-only stuff
from the user-workload-monitoring enhancement).  This is a bit of a
semantic change from what we had previously.  The OpenShift
vs. Kubernetes maturity levels are not clear to me.  OpenShift does
have docs on GA and later [2], and we do have docs on using Technology
Preview features [3], but I have not turned up docs for what
Technology preview means in terms of maturity/support.

But even if there is a Kubernetes / OpenShift maturity distinction,
OpenShift is going to expose Kubernetes features before they go
stable.  And we use v1beta1 and whatnot for OpenShift configs.  So I
don't think we can drop the Kubernetes maturity references altogether,
although we can add OpenShift maturity references in addition (once we
find out what to reference).

I also went through existing enhancements and removed useless copies
of the template boilerplate, to make it more clear that those
particular enhancements did not have anything to say about graduation
criteria.

[1]: https://github.com/kubernetes/enhancements/blame/f1a799d5f4658ed29797c1fb9ceb7a4d0f538e93/keps/YYYYMMDD-kep-template.md#L216-L221
[2]: https://access.redhat.com/support/policy/updates/openshift/
[3]: https://docs.openshift.com/container-platform/4.2/nodes/clusters/nodes-cluster-enabling-features.html#nodes-cluster-features-about_nodes-cluster-enabling
JoelSpeed pushed a commit to JoelSpeed/enhancements that referenced this pull request Oct 15, 2020
eranco74 referenced this pull request in eranco74/enhancements Oct 29, 2020
Single node should run OLM and MCO
stlaz added a commit to stlaz/enhancements that referenced this pull request Oct 30, 2020
marun added a commit to marun/enhancements that referenced this pull request Jul 16, 2021
jotak referenced this pull request in jotak/openshift-enhancements Oct 14, 2021
cgwalters pushed a commit to cgwalters/enhancements that referenced this pull request Oct 19, 2021
…lel-meta.md

cosa/20200805-meta-merge: design for merged meta.json
stevekuznetsov pushed a commit to stevekuznetsov/enhancements that referenced this pull request Apr 3, 2023
Enhancement proposal for the API evolution of APIExport in relation t…
OlivierCazade pushed a commit to OlivierCazade/openshift-enhancements that referenced this pull request Nov 17, 2023
@beekhof beekhof mentioned this pull request Oct 12, 2024
jaypoulz pushed a commit to jaypoulz/enhancements that referenced this pull request Dec 3, 2024
OCPEDGE-1344: Updated details of installation and unanswered questions.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
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.

5 participants