Project: OpenEBS (Runtime / Cloud Native Storage)
File: oep-template.md

oep-number: CSI 0000/CSTOR 0010/JIVA 1010/OPERATOR 0001/LOCALPV 1011 title: My First OEP authors: "@amitkumardas" owners: "@kmova" "@vishnuitta" editor: TBD creation-date: yyyy-mm-dd last-updated: yyyy-mm-dd status: provisional/implementable/implemented/deferred/rejected/withdrawn/replaced see-also: OEP 1 OEP 2 replaces: OEP 3 superseded-by: OEP 100 This is the title of the OpenEBS Enhancement Proposal (OEP). Keep it simple and descriptive. A good title can help communicate what the OEP is and should be considered as part of any review. The title should be lowercased and spaces/punctuation should be replaced with `-`. To get started with this template: Make a copy of this template. Name it `YYYYMMDD-my-title.md`. Fill out the "overview" sections. This includes the Summary and Motivation sections. Create a PR. Name it `[OEP NUMBER] Title`, e.g. `[OEP 0001] Initial design on OpenEBS CSI`. Assign it to owner(s) that are sponsoring this process. Merge early. Avoid getting hung up on specific details and instead aim to get the goal of the OEP merged quickly. The best way to do this is to just start with the "Overview" sections and fill out details incrementally in follow on PRs. View anything marked as a `provisional` as a working document and subject to change. 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 canonical place for the latest set of instructions (and the likely source of this file) is . The `Metadata` section above is intended to support the creation of tooling around the OEP process. This will be a YAML section that is fenced as a code block. See the for details on each of these items. A table of contents is helpful for quickly jumping to sections of a OEP and for highlighting any additional information provided beyond the standard OEP template. a table of contents from markdown are available. * * * * The `Summary` section is incredibly important for producing high quality user focused documentation such as release notes or a development road map. 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. OEP editors should help to ensure that the tone and content of the `Summary` section is useful for a wide audience. A good summary is probably at least a paragraph in

This section is for explicitly listing the motivation, goals and non-goals of this OEP. Describe why the change is important and the benefits to users. The motivation section can optionally provide links to to demonstrate the interest in a OEP within the wider OpenEBS community. List the specific goals of the OEP. How will we know that this has succeeded? What is out of scope for his OEP? Listing non-goals helps to focus discussion and make progress. This is where we get down to the nitty gritty of what the proposal actually is. Detail the things that people will be able to do if this OEP 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. 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. What are the risks of this proposal and how do we mitigate. Think broadly. For example, consider both security and how this will impact the larger kubernetes ecosystem. How will we know that this has succeeded? Gathering user feedback is crucial for building high quality experiences and owners have the important responsibility of setting milestones for stability and completeness. Hopefully the content previously contained in will be tracked in the `Graduation Criteria` section. Major milestones in the life cycle of a OEP should be tracked in `Implementation History`. Major milestones might include the `Summary` and `Motivation` sections being merged signaling owner acceptance the `Proposal` section being merged signaling agreement on a proposed design the date implementation started the first OpenEBS release where an initial version of the OEP was available the version of OpenEBS where the OEP graduated to general availability when the OEP was retired or superseded Why should this OEP not be implemented. Similar to the `Drawbacks` section the `Alternatives` section is used to highlight and record other possible approaches to delivering the value proposed by a OEP. Use this section if you need things from the project/owner. Examples include a new subproject, repos requested, github details. Listing these here allows a owner to get the process for these resources started right away.