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 <[email protected]> Reviewed-by: Adar Dembo <[email protected]>
yubobo · Aug 26, 2015 · a40fdb9 · a40fdb9
1 parent 05b0b1e
commit a40fdb9
Show file tree

Hide file tree

Showing 15 changed files with 205 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,120 @@
+<!-- Bootstrap core CSS -->
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" rel="stylesheet">
+<style>
+/* Custom styles for this template */
+
+/* from justified-nav.css */
+body {
+  padding-top: 20px;
+}
+
+.footer {
+  padding-top: 40px;
+  padding-bottom: 40px;
+  margin-top: 40px;
+  border-top: 1px solid #eee;
+}
+
+/* Main marketing message and sign up button */
+.jumbotron {
+  text-align: center;
+  background-color: transparent;
+}
+.jumbotron .btn {
+  padding: 14px 24px;
+  font-size: 21px;
+}
+
+/* Customize the nav-justified links to be fill the entire space of the .navbar */
+
+.nav-justified {
+  background-color: #eee;
+  border: 1px solid #ccc;
+  border-radius: 5px;
+}
+.nav-justified > li > a {
+  padding-top: 15px;
+  padding-bottom: 15px;
+  margin-bottom: 0;
+  font-weight: bold;
+  color: #777;
+  text-align: center;
+  background-color: #e5e5e5; /* Old browsers */
+  background-image: -webkit-gradient(linear, left top, left bottom, from(#f5f5f5), to(#e5e5e5));
+  background-image: -webkit-linear-gradient(top, #f5f5f5 0%, #e5e5e5 100%);
+  background-image:      -o-linear-gradient(top, #f5f5f5 0%, #e5e5e5 100%);
+  background-image:         linear-gradient(to bottom, #f5f5f5 0%,#e5e5e5 100%);
+  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f5f5f5', endColorstr='#e5e5e5',GradientType=0 ); /* IE6-9 */
+  background-repeat: repeat-x; /* Repeat the gradient */
+  border-bottom: 1px solid #d5d5d5;
+}
+.nav-justified > .active > a,
+.nav-justified > .active > a:hover,
+.nav-justified > .active > a:focus {
+  background-color: #ddd;
+  background-image: none;
+  -webkit-box-shadow: inset 0 3px 7px rgba(0,0,0,.15);
+          box-shadow: inset 0 3px 7px rgba(0,0,0,.15);
+}
+.nav-justified > li:first-child > a {
+  border-radius: 5px 5px 0 0;
+}
+.nav-justified > li:last-child > a {
+  border-bottom: 0;
+  border-radius: 0 0 5px 5px;
+}
+
+@media (min-width: 768px) {
+  .nav-justified {
+    max-height: 52px;
+  }
+  .nav-justified > li > a {
+    border-right: 1px solid #d5d5d5;
+    border-left: 1px solid #fff;
+  }
+  .nav-justified > li:first-child > a {
+    border-left: 0;
+    border-radius: 5px 0 0 5px;
+  }
+  .nav-justified > li:last-child > a {
+    border-right: 0;
+    border-radius: 0 5px 5px 0;
+  }
+}
+
+/* Responsive: Portrait tablets and up */
+@media screen and (min-width: 768px) {
+  /* Remove the padding we set earlier */
+  .masthead,
+  .marketing,
+  .footer {
+    padding-right: 0;
+    padding-left: 0;
+  }
+}
+
+/* Overrides */
+
+.admonitionblock td.content>.title, .audioblock>.title, .exampleblock>.title, .imageblock>.title, .listingblock>.title, .literalblock>.title, .stemblock>.title, .openblock>.title, .paragraph>.title, .quoteblock>.title, table.tableblock>.title, .verseblock>.title, .videoblock>.title, .dlist>.title, .olist>.title, .ulist>.title, .qlist>.title, .hdlist>.title {
+  font-size: 16px;
+  font-weight: 200;
+}
+
+p, blockquote, dt, td.content {
+  font-size: 14px;
+}
+
+.jumbotron dt {
+  font-size: 24px;
+  font-weight: 200;
+}
+
+.jumbotron dd p {
+  font-size: 18px;
+  font-weight: 200;
+}
+#header h1 {
+  text-align: center;
+}
+
+</style>
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -1,6 +1,39 @@
-// License Header Here //
-
 = Kudu Documentation
+
+// tag::start_nav[]
+++++
+<div class="container">
+
+      <!-- Static navbar -->
+      <nav class="navbar navbar-default">
+        <div class="container-fluid">
+          <div class="navbar-header">
+            <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+              <span class="sr-only">Toggle navigation</span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+            </button>
+            <a class="navbar-brand" href="/index.html">Kudu Project</a>
+          </div>
+          <div id="navbar" class="navbar-collapse collapse">
+            <ul class="nav navbar-nav">
+              <li><a href="../index.html">Home</a></li>
+              <li><a href="../overview.html">Overview</a></li>
+              <li class="active"><a href="index.html">Docs</a></li>
+              <li><a href="http://github.com/cloudera/kudu/">Repository</a></li>
+              <li><a href="contributing.html">Contributions</a></li>
+              <li><a href="../community.html">Community</a></li>
+              </li>
+            </ul>
+          </div><!--/.nav-collapse -->
+        </div><!--/.container-fluid -->
+      </nav>
+</div>
+++++
+// end::start_nav[]
+
+// License Header Here //
 :author: Kudu Team
 :imagesdir: ./images
 :icons: font
@@ -9,6 +42,10 @@
 :sectlinks:
 :experimental:
 
+++++
+<div class="jumbotron">
+++++
+
 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.
 
+++++
+</div>
+++++
diff --git 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 <<build_java_client,building the Java client>>, 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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:
+