Skip to content

Commit

Permalink
Update Set up Documentation (#2685)
Browse files Browse the repository at this point in the history
  • Loading branch information
@i-walker
i-walker committed Mar 14, 2022
1 parent 24dd19a commit 5faf3f4
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 201 deletions.
4 changes: 2 additions & 2 deletions arrow-site/docs/docs/core/README.md
View file
Expand Up @@ -183,7 +183,7 @@ dependencies {

#### Next development version

If you want to try the latest features, replace `1.0.1` with on of the latest `alpha`, `beta` or `rc` publications.
If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.

</div>

Expand Down Expand Up @@ -236,7 +236,7 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa

#### Next development version

If you want to try the latest features, replace `1.0.1` with on of the latest `alpha`, `beta` or `rc` publications.
If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.

</div>
</div>
Expand Down
95 changes: 4 additions & 91 deletions arrow-site/docs/docs/fx/README.md
View file
Expand Up @@ -139,19 +139,7 @@ dependencies {

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```
allprojects {
repositories {
maven(url = "https://oss.sonatype.org/content/repositories/snapshots/")
}
// To use latest artifacts
configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") }
}
```
If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.

</div>

Expand Down Expand Up @@ -195,19 +183,7 @@ dependencies {

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```groovy
allprojects {
repositories {
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
// To use latest artifacts
configurations.all { resolutionStrategy.cacheChangingModulesFor 0, 'seconds' }
}
```
If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.

</div>

Expand All @@ -220,7 +196,7 @@ following properties:

```xml
<properties>
<kotlin.version>1.5.31</kotlin.version>
<kotlin.version>1.6.10</kotlin.version>
<arrow.version>1.0.1</arrow.version>
</properties>
```
Expand All @@ -236,58 +212,6 @@ Add the dependencies that you want to use:
</dependency>
```

#### Enabling kapt for the Optics DSL

For the Optics DSL, enable annotation processing using Kotlin plugin:

```xml

<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
<executions>
<execution>
<id>kapt</id>
<goals>
<goal>kapt</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>src/main/kotlin</sourceDir>
</sourceDirs>
<annotationProcessorPaths>
<annotationProcessorPath>
<groupId>io.arrow-kt</groupId>
<artifactId>arrow-meta</artifactId>
<version>${arrow.version}</version>
</annotationProcessorPath>
</annotationProcessorPaths>
</configuration>
</execution>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>src/main/kotlin</sourceDir>
</sourceDirs>
</configuration>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>test-compile</goal>
</goals>
</execution>
</executions>
</plugin>
```

#### BOM file

To avoid specifying the Arrow version for every dependency, a BOM file is available:
Expand All @@ -311,18 +235,7 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```xml

<repository>
<snapshotss>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<updatePolicy>always</updatePolicy>
</snapshots>
</repository>
```
If you want to try the latest features, replace `1.0.1` with one of the latest `alpha`, `beta` or `rc` publications.

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions arrow-site/docs/docs/optics/README.md
View file
Expand Up @@ -154,7 +154,7 @@ To get the most of Arrow Optics you can add out Kotlin plug-in to your build, wh

```
plugins {
id("com.google.devtools.ksp") version "1.6.0-1.0.2"
id("com.google.devtools.ksp") version "1.6.10-1.0.4"
}
dependencies {
Expand Down Expand Up @@ -214,7 +214,7 @@ To get the most of Arrow Optics you can add out Kotlin plug-in to your build, wh

```groovy
plugins {
id "com.google.devtools.ksp" version "1.6.0-1.0.2"
id "com.google.devtools.ksp" version "1.6.10-1.0.4"
}
dependencies {
Expand Down
122 changes: 16 additions & 106 deletions arrow-site/docs/docs/quickstart/README.md
View file
Expand Up @@ -129,7 +129,7 @@ Arrow supports Android starting on API 21 and up.

In your project's root `build.gradle.kts`, append this repository to your list:

```
```kotlin
allprojects {
repositories {
mavenCentral()
Expand All @@ -141,7 +141,7 @@ Add the dependencies into the project's `build.gradle.kts`:

##### Arrow Core

```
```kotlin
dependencies {
implementation("io.arrow-kt:arrow-core:1.0.1")
}
Expand All @@ -150,14 +150,16 @@ dependencies {
##### Arrow Core + Arrow Optics

```
apply plugin: 'kotlin-kapt'
apply plugin: 'com.google.devtools.ksp'
dependencies {
implementation("io.arrow-kt:arrow-optics:1.0.1")
kapt("io.arrow-kt:arrow-meta:1.0.1")
ksp("io.arrow-kt:arrow-optics-ksp-plugin:$arrowVersion")
}
```

here is an example repository https://github.com/arrow-kt/Arrow-JVM-Template/tree/optics-setup.

##### Arrow Core + Arrow Fx

```
Expand All @@ -182,20 +184,7 @@ dependencies {

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```
allprojects {
repositories {
...
maven(url = "https://oss.sonatype.org/content/repositories/snapshots/")
}
// To use latest artifacts
configurations.all { resolutionStrategy.cacheChangingModulesFor(0, "seconds") }
}
```
If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.

</div>

Expand Down Expand Up @@ -227,15 +216,16 @@ dependencies {
##### Arrow Core + Arrow Optics

```groovy
apply plugin: 'kotlin-kapt'
apply plugin: 'com.google.devtools.ksp'
def arrow_version = "1.0.1"
dependencies {
implementation "io.arrow-kt:arrow-optics:$arrow_version"
kapt "io.arrow-kt:arrow-meta:$arrow_version"
implementation "io.arrow-kt:arrow-optics:1.0.1"
ksp "io.arrow-kt:arrow-optics-ksp-plugin:$arrowVersion"
}
```

here is an example repository https://github.com/arrow-kt/Arrow-JVM-Template/tree/optics-setup.

##### Arrow Core + Arrow Fx

```groovy
Expand All @@ -262,20 +252,7 @@ dependencies {

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```groovy
allprojects {
repositories {
...
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
// To use latest artifacts
configurations.all { resolutionStrategy.cacheChangingModulesFor 0, 'seconds' }
}
```
If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.

</div>

Expand All @@ -289,7 +266,7 @@ following properties:
```xml

<properties>
<kotlin.version>1.5.31</kotlin.version>
<kotlin.version>1.6.10</kotlin.version>
<arrow.version>1.0.1</arrow.version>
</properties>
```
Expand All @@ -305,58 +282,6 @@ Add the dependencies that you want to use:
</dependency>
```

#### Enabling kapt for the Optics DSL

For the Optics DSL, enable annotation processing using Kotlin plugin:

```xml

<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
<executions>
<execution>
<id>kapt</id>
<goals>
<goal>kapt</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>src/main/kotlin</sourceDir>
</sourceDirs>
<annotationProcessorPaths>
<annotationProcessorPath>
<groupId>io.arrow-kt</groupId>
<artifactId>arrow-meta</artifactId>
<version>${arrow.version}</version>
</annotationProcessorPath>
</annotationProcessorPaths>
</configuration>
</execution>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>src/main/kotlin</sourceDir>
</sourceDirs>
</configuration>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>test-compile</goal>
</goals>
</execution>
</executions>
</plugin>
```

#### BOM file

To avoid specifying the Arrow version for every dependency, a BOM file is available:
Expand All @@ -373,30 +298,15 @@ To avoid specifying the Arrow version for every dependency, a BOM file is availa
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement><dependencies>
</dependencyManagement>
...
</dependencies>
```

#### Next development version

If you want to try the latest features, replace `1.0.1` with `1.0.2-SNAPSHOT` and add this
configuration:

```xml

<repository>
<snapshotss>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<updatePolicy>always</updatePolicy>
</snapshots>
</repository>
```

</div>
If you want to try the latest features, replace `1.0.1` with the latest `alpha` release.
</div>

</div>


</div>

0 comments on commit 5faf3f4

Please sign in to comment.