[
https://issues.apache.org/jira/browse/IMPALA-5140?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michael Brown resolved IMPALA-5140.
-----------------------------------
Resolution: Fixed
Fix Version/s: Impala 2.9.0
{noformat}
commit 75cca8a90b05b733653e31fe0791791c5616d78e
Author: Michael Brown <mi...@cloudera.com>
Date: Tue Mar 21 13:10:51 2017 -0700
IMPALA-5140: improve docs building guidelines
Move docs/generatingImpalaDoc.md to docs/README.md. This will
automatically render the document inline at places like:
https://github.com/apache/incubator-impala/tree/master/docs
under the directory listing.
Fix existing markdown which wasn't always rendering properly. Remove
unneeded HTML and backslashes. Add a mention of make, and add one
troubleshooting tip. Wrap most lines at 90 chars. This does not change
how Github renders the markdown, and it makes reading the source easier
as well.
Explain how to get dita into PATH.
Emphasize make and remove some of the dita advanced usage.
Change-Id: I71ae79ecd346045697fe225140ee9a317c5a337f
Reviewed-on: http://gerrit.cloudera.org:8080/6512
Reviewed-by: Jim Apple <jbapple-imp...@apache.org>
Tested-by: Michael Brown <mi...@cloudera.com>
{noformat}
> clean up markdown, make slight improvements to doc building howto
> -----------------------------------------------------------------
>
> Key: IMPALA-5140
> URL: https://issues.apache.org/jira/browse/IMPALA-5140
> Project: IMPALA
> Issue Type: Improvement
> Components: Docs
> Affects Versions: Impala 2.9.0
> Reporter: Michael Brown
> Assignee: Michael Brown
> Fix For: Impala 2.9.0
>
>
> I was trying to build our docs and had trouble. I went looking for
> docs-for-docs and noticed some improvements that could be made. This Jira is
> about fixing them.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
