errose28 commented on code in PR #188: URL: https://github.com/apache/ozone-site/pull/188#discussion_r2728451079
########## docs/08-developer-guide/04-project/03-ozone-enhancement-proposals.md: ########## @@ -0,0 +1,102 @@ +--- +sidebar_label: Ozone Enhancement Proposals +--- + +# Ozone Enhancement Proposals + +For large features or changes, we use a process called "Ozone Enhancement Proposals" (OEPs) +to ensure that major modifications to Ozone are well-designed and have community consensus. + +If you plan to propose a significant change, please follow the process below +and create a design document *before* you start coding. + +**Note:** Design documents must be in Markdown format. We no longer accept PDFs or Google Docs. + +## OEP Process + +1. **Create a Jira:** Open a dedicated Jira ticket for the proposal. The ticket ID should start with the component prefix (e.g., `HDDS-`) and the title should be prefixed with `[OEP]`. +2. **Write the Design Doc:** Create the design document in Markdown format using the template below. Place the new file in the `hadoop-hdds/docs/content/design` directory. +3. **Submit a Pull Request:** Create a pull request to add the design document to the documentation. +4. **Discuss:** The community will discuss the proposal on the pull request. The discussion follows a lazy consensus model unless a formal vote is called. +5. **Update:** The design document can be updated based on feedback and changes during implementation. + +## Document Template + +The following is the proposed template for an OEP. While it is not mandatory to follow this exact structure, +your proposal should include the following sections. Some proposals may require a different structure +to best convey their design. + +```markdown +--- +title: A sample OEP template +summary: draft a proposal using this template +date: 2025-12-31 +jira: HDDS-14298 +status: implemented +author: Wei-Chiu Chuang +--- Review Comment: After looking at this again in the context of https://github.com/apache/ozone/pull/9664 we might still have a use case for some of the front matter: `authors` Sometimes designs are drafted initially in other platforms like Google docs by multiple people before being shared with the community as the ready-for-review markdown doc, which is just committed by one of the original authors. `jira` The Jira used to file the design doc may be a subtask of the epic used to track the feature development. Having an official link to the epic that corresponds to the scope of the doc would be helpful. A design that is "accepted" has its doc merged, and one that is "implemented" has its Jira epic resolved. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
