Merge pull request #185 from ngageoint/release-docs

Issue 184: Documentation updates for 0.1.0 release

Author: mbrukman

BUILDING.md

@@ -3,8 +3,8 @@ Building JanusGraph
 
 Required:
 
-* Java 7 (0.5 and earlier) or Java 8 (0.9 and later)
-* Maven
+* Java 8
+* Maven 3
 
 To build without executing tests:
 
@@ -18,18 +18,20 @@ To build with default tests:
 mvn clean install
 ```
 
-To build with default plus TinkerPop tests:
+To build with default plus TinkerPop tests\*:
 
 ```
 mvn clean install -Dtest.skip.tp=false
 ```
 
-To build with only the TinkerPop tests:
+To build with only the TinkerPop tests\*:
 
 ```
 mvn clean install -Dtest.skip.tp=false -DskipTests=true
 ```
 
+\* See note below for running tests with TinkerPop 3.2.3
+
 ## Building on Eclipse IDE
 Note that this has only been tested on Eclipse Neon.2 Release (4.6.2) with m2e (1.7.0.20160603-1933) and m2e-wtp (1.3.1.20160831-1005) plugin.
 
@@ -48,3 +50,15 @@ To build without executing tests:
 To find the Java binary in your environment, run the appropriate command for your operating system:
 * Linux/macOS: `which java`
 * Windows: `for %i in (java.exe) do @echo. %~$PATH:i`
+
+## Running tests with TinkerPop 3.2.3
+
+Several TinkerPop tests require commit `7aa9782`, which was merged after the release of TinkerPop 3.2.3. Tests requiring this commit include BulkDumperVertexProgramTest and PeerPressureTest. In order to run these tests TinkerPop must be locally patched and built as shown below. Note this is only necessary when running JanusGraph TinkerPop tests (`mvn clean install -Dtest.skip.tp=false`).
+
+```bash
+git clone https://github.com/apache/tinkerpop.git
+cd tinkerpop
+git checkout 3.2.3
+git cherry-pick 7aa9782
+mvn clean install -DskipTests -Drat.skip=true
+```

CHANGELOG.asc

@@ -6,4 +6,36 @@ Release Notes
 Version 0.1.0 (TBD)
 ~~~~~~~~~~~~~~~~~~~
 
-Changelog to be added once released.
+[source, m2]
+<dependency>
+   <groupId>org.janusgraph</groupId>
+   <artifactId>janusgraph-core</artifactId>
+   <version>0.1.0</version>
+</dependency>
+
+*Tested Compatibility:*
+
+* Cassandra 2.1.9
+* HBase 0.98.8-hadoop2, 1.0.3, 1.1.8, 1.2.4
+* Bigtable 0.9.5.1
+* BerkeleyJE 7.3.7
+* Elasticsearch 1.5.1
+* Lucene 4.10.4
+* Solr 5.2.1
+* TinkerPop 3.2.3
+* Java 1.8
+
+*Features added since version Titan 1.0.0:*
+
+* TinkerPop 3.2.3 compatibility
+** Includes update to Spark 1.6.1
+* Query optimizations: JanusGraphStep folds in HasId and HasContainers can be folded in even mid-traversal
+* Support Google Cloud Bigtable as a backend over the HBase interface
+* Compatibility with newer versions of backend and index stores
+** HBase 1.2
+** BerkeleyJE 7.3.7
+* Includes a number of bugfixes and optimizations
+
+For more information on features and bugfixes in 0.1.0, see these GitHub milestones:
+
+* https://github.com/JanusGraph/janusgraph/milestone/1

NOTICE.txt

@@ -10,30 +10,37 @@ This product includes software developed by Aurelius (http://thinkaurelius.com/)
  * Marko A. Rodriguez
  * Stephen Mallette
  * Pavel Yaskevich
+ * Others as listed in CONTRIBUTORS.txt
 
 It also includes software from other open source projects including, but not limited to (check pom.xml for complete listing):
 
- * TinkerPop [http://tinkerpop.incubator.apache.org/]
+ * Apache Cassandra [http://cassandra.apache.org/]
  * Apache Commons [http://commons.apache.org/]
- * Google Guava [http://code.google.com/p/guava-libraries/]
- * HPPC [http://labs.carrotsearch.com/hppc.html]
- * Junit Benchmark [http://labs.carrotsearch.com/junit-benchmarks.html]
- * Kryo [http://code.google.com/p/kryo/]
- * SLF4J [http://www.slf4j.org/]
- * Metrics [http://metrics.codahale.com/]
- * Apache log4j [http://logging.apache.org/log4j/]
- * Apache HBase [http://hbase.apache.org/]
+ * Apache Groovy [http://groovy-lang.org/]
+ * Apache HBase [https://hbase.apache.org/]
  * Apache Hadoop [http://hadoop.apache.org/]
- * Apache Cassandra [http://cassandra.apache.org/]
- * Apache Lucene [http://lucene.apache.org/]
- * Apache MRUnit [http://mrunit.apache.org/]
- * Apache Groovy [http://www.groovy-lang.org/]
- * OpenRDF [http://www.openrdf.org/]
- * Elastic Search [http://www.elasticsearch.org/]
+ * Apache Log4j [https://logging.apache.org/log4j]
+ * Apache Lucene [https://lucene.apache.org/]
+ * Apache MRUnit [https://mrunit.apache.org/]
+ * Apache Solr [http://lucene.apache.org/solr/]
+ * Apache TinkerPop [http://tinkerpop.apache.org/]
  * Astyanax [https://github.com/Netflix/astyanax]
+ * EasyMock [http://easymock.org/]
+ * Elasticsearch [https://www.elastic.co/]
+ * Google Guava [https://github.com/google/guava]
+ * H2 [http://h2database.com]
+ * HPPC [https://labs.carrotsearch.com/hppc.html]
  * JUnit [http://www.junit.org/]
- * Mockito [http://code.google.com/p/mockito/]
+ * Jackson [https://github.com/FasterXML/jackson]
+ * Junit Benchmark [https://labs.carrotsearch.com/junit-benchmarks.html]
+ * Kryo [https://github.com/EsotericSoftware/kryo]
+ * Metrics [http://metrics.dropwizard.io]
+ * Mockito [http://site.mockito.org/]
+ * OpenRDF [http://rdf4j.org/]
  * Oracle BerkeleyDB Java Edition [http://www.oracle.com/technetwork/products/berkeleydb/] (see license below)
+ * Reflections [https://github.com/ronmamo/reflections]
+ * SLF4J [https://www.slf4j.org/]
+ * Spatial4j [https://github.com/locationtech/spatial4j]
 
 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 Copyright (C) 2002, 2016, Oracle  and/or its affiliates. All rights reserved.

RELEASING.md

@@ -42,7 +42,6 @@ Documentation pages:
 * changelog.txt
 * versions.txt
 * upgrade.txt
-* acknowledgements.txt
 
 Files in the main repo:
 

UPGRADE.asc

@@ -1,13 +1,11 @@
 [[upgrade]]
 [appendix]
-Upgrade Instructions
---------------------
+== Upgrade Instructions
 
 Please follow these instructions when upgrading from Titan or an older
 JanusGraph release.
 
-Upgrading from Titan
-~~~~~~~~~~~~~~~~~~~~
+=== Upgrading from Titan
 
 JanusGraph is based on the latest commit to the `titan11` branch of
 https://github.com/thinkaurelius/titan[Titan repo].
@@ -20,3 +18,11 @@ your code and configuration accordingly:
 . class names: `Titan*` are now `JanusGraph*` except in cases where this would
   duplicate a word, e.g., `TitanGraph` is simply `JanusGraph` rather than
   `JanusGraphGraph`
+
+The BerkeleyDB version has been updated, and it contains changes to the file
+format stored on disk. This file format change is forward compatible with
+previous versions of BerkeleyDB, so existing graph data stored with Titan
+can be read in. However, once the data has been read in with the newer version
+of BerkeleyDB, those files can no longer be read by the older version. Users
+are encouraged to backup the BerkeleyDB storage directory before attempting to
+use it with the JanusGraph release.

docs/changelog.txt

@@ -1,7 +1,41 @@
 [[changelog]]
 [appendix]
-== Release Notes
+Release Notes
+-------------
 
-=== Version 0.1.0 (TBD)
+Version 0.1.0 (TBD)
+~~~~~~~~~~~~~~~~~~~
 
-Changelog to be added once released.
+[source, m2]
+<dependency>
+   <groupId>org.janusgraph</groupId>
+   <artifactId>janusgraph-core</artifactId>
+   <version>0.1.0</version>
+</dependency>
+
+*Tested Compatibility:*
+
+* Cassandra 2.1.9
+* HBase 0.98.8-hadoop2, 1.0.3, 1.1.8, 1.2.4
+* Bigtable 0.9.5.1
+* BerkeleyJE 7.3.7
+* Elasticsearch 1.5.1
+* Lucene 4.10.4
+* Solr 5.2.1
+* TinkerPop 3.2.3
+* Java 1.8
+
+*Features added since version Titan 1.0.0:*
+
+* TinkerPop 3.2.3 compatibility
+** Includes update to Spark 1.6.1
+* Query optimizations: JanusGraphStep folds in HasId and HasContainers can be folded in even mid-traversal
+* Support Google Cloud Bigtable as a backend over the HBase interface
+* Compatibility with newer versions of backend and index stores
+** HBase 1.2
+** BerkeleyJE 7.3.7
+* Includes a number of bugfixes and optimizations
+
+For more information on features and bugfixes in 0.1.0, see these GitHub milestones:
+
+* https://github.com/JanusGraph/janusgraph/milestone/1

janusgraph-dist/src/release/index.html

@@ -55,7 +55,7 @@ <h2 id="project_tagline">Distributed Graph Database</h2>
 </ul>
 </li>
 
-<li>Support for global <a href="http://tinkerpop.incubator.apache.org/docs/$MAVEN{tinkerpop.version}/#graphcomputer">graph data analytics</a>, reporting, and ETL through integration with big data platforms:
+<li>Support for global <a href="http://tinkerpop.apache.org/docs/$MAVEN{tinkerpop.version}/reference/#graphcomputer">graph data analytics</a>, reporting, and ETL through integration with big data platforms:
 <ul>
 <li><a href="http://spark.apache.org/">Apache Spark</a></li>
 <li><a href="http://giraph.apache.org/">Apache Giraph</a></li>
@@ -65,17 +65,17 @@ <h2 id="project_tagline">Distributed Graph Database</h2>
 
 <li>Support for geo, numeric range, and full-text search via:
 <ul>
-<li><a href="http://www.elasticsearch.org/">ElasticSearch</a></li>
+<li><a href="https://www.elastic.co/">ElasticSearch</a></li>
 <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
 <li><a href="http://lucene.apache.org/">Lucene</a></li>
 </ul>
 </li>
 
-<li>Native integration with the <a href="http://tinkerpop.incubator.apache.org/">TinkerPop</a> graph stack:
+<li>Native integration with the <a href="http://tinkerpop.apache.org/">TinkerPop</a> graph stack:
 <ul>
-<li><a href="http://tinkerpop.incubator.apache.org/docs/$MAVEN{tinkerpop.version}/#traversal">Gremlin graph query language</a></li>
-<li><a href="http://tinkerpop.incubator.apache.org/docs/$MAVEN{tinkerpop.version}/#gremlin-server">Gremlin graph server</a></li>
-<li><a href="http://tinkerpop.incubator.apache.org/docs/$MAVEN{tinkerpop.version}/#gremlin-applications">Gremlin applications</a></li>
+<li><a href="http://tinkerpop.apache.org/docs/$MAVEN{tinkerpop.version}/reference/#traversal">Gremlin graph query language</a></li>
+<li><a href="http://tinkerpop.apache.org/docs/$MAVEN{tinkerpop.version}/reference/#gremlin-server">Gremlin graph server</a></li>
+<li><a href="http://tinkerpop.apache.org/docs/$MAVEN{tinkerpop.version}/reference/#gremlin-applications">Gremlin applications</a></li>
 </ul>
 </li>