Merge pull request #1276 from datastax/SPARKC-593-2.5

SPARKC-593 2.5 doc fixes

Author: jtgrabowski

README.md

@@ -64,7 +64,7 @@ development for the next connector release in progress.
 API documentation for the Scala and Java interfaces are available online:
 
 ### 2.5.1
-* [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/2.5.1/#package)
+* [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/2.5.1/connector/#package)
 
 ### 2.4.2
 * [Spark-Cassandra-Connector](http://datastax.github.io/spark-cassandra-connector/ApiDocs/2.4.2/spark-cassandra-connector/)
@@ -75,10 +75,8 @@ API documentation for the Scala and Java interfaces are available online:
 * [Embedded-Cassandra](http://datastax.github.io/spark-cassandra-connector/ApiDocs/2.3.2/spark-cassandra-connector-embedded/)
 
 ## Download
-This project is available on Spark Packages; this is the easiest way to start using the connector:
-https://spark-packages.org/package/datastax/spark-cassandra-connector
 
-This project has also been published to the Maven Central Repository.
+This project is available on the Maven Central Repository.
 For SBT to download the connector binaries, sources and javadoc, put this in your project
 SBT config:
 
@@ -162,6 +160,9 @@ To run unit and integration tests:
     ./sbt/sbt test
     ./sbt/sbt it:test
 
+Note that the integration tests require [CCM](https://github.com/riptano/ccm) to be installed on your machine.
+See [Tips for Developing the Spark Cassandra Connector](doc/developers.md) for details.
+
 By default, integration tests start up a separate, single Cassandra instance and run Spark in local mode.
 It is possible to run integration tests with your own Cassandra and/or Spark cluster.
 First, prepare a jar with testing code:

doc/12_building_and_artifacts.md

@@ -36,7 +36,7 @@ A fat jar with `assembly` suffix will be generated to:
 
     spark-cassandra-connector/connector/target/scala-{binary.version}/
 
-The jar contains Spark Cassandra Connector and its dependencies. Some of the dependencies are shaded to avoid 
+The jar contains the Spark Cassandra Connector and its dependencies. Some of the dependencies are shaded to avoid 
 classpath conflicts.  
 It is recommended to use the main artifact when possible.
 

doc/developers.md

@@ -13,25 +13,25 @@ Help](https://help.github.com/articles/cloning-a-repository/).
 
 Once in the sbt shell you will be able to build and run tests for the
 connector without any Spark or Cassandra nodes running. The integration tests 
-require [CCM](https://github.com/riptano/ccm) installed on your machine. 
-This can be accomplished with `pip install ccm`
+require a valid path to java home set in the `JAVA_HOME` env variable and 
+[CCM](https://github.com/riptano/ccm) to be installed on your machine. 
+This can be accomplished with `pip install ccm`.
 
 The most common commands to use when developing the connector are
 
 1. `test` - Runs the the unit tests for the project.
-2. `it:test` - Runs the integration tests with embedded Cassandra and Spark
+2. `it:test` - Runs the integration tests with Cassandra (started by CCM) and Spark
 3. `package` - Builds the project and produces a runtime jar
 4. `publishM2` - Publishes a snapshot of the project to your local maven repository allowing for usage with --packages in the spark-shell
 
 The integration tests located in `connector/src/it` should
 probably be the first place to look for anyone considering adding code.
 There are many examples of executing a feature of the connector with
-the embedded Cassandra and Spark nodes and are the core of our test 
-coverage.
+Cassandra and Spark nodes and are the core of our test coverage.
 
 ### Merge Path
 
-b2.5 => b3.0 => Master
+b2.5 => Master
 
 New features can be considered for 2.5 as long as they do not break apis
 In general 3.0 should be the target for new features
@@ -68,7 +68,7 @@ listed in build.yaml. In addition the test-support module supports Cassandra
 or other CCM Compatible installations.
 
 If using SBT you can set
-`CCM_CASSANDRA_VERSION` to propagate a version for CCM to use during tests
+`CCM_CASSANDRA_VERSION` to propagate a version for CCM to use during tests.
 
 If you are running tests through IntelliJ or through an alternative framework (jUnit)
 set the system property `ccm.version` to the version you like.