Feature/sqs documentation (#665)

Author: paualarco

docker-compose.yml

@@ -38,7 +38,6 @@ services:
   elasticmq:
     image: softwaremill/elasticmq-native:latest
     ports:
-      - '9325:9325'
       - '9324:9324'
 
   redis:

docs/dynamo.md

@@ -23,7 +23,7 @@ Therefore, the connector provides three generic methods __single__, __transforme
 
 Add the following dependency to get started:
 ```scala 
-libraryDependencies += "io.monix" %% "monix-dynamodb" % "0.6.0-RC1"
+libraryDependencies += "io.monix" %% "monix-dynamodb" % "0.6.0"
 ```
 
 ## Async Client

docs/elasticsearch.md

@@ -15,7 +15,7 @@ but also to _search_ or _upload_ in a reactive fashion with _Monix Reactive_.
  Add the following dependency:
 
  ```scala
- libraryDependencies += "io.monix" %% "monix-elasticsearch" % "0.6.0-RC1"
+ libraryDependencies += "io.monix" %% "monix-elasticsearch" % "0.6.0"
  ```
 
 ## Client

docs/gcs.md

@@ -14,7 +14,7 @@ object will be returned to any _get request_, globally.
 
 Add the following dependency to get started:
 ```scala
-libraryDependencies += "io.monix" %% "monix-gcs" % "0.6.0-RC1"
+libraryDependencies += "io.monix" %% "monix-gcs" % "0.6.0"
 ```
 
 ## Getting Started

docs/hdfs.md

@@ -18,7 +18,7 @@ and it is built on top of the the official _apache hadoop_ api.
 Add the following dependency to get started:
 
 ```scala 
-libraryDependencies += "io.monix" %% "monix-hdfs" % "0.6.0-RC1"
+libraryDependencies += "io.monix" %% "monix-hdfs" % "0.6.0"
 ```
 
 By default the connector uses _Hadoop 3.1.1_. In case you need a different one you can replace it by excluding `org.apache.hadoop` from `monix-hdfs` and add the new one to your library dependencies.

docs/mongodb.md

@@ -1,5 +1,6 @@
 ---
-id: mongodb title: MongoDB
+id: mongodb 
+title: MongoDB
 ---
 
 ## Introduction
@@ -23,7 +24,7 @@ but before we will see how configure and connect to the database server.
 Add the following dependency to get started:
 
 ```scala
-libraryDependencies += "io.monix" %% "monix-mongodb" % "0.6.0-RC1"
+libraryDependencies += "io.monix" %% "monix-mongodb" % "0.6.0"
 ```
 
 ## Collection Reference
@@ -147,10 +148,11 @@ val employee1 = Employee("Employee1", 21, "Paris")
 val employee2 = Employee("Employee2", 29, "Amsterdam")
 val businessCol = CollectionDocumentRef(database = "myDb", collection = "business_collection")
 val employeesCol =
-  CollectionCodecRef("myDb", "employees_collection", classOf[Employee], createCodecProvider[Employee]())
-val connection = MongoConnection.create2("mongodb://host:27017", (employeesCol, businessCol))
+  CollectionCodecRef("myDb", "employees_collection", classOf[Employee], createCodecProvider[Employee]()) 
 
-connection.use { case (employeesOperator, businessOperator) =>
+// calling `create2` because we want operate with two mongodb collections.
+MongoConnection.create2("mongodb://host:27017", (employeesCol, businessCol))
+  .use { case (employeesOperator, businessOperator) =>
   for {
     //business logic here
     _ <- employeesOperator.single.insertMany(List(employee1, employee2)) >>
@@ -223,7 +225,7 @@ val connection = MongoConnection.create1("mongodb://host:27017", employeesCol).u
     databaseName <- collOperator.db.listDatabases
     collectionName <- collOperator.db.listCollections(databaseName)
     // calling `listCollections` without arguments, would only
-    // return the collections names from the current list 
+    // return the collections names from the current database 
   } yield collectionName
   collections.count
 }

docs/overview.md

@@ -18,7 +18,7 @@ title: Overview
 Find and fill your release [version](https://github.com/monix/monix-connect/releases)):
 
  ```scala   
- libraryDependencies += "io.monix" %% "monix-connect" % "0.6.0-RC1"
+ libraryDependencies += "io.monix" %% "monix-connect" % "0.6.0"
 ```
 
 ⚠️ **Mind that the project isn't yet stable, so binary compatibility is not guaranteed.** ❗

docs/parquet.md

@@ -15,7 +15,7 @@ Therefore, the `monix-parquet` _connector_ basically exposes stream integrations
 Add the following dependency:
 
  ```scala
- libraryDependencies += "io.monix" %% "monix-parquet" % "0.6.0-RC1"
+ libraryDependencies += "io.monix" %% "monix-parquet" % "0.6.0"
  ```
 
 ## Getting started

docs/redis.md

@@ -19,7 +19,7 @@ a _non blocking_ Redis client.
 Add the following dependency:
 
 ```scala
-libraryDependencies += "io.monix" %% "monix-redis" % "0.6.0-RC1"
+libraryDependencies += "io.monix" %% "monix-redis" % "0.6.0"
 ```
 
 ## Redis Connection
@@ -60,8 +60,8 @@ servers in the cluster.
 import monix.connect.redis.client.{RedisConnection, RedisUri}
 
 val redisNode1 = RedisUri("my.redis.node.1", 7000)
-val redisNode2 = RedisUri("my.redis.node.1", 7001)
-val redisNode3 = RedisUri("my.redis.node.1", 7002)
+val redisNode2 = RedisUri("my.redis.node.2", 7001)
+val redisNode3 = RedisUri("my.redis.node.3", 7002)
 
 val redisClusterConn: RedisConnection = RedisConnection.cluster(List(redisNode1, redisNode2, redisNode3))
 ```
@@ -487,7 +487,7 @@ And then from the application side you would do:
 import monix.connect.redis.client
 import monix.connect.redis.client.{RedisConnection, RedisUri}
 
-val redisUris: Seq[RedisUri] = (0 to 5).map(n => RedisUri(s"redis://localhost:${(700 + n)}"))
+val redisUris: Seq[RedisUri] = (0 to 5).map(n => RedisUri(s"redis://localhost:${(7000 + n)}"))
 val clusterConn = RedisConnection.cluster(redisUris)
 ``` 
 

docs/s3.md

@@ -16,7 +16,7 @@ This module exposes a wide range of methods for interacting with S3 _buckets_ an
  Add the following dependency in your _build.sbt_:
 
  ```scala
- libraryDependencies += "io.monix" %% "monix-s3" % "0.6.0-RC1"
+ libraryDependencies += "io.monix" %% "monix-s3" % "0.6.0"
  ```
 
 ## Async Client
@@ -73,8 +73,9 @@ This module exposes a wide range of methods for interacting with S3 _buckets_ an
 This config file should be placed in the `resources` folder, therefore it will be automatically picked up from the method call `S3.fromConfig`, which will return a `cats.effect.Resource[Task, S3]`.
 The [resource](https://typelevel.org/cats-effect/datatypes/resource.html) is responsible of the *creation* and *release* of the _S3 client_. 
 
-We recommend using it transparently in your application, meaning that your methods and classes will directly expect an instance of _S3_, which will be called from within the 
-_usage_ of the _Resource_. See below code snippet to understand the concept:
+**Try to reuse** the created **S3** client as much as possible in your application multiple times in your application. Otherwise, creating it
+multiple times will waste precious resources... See below code snippet to understand the concept:
+
 
 ```scala
  import monix.connect.s3.S3
@@ -96,9 +97,9 @@ _usage_ of the _Resource_. See below code snippet to understand the concept:
      }
    } yield download
  }
- 
+
   // the connection gets created and released within the use method and the `S3`
-  // instance is directly passed to our application for an easier interoperability
+  // instance is directly passed and should be reused across our application
   val f = S3.fromConfig.use(s3 => runS3App(s3)).runToFuture
 ```  
 
@@ -279,7 +280,6 @@ import monix.eval.Task
 
 val bucket = "my-bucket"
 val key = "sample/download/path/file.txt"
-val content: Array[Byte] = "Dummy file content".getBytes()
 val s3: S3
 
 val t: Task[Array[Byte]] = s3.download("my-bucket", key)
@@ -478,7 +478,9 @@ that's because it is a heavy image and sometimes it takes bit long to start or i
 Finally, now you can already create the connection to _AWS S3_, _notice_ that _minio_ does not support _Anonymous credentials_, instead you'll have to use the _Static Credentials Provider_ and specify the _key_ and _secret_ corresponding respectively to the
  defined environment variables `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY`.
 
-Below snippet represents the settings that would be needed to locally connect to _minio_ using config file:
+Below snippet represents the settings that would be needed to locally connect to _minio_ using config file, which should be placed
+under your test resources folder `src/test/resources`.
+
 
  ```hocon
 {
@@ -494,7 +496,7 @@ Below snippet represents the settings that would be needed to locally connect to
 }
 ```
 
-Alternatively you can create connection like:
+Alternatively you can statically create connection by parameters:
 
 ```scala
 import monix.connect.s3.S3
@@ -511,10 +513,10 @@ val s3SecretKey: String = "TESTSECRET" //equal to the `env var `MINIO_SECRET_KEY
 val basicAWSCredentials = AwsBasicCredentials.create(s3AccessKey, s3SecretKey)
 val staticCredentialsProvider = StaticCredentialsProvider.create(basicAWSCredentials)
 
-val s3: S3 = S3.createUnsafe(basicAWSCredentials, Region.EU_WEST_1, Some(URI.create(minioEndPoint)))
+val s3Resource = S3.create(basicAWSCredentials, Region.EU_WEST_1, Some(URI.create(minioEndPoint)))
 ```
 
 
 ### JVM S3 Mock library
 
-In case you prefer to _start_ and _stop_ the _S3_ service from from the code of same test and therefore not depending on _docker_ but just on a _JVM library dependency_, you can refer to [findify/s3Mock](https://github.com/findify/s3mock) to see more. 
+In case you prefer to _start_ and _stop_ the _S3_ service from the code of same test and therefore not depending on _docker_ but just on a _JVM library dependency_, you can refer to [findify/s3Mock](https://github.com/findify/s3mock) to find out more.