hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Work logged] (HDDS-1659) Define the process to add proposal/design docs to the Ozone subproject
Date Wed, 12 Jun 2019 07:52:00 GMT

     [ https://issues.apache.org/jira/browse/HDDS-1659?focusedWorklogId=258486&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-258486
]

ASF GitHub Bot logged work on HDDS-1659:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 12/Jun/19 07:51
            Start Date: 12/Jun/19 07:51
    Worklog Time Spent: 10m 
      Work Description: elek commented on issue #950: HDDS-1659. Define the process to add
proposal/design docs to the Ozone subproject
URL: https://github.com/apache/hadoop/pull/950#issuecomment-501161056
 
 
   The first version (#922) is reverted due to a RAT failure. But I also updated the text
itself to address some earlier comments.
   
    1. typo is fixed (thanks @ajayydv)
    2. I clearly defined that the design docs which are not yet implemented shouldn't be visible
on the docs page (or only on a separated page) (thanks @eyanghwx)
    3. I clarified that we would like to be compatible with the existing practices (creating
PDF with any method or create a wiki page should be accaptable) but I suggested to create
a reference page with a summary and link. I think it addresses the possible formatting issues
(thanks @arp7, what do you think about this approach?)
   
   TL;DR:
   
    * Create a new jira + a  new page under the `docs/content/design` folder for each new
design docs
    * Either include the content of the design in the markdown file (recommended as it can
be commented line by line) or include the link (to Apache Jira attachment or Apache Wiki)
 
----------------------------------------------------------------
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:
users@infra.apache.org


Issue Time Tracking
-------------------

    Worklog Id:     (was: 258486)
    Time Spent: 2h 20m  (was: 2h 10m)

> 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
>             Fix For: 0.4.1
>
>          Time Spent: 2h 20m
>  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-unsubscribe@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-help@hadoop.apache.org


Mime
View raw message