[
https://issues.apache.org/jira/browse/HDFS-9464?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15042253#comment-15042253
]
Allen Wittenauer commented on HDFS-9464:
----------------------------------------
hadoop-project/src/site/site.xml generates the index.html file used for the
docs website. There are a couple of choices that can be made:
* For a general overview kind of thing, a src/site/markdown/whatever.md file
should be created and linked to from the HDFS section. This could contain
motivation, examples, general info, etc.
* For autogenerated/API-type things, a link should be added to API section that
points to the autogenerated doxygen bits.
> Documentation needs to be exposed
> ---------------------------------
>
> Key: HDFS-9464
> URL: https://issues.apache.org/jira/browse/HDFS-9464
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: hdfs-client
> Reporter: Allen Wittenauer
> Priority: Blocker
>
> From the few builds I've done, there doesn't appear to be any user-facing
> documentation that is actually exposed when mvn site is built. HDFS-8745
> allegedly added doxygen support, but even those docs aren't tied into the
> docs and/or site build.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
