[
https://issues.apache.org/jira/browse/HDFS-12664?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Anu Engineer updated HDFS-12664:
--------------------------------
Attachment: 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
These are sources for the ozone site. To generate this site, we have to follow
the instructions in the README.md. This is patch 1 of 3. In the next patch, I
will generate the site and check that in, that is what will show the
documentation link on KSM UI. I am separating the JIRAs to make it easy to read
the source vs. generated code from running Hugo.
We also need to add license information about the DocBook template used in the
generation of this site, it is MIT licensed but separating that to a different
JIRA to make it easy to review.
I have attached 2 screenshots to show how the generated site will look like.
The first screenshot shows the documentation link on KSM UI and the second
screenshot shows how the docs will look like in KSM.
I will file the follow-up JIRAs that will generate and commit the site and
modify the License.txt.
cc: [~cheersyang], [~yuanbo], [~linyiqun], [~xyao], [~elek], [~ajayydv],
[~vagarychen], [~jnp], [~arpitagarwal], [~nandakumar131], [~msingh] This is
first draft, I am still modifying content, but wanted to get some early
feedback.
> 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-12611, 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 HDFS 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
