hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Anu Engineer (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (HDFS-12734) Ozone: generate version specific documentation during the build
Date Fri, 03 Nov 2017 21:31:01 GMT

    [ https://issues.apache.org/jira/browse/HDFS-12734?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16238422#comment-16238422
] 

Anu Engineer edited comment on HDFS-12734 at 11/3/17 9:30 PM:
--------------------------------------------------------------

bq. This is not an option. mvn site needs to be used to be consistent with the rest of Hadoop.
If you want to move Hadoop to something that isn't mvn site, that's a much bigger conversation
and should definitely not be snuck into a patch.
I am sorry that the description of this JIRA is confusing. Ozone docs use mvn site exactly
as Hadoop. There is no deviation from existing behavior.

This is a completely new feature that allows KSM to carry documentation as part of the KSM
UI (completely separate from standard documentation of  Hadoop Site)   This is completely
orthogonal to the mvn site command. The reason why we choose hugo to do this was HADOOP-14163.
That patch uses Hugo and we did not want to introduce any new dependencies via Ozone.
 
[~aw] I hope this addresses your concern and you would be kind enough to lift your -1.


was (Author: anu):
bq. This is not an option. mvn site needs to be used to be consistent with the rest of Hadoop.
If you want to move Hadoop to something that isn't mvn site, that's a much bigger conversation
and should definitely not be snuck into a patch.
I am sorry that the description of this JIRA is confusing. Ozone docs use mvn site exactly
as Hadoop. There is no deviation from existing behavior.

This is a completely new feature that allows KSM to carry documentation as part of the KSM
UI (completely separate from standard documentation of  Hadoop Site)   This is completely
orthogonal to the mvn site command. The reason why we choose hugo to do this was HADOOP-14163.
That patch uses Hugo and we did not want to introduce any new dependencies via Oozne.
 

> Ozone: generate version specific documentation during the build
> ---------------------------------------------------------------
>
>                 Key: HDFS-12734
>                 URL: https://issues.apache.org/jira/browse/HDFS-12734
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>          Components: ozone
>    Affects Versions: HDFS-7240
>            Reporter: Elek, Marton
>            Assignee: Elek, Marton
>            Priority: Major
>         Attachments: HDFS-12734-HDFS-7240.001.patch
>
>
> HDFS-12664 susggested a new way to include documentation in the KSM web ui.
> This patch modifies the build lifecycle to automatically generate the documentation *if*
hugo is on the PATH. If hugo is not there  the documentation won't be generated and it won't
be displayed (see HDFS-12661)
> To test: Apply this patch on top of HDFS-12664 do a full build and check the KSM webui.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
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