Adar Dembo has posted comments on this change. Change subject: Add more thorough instructions for building docs and site ......................................................................
Patch Set 2: (5 comments) http://gerrit.cloudera.org:8080/#/c/1581/2/README.adoc File README.adoc: Line 295: To build the documentation or the site, the pre-requisites for building Kudu Nit: in installation.adoc, we spell it "prerequisites". Can you do that here too, and below? Line 300: $ sudo apt-get install ruby ruby-devel xsltproc # for Ubuntu Can you reconcile this with the doc prerequisites found in installation.adoc? Line 314: This will invoke `docs/support/scripts/make_docs.sh`, and will place the Nit: the name of the script feels like an unnecessary implementation detail to me. If someone wants to figure out how this works, they'll search for 'make docs', find it CMakeLists.txt, and see the script name there. Line 329: the 'gh-pages' branch and use `make_docs.sh` to generate the HTML documentation Nit: likewise, make_docs.sh here feels like an unnecessary name drop. Someone who wants to change make_site.sh will have to look at how it works anyway, and they'll see the reference to make_docs.sh there. http://gerrit.cloudera.org:8080/#/c/1581/2/docs/support/scripts/make_site.sh File docs/support/scripts/make_site.sh: Line 42: rm -rf "$SOURCE_ROOT/CMakeCache.txt" "$SOURCE_ROOT/CMakeFiles" This is one of the reasons I want to forbid building in the source directory. It would suck if every single out-of-tree build script needed to add this line to avoid breaking some of the time. We don't actually need this, right? It's just for cases where someone is switching from in-tree building to out-of-tree building and forgot to remove it themselves. -- To view, visit http://gerrit.cloudera.org:8080/1581 To unsubscribe, visit http://gerrit.cloudera.org:8080/settings Gerrit-MessageType: comment Gerrit-Change-Id: Ic1cde866d421a96b3803c236333bc1e70ee17f51 Gerrit-PatchSet: 2 Gerrit-Project: kudu Gerrit-Branch: master Gerrit-Owner: Mike Percy <[email protected]> Gerrit-Reviewer: Adar Dembo <[email protected]> Gerrit-Reviewer: Kudu Jenkins Gerrit-Reviewer: Misty Stanley-Jones <[email protected]> Gerrit-HasComments: Yes
