[
https://issues.apache.org/jira/browse/HDFS-12664?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16206134#comment-16206134
]
Elek, Marton commented on HDFS-12664:
-------------------------------------
1. src/main/docs would be better than src/main/java, I think.
2. I am not sure if the docdock should be imported to the hadoop source. It
could be downloaded as a dependency if doesn't exist locally, and not a hard
requirement. Did you modified anything in the theme?
3. I am just wondering how the content between this site and the hadoop docs
will be shared. IMHO ideally all the information should be available both in
/docs and in the hadoop docs. I checked how is it possible to use the same
markdown for maven site and hugo, but it's not easy. Both doxia (maven site
generation) both hugo requires predefined directory structure (And doxia
doesn't support headers in the markdown files). The only workaround what I
found is using include from the hugo side:
{code}
cat src/site/hugo/content/Corona.mmark
+++
title = "Corona"
date = "2017-09-02T23:58:17-07:00"
menu = "main"
weight=22
+++
{{../markdown/Corona.md}}
{code}
Please note that I used mmark extension (this is the markdown parser which
supports include). The rendering seems to be working, but should checked what
are the common parts of the markdown syntaxes.
> Ozone: Documentation: Add version specific documentation site to KSM
> --------------------------------------------------------------------
>
> Key: HDFS-12664
> URL: https://issues.apache.org/jira/browse/HDFS-12664
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: ozone
> Affects Versions: HDFS-7240
> Reporter: Anu Engineer
> Assignee: Anu Engineer
> Priority: Critical
> Labels: ozoneDoc, ozoneMerge
> Attachments: HDFS-12664-HDFS-7240.001.patch, Screen Shot 2017-10-14
> at 7.20.01 PM.png, Screen Shot 2017-10-14 at 7.20.40 PM.png
>
>
> In HDFS-12661, [~elek] has supported the ability to have version specific
> documentation for KSM. In other words, with HDFS-12661, it checks if
> Documentation is checked in and if so it will appear as "Documentation" Link
> on the KMS UI. The makes it easy to have accurate and version specific
> documentation for ozone.
> This JIRA proposes to add the first draft of the documentation that can be
> accessed via KSM UI. This is independent of the standard Ozone documentation
> that we add to the HDFS documentation.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
