From d4f8f47ad5e1fa9d83188652e483111df151b838 Mon Sep 17 00:00:00 2001 From: Martin Necas Date: Tue, 15 Oct 2024 19:22:38 +0200 Subject: [PATCH] Add enhancements template.md for the design docs For the upcoming larger changes inside the forklift either the design changes or larger enhancements we will require the document describing the current situation and why to implement the changes. Signed-off-by: Martin Necas --- docs/enhancements/template.md | 175 ++++++++++++++++++++++++++++++++++ 1 file changed, 175 insertions(+) create mode 100644 docs/enhancements/template.md diff --git a/docs/enhancements/template.md b/docs/enhancements/template.md new file mode 100644 index 000000000..12a606c45 --- /dev/null +++ b/docs/enhancements/template.md @@ -0,0 +1,175 @@ +--- +title: neat-enhancement-idea +authors: + - "@janedoe" +reviewers: + - TBD + - "@alicedoe" +approvers: + - TBD + - "@oscardoe" +creation-date: yyyy-mm-dd +last-updated: yyyy-mm-dd +status: provisional|implementable|implemented|deferred|rejected|withdrawn|replaced +see-also: + - "/enhancements/this-other-neat-thing.md" +replaces: + - "/enhancements/that-less-than-great-idea.md" +superseded-by: + - "/enhancements/our-past-effort.md" +--- + +# Neat Enhancement Idea + +This is the title of the enhancement. Keep it simple and descriptive. A good +title can help communicate what the enhancement is and should be considered as +part of any review. + +The YAML `title` should be lowercased and spaces/punctuation should be +replaced with `-`. + +To get started with this template: +1. **Pick a domain.** Find the appropriate domain to discuss your enhancement. +1. **Make a copy of this template.** Copy this template into the directory for + the domain. +1. **Fill out the "overview" sections.** This includes the Summary and + Motivation sections. These should be easy and explain why the community + should desire this enhancement. +1. **Create a PR.** Assign it to folks with expertise in that domain to help + sponsor the process. +1. **Merge at each milestone.** Merge when the design is able to transition to a + new status (provisional, implementable, implemented, etc.). View anything + marked as `provisional` as an idea worth exploring in the future, but not + accepted as ready to execute. Anything marked as `implementable` should + clearly communicate how an enhancement is coded up and delivered. If an + enhancement describes a new deployment topology or platform, include a + 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. + +The `Metadata` section above is intended to support the creation of tooling +around the enhancement process. + +## Release Signoff Checklist + +- [ ] Enhancement is `implementable` +- [ ] Design details are appropriately documented from clear requirements +- [ ] Test plan is defined +- [ ] User-facing documentation is created + +## Open Questions [optional] + +This is where to call out areas of the design that require closure before deciding +to implement the design. For instance, + > 1. This requires exposing previously private resources which contain sensitive + information. Can we do this? + +## Summary + +The `Summary` section is incredibly important for producing high quality +user-focused documentation such as release notes or a development roadmap. It +should be possible to collect this information before implementation begins in +order to avoid requiring implementors to split their attention between writing +release notes and implementing the feature itself. + +A good summary is probably at least a paragraph in length. + +## Motivation + +This section is for explicitly listing the motivation, goals and non-goals of +this proposal. Describe why the change is important and the benefits to users. + +### Goals + +List the specific goals of the proposal. How will we know that this has succeeded? + +### Non-Goals + +What is out of scope for this proposal? Listing non-goals helps to focus discussion +and make progress. + +## Proposal + +This is where we get down to the nitty gritty of what the proposal actually is. + +### User Stories [optional] + +Detail the things that people will be able to do if this is implemented. +Include as much detail as possible so that people can understand the "how" of +the system. The goal here is to make this feel real for users without getting +bogged down. + +#### Story 1 + +#### Story 2 + +### Implementation Details/Notes/Constraints [optional] + +What are the caveats to the implementation? What are some important details that +didn't come across above. Go in to as much detail as necessary here. This might +be a good place to talk about core concepts and how they relate. + +### Security, Risks, and Mitigations + +**Carefully think through the security implications for this change** + +What are the risks of this proposal and how do we mitigate. Think broadly. How +will this impact the broader OKD ecosystem? Does this work in a managed services +environment that has many tenants? + +How will security be reviewed and by whom? How will UX be reviewed and by whom? + +Consider including folks that also work outside your immediate sub-project. + +## Design Details + +### Test Plan + +**Note:** *Section not required until targeted at a release.* + +Consider the following in developing a test plan for this enhancement: +- Will there be e2e and integration tests, in addition to unit tests? +- How will it be tested in isolation vs with other components? + +No need to outline all of the test cases, just the general strategy. Anything +that would count as tricky in the implementation and anything particularly +challenging to test should be called out. + +All code is expected to have adequate tests (eventually with coverage +expectations). + +### Upgrade / Downgrade Strategy + +If applicable, how will the component be upgraded and downgraded? Make sure this +is in the test plan. + +Consider the following in developing an upgrade/downgrade strategy for this +enhancement: +- What changes (in invocations, configurations, API use, etc.) is an existing + cluster required to make on upgrade in order to... + - keep previous behavior? + - make use of the enhancement? + +## Implementation History + +Major milestones in the life cycle of a proposal should be tracked in `Implementation +History`. + +## Drawbacks + +The idea is to find the best form of an argument why this enhancement should _not_ be implemented. + +## Alternatives + +Similar to the `Drawbacks` section the `Alternatives` section is used to +highlight and record other possible approaches to delivering the value proposed +by an enhancement. + +## Infrastructure Needed [optional] + +Use this section if you need things from the project. Examples include a new +subproject, repos requested, github details, and/or testing infrastructure. + +Listing these here allows the community to get the process for these resources +started right away.