From a40fdb968bd50480e3080222960fdf3f555bc70b Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Mon, 24 Aug 2015 16:32:00 -0700 Subject: [PATCH] Integrate docs with Kudu site menu and CSS, customize CSS somewhat. Change-Id: Ia8a1cfb2b68a5d527b78d5e3a191a76ba4aabd39 Reviewed-on: http://gerrit.sjc.cloudera.com:8080/7592 Tested-by: Adar Dembo Reviewed-by: Adar Dembo --- docs/administration.adoc | 3 + docs/configuration.adoc | 3 + docs/configuration_reference.adoc | 3 + docs/configuration_reference_unsupported.adoc | 3 + docs/contributing.adoc | 3 + docs/developing.adoc | 3 + docs/docinfo.html | 120 ++++++++++++++++++ docs/index.adoc | 44 ++++++- docs/installation.adoc | 6 +- docs/introduction.adoc | 3 + docs/quickstart.adoc | 3 + docs/resources.adoc | 5 + docs/style_guide.adoc | 3 + docs/support/scripts/make_docs.sh | 4 +- docs/troubleshooting.adoc | 4 + 15 files changed, 205 insertions(+), 5 deletions(-) create mode 100644 docs/docinfo.html diff --git a/docs/administration.adoc b/docs/administration.adoc index f2dd6859b7..621bbd8153 100644 --- a/docs/administration.adoc +++ b/docs/administration.adoc @@ -1,5 +1,8 @@ [[administration]] = Kudu Administration + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/configuration.adoc b/docs/configuration.adoc index 475c6650a2..fb9b6d4471 100644 --- a/docs/configuration.adoc +++ b/docs/configuration.adoc @@ -1,5 +1,8 @@ [[configuration]] = Configuring Kudu + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/configuration_reference.adoc b/docs/configuration_reference.adoc index 143231e8b1..2727c90227 100644 --- a/docs/configuration_reference.adoc +++ b/docs/configuration_reference.adoc @@ -1,5 +1,8 @@ [[configuration_reference]] = Kudu Configuration Reference + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/configuration_reference_unsupported.adoc b/docs/configuration_reference_unsupported.adoc index b733fef776..6fffc20db3 100644 --- a/docs/configuration_reference_unsupported.adoc +++ b/docs/configuration_reference_unsupported.adoc @@ -1,5 +1,8 @@ [[configuration_reference_unsupported]] = Unsupported Configuration Flags + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/contributing.adoc b/docs/contributing.adoc index 61c05a155c..30e66a298f 100644 --- a/docs/contributing.adoc +++ b/docs/contributing.adoc @@ -1,5 +1,8 @@ [[contributing]] = Contributing to Kudu + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/developing.adoc b/docs/developing.adoc index 41d8d55187..fbcde8c370 100644 --- a/docs/developing.adoc +++ b/docs/developing.adoc @@ -1,5 +1,8 @@ [[developing]] = Developing Applications With Kudu + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/docinfo.html b/docs/docinfo.html new file mode 100644 index 0000000000..300e6fdd27 --- /dev/null +++ b/docs/docinfo.html @@ -0,0 +1,120 @@ + + + \ No newline at end of file diff --git a/docs/index.adoc b/docs/index.adoc index bf1157a3ef..05d54adb4e 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -1,6 +1,39 @@ -// License Header Here // - = Kudu Documentation + +// tag::start_nav[] +++++ +
+ + + +
+++++ +// end::start_nav[] + +// License Header Here // :author: Kudu Team :imagesdir: ./images :icons: font @@ -9,6 +42,10 @@ :sectlinks: :experimental: +++++ +
+++++ + link:introduction.html[Introducing Kudu]:: Get familiar with what sets Kudu apart. @@ -43,3 +80,6 @@ link:resources.html[Kudu Resources]:: Further reading about Kudu, columnar data stores, and other useful material for Kudu users and developers. +++++ +
+++++ diff --git a/docs/installation.adoc b/docs/installation.adoc index b1b90da90e..3f52e4f4be 100644 --- a/docs/installation.adoc +++ b/docs/installation.adoc @@ -1,5 +1,8 @@ [[installation]] = Installing Kudu + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font @@ -476,6 +479,7 @@ see `java/README.md`. [[view_api]] == View API Documentation +// tag::view_api[] .C++ API Documentation The documentation for the C++ client APIs is included in the header files in `/usr/include/kudu/` if you installed Kudu using packages or subdirectories @@ -495,7 +499,7 @@ $ find /usr/include/kudu -type f -name *.h You can view the link:../apidocs/index.html[Java API documentation] online. Alternatively, after <>, Java API documentation is available in `java/kudu-client/target/apidocs/index.html`. - +// end::view_api[] == Next Steps - link:configuration.html[Configuring Kudu] - link:administration.html[Kudu Administration] diff --git a/docs/introduction.adoc b/docs/introduction.adoc index d8b7c8f672..cc58229a75 100644 --- a/docs/introduction.adoc +++ b/docs/introduction.adoc @@ -1,5 +1,8 @@ [[introduction]] = Introducing Kudu + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc index 3e82c67339..14f3a9c88d 100644 --- a/docs/quickstart.adoc +++ b/docs/quickstart.adoc @@ -1,5 +1,8 @@ [[quickstart]] = Kudu Quickstart + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/resources.adoc b/docs/resources.adoc index 5d1a581e56..dec7bf0eaf 100644 --- a/docs/resources.adoc +++ b/docs/resources.adoc @@ -1,5 +1,8 @@ [[resources]] = Resources + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font @@ -9,3 +12,5 @@ :backend: html5 :sectlinks: :experimental: + + diff --git a/docs/style_guide.adoc b/docs/style_guide.adoc index c7cb7bfd04..f4afd14f76 100644 --- a/docs/style_guide.adoc +++ b/docs/style_guide.adoc @@ -1,5 +1,8 @@ [[documentation_style_guide]] = Kudu Documentation Style Guide + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font diff --git a/docs/support/scripts/make_docs.sh b/docs/support/scripts/make_docs.sh index 9f745d2fda..cd3c21967e 100755 --- a/docs/support/scripts/make_docs.sh +++ b/docs/support/scripts/make_docs.sh @@ -27,7 +27,7 @@ done mkdir -p "$BUILD_DIR" -cp -r docs/*.adoc docs/images "$BUILD_DIR/" +cp -r docs/*.adoc docs/docinfo.html docs/images "$BUILD_DIR/" # Create config flag references for each of the binaries below binaries=("cfile-dump" \ @@ -69,7 +69,7 @@ done # Add the includes to the configuration reference files, replacing the template lines sed -i "s#@@CONFIGURATION_REFERENCE@@#${INCLUSIONS_SUPPORTED}#" ${BUILD_DIR}/configuration_reference.adoc sed -i "s#@@CONFIGURATION_REFERENCE@@#${INCLUSIONS_UNSUPPORTED}#" ${BUILD_DIR}/configuration_reference_unsupported.adoc -asciidoctor -d book ${BUILD_DIR}/*.adoc -D "$OUTPUT_DIR" +asciidoctor -d book -a docinfo1 ${BUILD_DIR}/*.adoc -D "$OUTPUT_DIR" RESULT=$? if [ $RESULT -eq 0 ]; then echo "Docs built in $OUTPUT_DIR." diff --git a/docs/troubleshooting.adoc b/docs/troubleshooting.adoc index 0a1f9347d1..8c200134c1 100644 --- a/docs/troubleshooting.adoc +++ b/docs/troubleshooting.adoc @@ -1,5 +1,8 @@ [[troubleshooting]] = Troubleshooting + +include::index.adoc[tags=start_nav] + :author: Kudu Team :imagesdir: ./images :icons: font @@ -9,3 +12,4 @@ :backend: html5 :sectlinks: :experimental: +