impala-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Brown (Code Review)" <ger...@cloudera.org>
Subject [Impala-ASF-CR] IMPALA-5140: improve docs building guidelines
Date Wed, 05 Apr 2017 20:02:10 GMT
Michael Brown has submitted this change and it was merged.

Change subject: IMPALA-5140: improve docs building guidelines
......................................................................


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-impala@apache.org>
Tested-by: Michael Brown <mikeb@cloudera.com>
---
A docs/README.md
D docs/generatingImpalaDoc.md
2 files changed, 204 insertions(+), 73 deletions(-)

Approvals:
  Michael Brown: Verified
  Jim Apple: Looks good to me, approved



-- 
To view, visit http://gerrit.cloudera.org:8080/6512
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I71ae79ecd346045697fe225140ee9a317c5a337f
Gerrit-PatchSet: 10
Gerrit-Project: Impala-ASF
Gerrit-Branch: master
Gerrit-Owner: Michael Brown <mikeb@cloudera.com>
Gerrit-Reviewer: Jim Apple <jbapple-impala@apache.org>
Gerrit-Reviewer: Laurel Hale <laurel@cloudera.com>
Gerrit-Reviewer: Michael Brown <mikeb@cloudera.com>

Mime
View raw message