[GitHub] [hadoop] elek commented on issue #950: HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject

[GitBox <gi...@apache.org>]

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


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org