-
Notifications
You must be signed in to change notification settings - Fork 8.9k
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
HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject #922
Conversation
|
||
* Open a dedicated Jira (`HDDS-*` but with specific component) | ||
* Use standard name prefix in the jira (easy to filter on the mailing list) `[OEP] | ||
* Create a PR to merge the design doc (markdown) to `hadoop-hdds/docs/content/proposal` (will be part of the docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
During an offline discussion @arp7 had some concerns about the usability of reviewing markdown files in PR vs. reviewing google docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: this is a complex PR because it contains the changes to show design docs on the docs page. A normal design doc would contain just one markdown file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update: I removed the HTTP/template changes.
🎊 +1 overall
This message was automatically generated. |
* [Apache Spark Project Improvement Proposals](https://spark.apache.org/improvement-proposals.html) | ||
* [Kubernetes Enhancement Proposals](https://github.com/kubernetes/enhancements/tree/master/keps) | ||
|
||
Short summary if the porcesses: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo
i like the idea of more detailed information in markdown format. It will be easier to update in subsequent changes and will be included in docs in case some user wants to access it. |
At all, this is just the start of this conversation, let us commit this and iterate over this process and get into a good shape. Thank you all for a wonderful discussion during the community call. |
Thanks to commit this @anuengineer I repoened it temporary as it introduced a RAT error in daily build. Will upload a fixed version soon. |
…e subproject (apache#922) * HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject * Remove Site improvements to display proposals
…the Ozone subproject (apache#922)" This reverts commit e997f2a.
Checkstyle version upgrade 5.9 -> 6.11 and fixes to pass checks **Why this version (6.11) but not latest (8.17)?** In version [6.11.1](http://checkstyle.sourceforge.net/releasenotes.html#Release_6.11.1) lambda indentation support was added, and it reports tremendous amount of errors in project. I found no option to change indent policy for lambdas therefore set version without this check. Author: strkkk <andreypaykin@gmail.com> Reviewers: Sanil Jain <snjain@linkedin.com> Closes apache#922 from strkkk/checkstyle
We think that it would be more effective to collect all the design docs in one place and make it easier to review them by the community.
We propose to follow an approach where the proposals are committed to the hadoop-hdds/docs project and the review can be the same as a review of a PR
See: https://issues.apache.org/jira/browse/HDDS-1659