Add plain text README.txt, use relative link from README.md to build.…

…md (apache#7611)

* use relative link to build instructions from top level readme

* add textfile to readme

* formatting

* make README.BINARY plaintext, move LABELS.md to LABELS, README.txt to README

* exclude README.BINARY still

* remove jdk links/recommmendations

* add script to use DRUIDVERSION in textfile README instead of latest, add links to recommended jdk to build.md

* license

* better readme template, links to latest if does not detect an apache release version

* fix

.gitignore

@@ -15,3 +15,4 @@ target
 _site
 dependency-reduced-pom.xml
 README.BINARY
+README

LABELS

@@ -0,0 +1,105 @@
+
+Licenses
+-----------
+
+This product bundles fonts from Font Awesome Free version 4.2.0, copyright Font Awesome,
+ which is available under the SIL OFL 1.1. For details, see licenses/bin/font-awesome.silofl
+  * https://fontawesome.com/
+
+This product bundles JavaBeans Activation Framework version 1.2.0, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.activation.CDDL11
+  * https://github.com/javaee/activation
+  * com.sun.activation:javax.activation
+
+This product bundles Jersey version 1.19.3, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/jersey.CDDL11
+  * https://jersey.github.io/
+  * com.sun.jersey:jersey-core
+  * com.sun.jersey:jersey-server
+  * com.sun.jersey:jersey-servlet
+  * com.sun.jersey:contribs
+
+This product bundles Expression Language 3.0 API version 3.0.0., copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/el-spec
+  * javax.el:javax.el-api
+
+This product bundles Java Servlet API version 3.1.0, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/servlet-spec
+  * javax.servlet:javax.servlet-api
+
+This product bundles JSR311 API version 1.1.1, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/jsr311-api.CDDL11
+  * https://github.com/javaee/jsr311
+  * javax.ws.rs:jsr311-api
+
+This product bundles Expression Language 3.0 version 3.0.0., copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/el-spec
+  * org.glassfish:javax.el
+
+This product bundles Jersey version 1.9, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/jersey.CDDL11
+  * https://jersey.github.io/
+  * com.sun.jersey:jersey-client
+  * com.sun.jersey:jersey-core
+
+This product bundles JavaBeans Activation Framework version 1.1, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javaxCDDL11
+  * https://github.com/javaee/activation
+  * javax.activation:activation
+
+This product bundles Java Servlet API version 2.5, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/servlet-spec
+  * javax.servlet:javax.servlet-api
+
+This product bundles JAXB version 2.2.2, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/jaxb-v2
+  * javax.xml.bind:jaxb-api
+
+This product bundles stax-api version 1.0-2, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/
+  * javax.xml.stream:stax-api
+
+This product bundles jsp-api version 2.1, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/javax.CDDL11
+  * https://github.com/javaee/javaee-jsp-api
+  * javax.servlet.jsp:jsp-api
+
+This product bundles Jersey version 1.15, copyright Oracle and/or its affiliates.,
+ which is available under the CDDL 1.1. For details, see licenses/bin/jersey.CDDL11
+  * https://jersey.github.io/
+  * com.sun.jersey:jersey-client
+
+This product bundles OkHttp Aether Connector version 0.0.9, copyright to original author or authors,
+ which is available under the Eclipse Public License 1.0. For details, see licenses/bin/aether-connector-okhttp.EPL1.
+  * https://github.com/takari/aether-connector-okhttp
+  * io.tesla.aether:aether-connector-okhttp
+
+This product bundles Tesla Aether version 0.0.5, copyright to original author or authors,
+ which is available under the Eclipse Public License 1.0. For details, see licenses/bin/tesla-aether.EPL1.
+  * https://github.com/tesla/tesla-aether
+  * io.tesla.aether:tesla-aether
+
+This product bundles Eclipse Aether libraries version 0.9.0.M2, copyright Sonatype, Inc.,
+ which is available under the Eclipse Public License 1.0. For details, see licenses/bin/aether-core.EPL1.
+  * https://github.com/eclipse/aether-core
+  * org.eclipse.aether:aether-api
+  * org.eclipse.aether:aether-connector-file
+  * org.eclipse.aether:aether-impl
+  * org.eclipse.aether:aether-spi
+  * org.eclipse.aether:aether-util
+
+This product bundles Rhino version 1.7R5, copyright Mozilla and individual contributors.,
+ which is available under the Mozilla Public License Version 2.0. For details, see licenses/bin/rhino.MPL2.
+  * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino
+  * org.mozilla:rhino
+
+This product bundles "Java Concurrency In Practice" Book Annotations, copyright Brian Goetz and Tim Peierls,
+ which is available under the Creative Commons Attribution 2.5 license. For details, see licenses/bin/creative-commons-2.5.LICENSE.
+  * http://jcip.net/
+  * net.jcip:jcip-annotations

README.md

@@ -68,7 +68,7 @@ We also have a couple people hanging out on IRC in `#druid-dev` on
 
 Please note that JDK 8 is required to build Druid.
 
-For instructions on building Druid from source, see [docs/content/development/build.md](https://github.com/apache/incubator-druid/blob/master/docs/content/development/build.md)
+For instructions on building Druid from source, see [docs/content/development/build.md](docs/content/development/build.md)
 
 ### Contributing
 

README.template

@@ -0,0 +1,89 @@
+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.
+
+
+
+Apache Druid (incubating) is a high performance analytics data store for event-driven data. More information about Druid
+can be found on http://www.druid.io.
+
+The Druid community is in the process of migrating to Apache by way of the Apache Incubator. Eventually, as we proceed
+along this path, our site will move from http://druid.io/ to https://druid.apache.org/.
+
+
+Documentation
+-------------
+You can find the documentation for {THIS_OR_THE_LATEST} Druid release on the project website http://druid.io/docs/{DRUIDVERSION}/.
+
+You can get started with Druid with our quickstart at http://druid.io/docs/{DRUIDVERSION}/tutorials/quickstart.html.
+
+
+Build from Source
+-----------------
+You can build Apache Druid (incubating) directly from source.
+
+Prerequisites:
+  JDK 8, 8u92+
+  Maven version 3.x
+
+
+The basic command to build Druid from source is:
+
+    mvn clean install
+
+
+This will run static analysis, unit tests, compile classes, and package the projects into JARs. It will not generate the
+source or binary distribution tarball.
+
+In addition to the basic stages, you may also want to add the following profiles and properties:
+
+  -Pdist           - Distribution profile: Generates the binary distribution tarball by pulling in core extensions and
+                     dependencies and packaging the files as 'distribution/target/apache-druid-x.x.x-bin.tar.gz'
+  -Papache-release - Apache release profile: Generates GPG signature and checksums, and builds the source distribution
+                     tarball as `distribution/target/apache-druid-x.x.x-src.tar.gz`
+  -Prat            - Apache Rat profile: Runs the Apache Rat license audit tool
+  -DskipTests      - Skips unit tests (which reduces build time)
+
+Putting these together, if you wish to build the source and binary distributions with signatures and checksums, audit
+licenses, and skip the unit tests, you would run:
+
+    mvn clean install -Papache-release,dist,rat -DskipTests
+
+Note: the AWS S3 unit tests require the 'AWS_DEFAULT_REGION' environment variable to be set to function correctly.
+
+
+Community
+---------
+Community support is available on the druid-user mailing list [email protected] also available at
+https://groups.google.com/forum/#!forum/druid-user.
+
+Development discussions occur on [email protected] (archive available at
+https://lists.apache.org/[email protected]), which you can subscribe to by emailing
+[email protected].
+
+
+Contributing
+------------
+If you find any bugs, please file a GitHub issue at https://github.com/apache/incubator-druid/issues.
+
+If you wish to contribute, please follow the guidelines listed at http://druid.io/community/.
+
+
+Disclaimer: Apache Druid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the
+Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the
+infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful
+ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it
+does indicate that the project has yet to be fully endorsed by the ASF.

distribution/pom.xml

@@ -87,8 +87,8 @@
                         <configuration>
                             <target>
                                 <concat destfile="${project.build.directory}/../../README.BINARY">
-                                    <fileset file="${project.build.directory}/../../README.md" />
-                                    <fileset file="${project.build.directory}/../../LABELS.md" />
+                                    <fileset file="${project.build.directory}/../../README" />
+                                    <fileset file="${project.build.directory}/../../LABELS" />
                                 </concat>
                             </target>
                         </configuration>
@@ -116,6 +116,20 @@
                         <groupId>org.codehaus.mojo</groupId>
                         <artifactId>exec-maven-plugin</artifactId>
                         <executions>
+                            <execution>
+                                <id>versionify-readme</id>
+                                <phase>initialize</phase>
+                                <goals>
+                                    <goal>exec</goal>
+                                </goals>
+                                <configuration>
+                                    <executable>${project.parent.basedir}/docs/_bin/build-textfile-readme.sh</executable>
+                                    <arguments>
+                                        <argument>${project.basedir}/../</argument>
+                                        <argument>${project.parent.version}</argument>
+                                    </arguments>
+                                </configuration>
+                            </execution>
                             <execution>
                                 <id>pull-deps</id>
                                 <phase>package</phase>

distribution/src/assembly/source-assembly.xml

@@ -47,6 +47,7 @@
                 <exclude>.gitignore</exclude>
                 <exclude>.dockerignore</exclude>
                 <exclude>.travis.yml</exclude>
+                <exclude>README.md</exclude>
                 <exclude>README.BINARY</exclude>
                 <exclude>publications/**</exclude>
                 <exclude>upload.sh</exclude>
@@ -68,7 +69,7 @@
             <directory>${project.build.directory}</directory>
             <includes>
                 <include>git.version</include>
-                <include>README.md</include>
+                <include>README</include>
             </includes>
             <outputDirectory/>
         </fileSet>

docs/_bin/build-textfile-readme.sh

@@ -0,0 +1,28 @@
+#!/bin/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.
+
+BASEDIR=$1
+DRUID_VERSION=$2
+THIS_OR_THE_LATEST="this"
+
+if ! [[ "$DRUID_VERSION" =~ [0-9]+\.[0-9]+\.[0-9]+(\-incubating)?$ ]];
+then
+  DRUID_VERSION="latest"
+  THIS_OR_THE_LATEST="the latest"
+fi
+
+sed -e "s/{THIS_OR_THE_LATEST}/${THIS_OR_THE_LATEST}/;s/{DRUIDVERSION}/${DRUID_VERSION}/" ${BASEDIR}/README.template > ${BASEDIR}/README