Update docs to SCC 3.0.1

datastax · Apr 8, 2021 · 42937e1 · 42937e1
1 parent a964042
commit 42937e1
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -5,8 +5,8 @@
 | What       | Where |
 | ---------- | ----- |
 | Community  | Chat with us at [Datastax and Cassandra Q&A](https://community.datastax.com/index.html) |
-| Scala Docs | Most Recent Release (3.0.0): [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.0/connector/com/datastax/spark/connector/index.html), [Spark-Cassandra-Connector-Driver](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.0/driver/com/datastax/spark/connector/index.html)|
-| Latest Production Release | [3.0.0](https://search.maven.org/artifact/com.datastax.spark/spark-cassandra-connector_2.12/3.0.0/jar) |
+| Scala Docs | Most Recent Release (3.0.1): [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.1/connector/com/datastax/spark/connector/index.html), [Spark-Cassandra-Connector-Driver](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.1/driver/com/datastax/spark/connector/index.html)|
+| Latest Production Release | [3.0.1](https://search.maven.org/artifact/com.datastax.spark/spark-cassandra-connector_2.12/3.0.1/jar) |
 
 ## Features
 
@@ -63,8 +63,8 @@ development for the next connector release in progress.
 ## Hosted API Docs
 API documentation for the Scala and Java interfaces are available online:
 
-### 3.0.0
-* [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.0/connector/com/datastax/spark/connector/index.html)
+### 3.0.1
+* [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/3.0.1/connector/com/datastax/spark/connector/index.html)
 
 ### 2.5.2
 * [Spark-Cassandra-Connector](https://datastax.github.io/spark-cassandra-connector/ApiDocs/2.5.2/connector/#package)
@@ -83,7 +83,7 @@ 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:
 
-    libraryDependencies += "com.datastax.spark" %% "spark-cassandra-connector" % "3.0.0"
+    libraryDependencies += "com.datastax.spark" %% "spark-cassandra-connector" % "3.0.1"
 
 * The default Scala version for Spark 3.0+ is 2.12 please choose the appropriate build. See the
 [FAQ](doc/FAQ.md) for more information.

diff --git a/doc/0_quick_start.md b/doc/0_quick_start.md
@@ -15,14 +15,14 @@ Configure a new Scala project with the Apache Spark and dependency.
 
 The dependencies are easily retrieved via Maven Central 
 
-    libraryDependencies += "com.datastax.spark" % "spark-cassandra-connector_2.12" % "3.0.0"
+    libraryDependencies += "com.datastax.spark" % "spark-cassandra-connector_2.12" % "3.0.1"
 
 The spark-packages libraries can also be used with spark-submit and spark shell, these
 commands will place the connector and all of its dependencies on the path of the
 Spark Driver and all Spark Executors.
 
-    $SPARK_HOME/bin/spark-shell --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.0
-    $SPARK_HOME/bin/spark-submit --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.0
+    $SPARK_HOME/bin/spark-shell --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.1
+    $SPARK_HOME/bin/spark-submit --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.1
 
 For the list of available versions, see:
 - https://repo1.maven.org/maven2/com/datastax/spark/spark-cassandra-connector_2.12/
@@ -42,7 +42,7 @@ and *all* of its dependencies on the Spark Class PathTo configure
 the default Spark Configuration pass key value pairs with `--conf`
 
     $SPARK_HOME/bin/spark-shell --conf spark.cassandra.connection.host=127.0.0.1 \
-                                --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.0
+                                --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.1
                                 --conf spark.sql.extensions=com.datastax.spark.connector.CassandraSparkExtensions
 
 This command would set the Spark Cassandra Connector parameter 

diff --git a/doc/13_spark_shell.md b/doc/13_spark_shell.md
@@ -18,7 +18,7 @@ Find additional versions at [Spark Packages](https://repo1.maven.org/maven2/com/
 ```bash
 cd spark/install/dir
 #Include the --master if you want to run against a spark cluster and not local mode
-./bin/spark-shell [--master sparkMasterAddress] --jars yourAssemblyJar --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.0 --conf spark.cassandra.connection.host=yourCassandraClusterIp
+./bin/spark-shell [--master sparkMasterAddress] --jars yourAssemblyJar --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.1 --conf spark.cassandra.connection.host=yourCassandraClusterIp
 ```
 
 By default spark will log everything to the console and this may be a bit of an overload. To change this copy and modify the `log4j.properties` template file

diff --git a/doc/15_python.md b/doc/15_python.md
@@ -14,7 +14,7 @@ shell similarly to how the spark shell is started. The preferred method is now t
 
 ```bash
 ./bin/pyspark \
-  --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.0 \
+  --packages com.datastax.spark:spark-cassandra-connector_2.12:3.0.1 \
   --conf spark.sql.extensions=com.datastax.spark.connector.CassandraSparkExtensions
 ```
 

diff --git a/generateDocs.sh b/generateDocs.sh
@@ -1,6 +1,13 @@
 #!/bin/bash
 SCC_HOME="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 OUTPUT="/tmp/SCC_DOC_TEMP"
+
+if [ "$#" -lt 1 ]; then
+    echo "At least one version parameter is required, e.g. 3.0.1 (no leading 'v')."
+    exit 1
+fi
+
+
 rm -r $OUTPUT
 mkdir -p $OUTPUT
 echo "SPARK CASSANDRA CONNECTOR HOME IS $SCC_HOME"