Joshfischer/javadocs (#3302)
* adding start to make file and javadoc script
* updating javadoc overview
diff --git a/.gitignore b/.gitignore
index 635f236..3b81340 100644
--- a/.gitignore
+++ b/.gitignore
@@ -129,6 +129,8 @@
website/node_modules/
website/public/
/bin/
+website2/website/public
+website2/website/static/api
# Visual Studio Code
.vscode
diff --git a/website2/website/Makefile b/website2/website/Makefile
new file mode 100644
index 0000000..3e82ae8
--- /dev/null
+++ b/website2/website/Makefile
@@ -0,0 +1,5 @@
+start:
+ yarn start
+
+javadocs:
+ @scripts/javadocs.sh
diff --git a/website2/website/scripts/javadocs-overview.html b/website2/website/scripts/javadocs-overview.html
new file mode 100644
index 0000000..4d0a711
--- /dev/null
+++ b/website2/website/scripts/javadocs-overview.html
@@ -0,0 +1,22 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<body>
+ <p>Heron is a realtime, distributed, fault-tolerant stream processing engine.</p>
+ </body>
\ No newline at end of file
diff --git a/website2/website/scripts/javadocs.sh b/website2/website/scripts/javadocs.sh
new file mode 100755
index 0000000..5232bbc
--- /dev/null
+++ b/website2/website/scripts/javadocs.sh
@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+set -e
+
+JAVADOC=javadoc
+FLAGS="-quiet -Xdoclint:none"
+
+HERON_ROOT_DIR=$(git rev-parse --show-toplevel)
+# for display on GitHub website
+JAVADOC_OUTPUT_DIR=$HERON_ROOT_DIR/website2/website/public/api/java
+# for display on local Hugo server
+JAVADOC_OUTPUT_LOCAL_DIR=$HERON_ROOT_DIR/website2/website/static/api
+GEN_PROTO_DIR=$HERON_ROOT_DIR/bazel-bin/heron/proto/_javac
+
+# The path of the customized landing page for the Javadocs
+OVERVIEW_HTML_FILE=$HERON_ROOT_DIR/website2/website/scripts/javadocs-overview.html
+
+# Check if this script is run with Travis flag
+if [ $# -eq 1 ] && [ $1 == "--travis" ]; then
+ BAZEL_CMD="bazel --bazelrc=$HERON_ROOT_DIR/tools/travis/bazel.rc build"
+else
+ BAZEL_CMD="bazel build"
+fi
+
+(cd $HERON_ROOT_DIR && $BAZEL_CMD \
+ `bazel query 'kind("java_library", "heron/...")'`\
+ `bazel query 'kind("java_test", "heron/...")'` \
+ `bazel query 'kind("java_library", "integration_test/...")'`)
+
+HERON_SRC_FILES=`find $HERON_ROOT_DIR -path "*/org/apache/*" -name "*.java"`
+BACKTYPE_SRC_FILES=`find $HERON_ROOT_DIR -path "*/backtype/storm/*" -name "*.java"`
+APACHE_SRC_FILES=`find $HERON_ROOT_DIR -path "*/org/apache/storm/*" -name "*.java"`
+GEN_FILES=`find $GEN_PROTO_DIR -name "*.java"`
+
+rm -rf $JAVADOC_OUTPUT_DIR
+mkdir -p $JAVADOC_OUTPUT_DIR
+
+BIN_JARS=`find $HERON_ROOT_DIR/bazel-incubator-heron/_bin/. -name "*\.jar" | tr '\n' ':'`
+GEN_JARS=`find $HERON_ROOT_DIR/bazel-genfiles/external/. -name "*\.jar" | tr '\n' ':'`
+SCRIBE_JARS=`find $HERON_ROOT_DIR/bazel-bin/. -name "libthrift_scribe_java.jar" | tr '\n' ':'`
+PROTO_JARS=`find $HERON_ROOT_DIR/bazel-bin/heron/proto/. -name "*\.jar" | tr '\n' ':'`
+CLOSURE_CLASSES="$HERON_ROOT_DIR/bazel-bin/storm-compatibility/src/java/_javac/storm-compatibility-java/libstorm-compatibility-java_classes/."
+
+export CLASSPATH=$BIN_JARS:$GEN_JARS:$SCRIBE_JARS:$PROTO_JARS:$CLOSURE_CLASSES
+
+$JAVADOC $FLAGS \
+ -windowtitle "Heron Java API" \
+ -doctitle "The Heron Java API" \
+ -overview $OVERVIEW_HTML_FILE \
+ -d $JAVADOC_OUTPUT_DIR $GEN_FILES $HERON_SRC_FILES $BACKTYPE_SRC_FILES $APACHE_SRC_FILES || true
+
+# Generated Java API doc needs to be copied to $JAVADOC_OUTPUT_LOCAL_DIR
+# for the following two reasons:
+# 1. When one is developing website locally, They should
+# be able to click into API doc link and view API doc to
+# check if the correct API link is given.
+# 2. ``wget`` needs to verify if links to Java API doc are valid when we are
+# serving the website locally. This means that Hugo should be able to display
+# Java API doc properly.
+cp -r $JAVADOC_OUTPUT_DIR $JAVADOC_OUTPUT_LOCAL_DIR
+
+echo "Javdocs generated at $JAVADOC_OUTPUT_DIR"
+exit 0
