[
https://issues.apache.org/jira/browse/HDDS-1659?focusedWorklogId=256048&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-256048
]
ASF GitHub Bot logged work on HDDS-1659:
----------------------------------------
Author: ASF GitHub Bot
Created on: 07/Jun/19 16:39
Start Date: 07/Jun/19 16:39
Worklog Time Spent: 10m
Work Description: elek commented on pull request #922: HDDS-1659. Define
the process to add proposal/design docs to the Ozone subproject
URL: https://github.com/apache/hadoop/pull/922#discussion_r291669157
##########
File path: hadoop-hdds/docs/content/design/ozone-enhancement-proposals.md
##########
@@ -0,0 +1,97 @@
+---
+title: Ozone Enhancement Proposals
+summary: Definition of the process to share new technical proposals with the
Ozone community.
+date: 2019-06-07
+jira: HDDS-1659
+status: current
+author: Anu Enginner, Marton Elek
+---
+
+## Problem statement
+
+Some of the biggers features requires well defined plans before the
implementation. Until now it was managed by uploading PDF design docs to
selected JIRA. There are multiple problems with the current practice.
+
+ 1. There is no easy way to find existing up-to-date and outdated design docs.
+ 2. Design docs usually have better description of the problem that the user
docs
+ 3. We need better tools to discuss the design docs in the development phase
of the doc
+
+We propose to follow the same process what we have now, but instead of
uploading a PDF to the JIRA, create a PR to merge the proposal document to the
documentation project.
+
+## Non-goals
+
+ * Modify the existing workflow or approval process
+ * Migrate existing documents
+ * Make it harder to create design docs (it should be easy to support the
creation of proposals for any kind of tasks)
+
+## Proposed solution
+
+ * 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)
Review comment:
Update: I removed the HTTP/template changes.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 256048)
Time Spent: 1h (was: 50m)
> Define the process to add proposal/design docs to the Ozone subproject
> ----------------------------------------------------------------------
>
> Key: HDDS-1659
> URL: https://issues.apache.org/jira/browse/HDDS-1659
> Project: Hadoop Distributed Data Store
> Issue Type: Task
> Reporter: Elek, Marton
> Assignee: Elek, Marton
> Priority: Major
> Labels: pull-request-available
> Time Spent: 1h
> Remaining Estimate: 0h
>
> 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
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
