Skip to content

Commit

Permalink
Merge pull request #406 from commercetools/prepare-1.2.0
Browse files Browse the repository at this point in the history
Update documentation with new version: 1.2.0.
  • Loading branch information
heshamMassoud authored Jun 14, 2019
2 parents 107f1d9 + aa9d0a1 commit ee4dbca
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 23 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# commercetools sync
[![Build Status](https://travis-ci.org/commercetools/commercetools-sync-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sync-java)
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
[![Benchmarks 1.1.1](https://img.shields.io/badge/Benchmarks-1.1.1-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
[![Benchmarks 1.2.0](https://img.shields.io/badge/Benchmarks-1.2.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
[![Download](https://api.bintray.com/packages/commercetools/maven/commercetools-sync-java/images/download.svg) ](https://bintray.com/commercetools/maven/commercetools-sync-java/_latestVersion)
[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/)
[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/)
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)

More at https://commercetools.github.io/commercetools-sync-java
Expand Down Expand Up @@ -33,7 +33,7 @@ The library supports synchronising the following entities in commercetools
- [Ivy](#ivy)
- [Roadmap](#roadmap)
- [Release Notes](/docs/RELEASE_NOTES.md)
- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/)
- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/)
- [Benchmarks](https://commercetools.github.io/commercetools-sync-java/benchmarks/)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -73,26 +73,26 @@ Here are the most popular ones:
<dependency>
<groupId>com.commercetools</groupId>
<artifactId>commercetools-sync-java</artifactId>
<version>1.1.1</version>
<version>1.2.0</version>
</dependency>
````

#### Gradle

````groovy
implementation 'com.commercetools:commercetools-sync-java:1.1.1'
implementation 'com.commercetools:commercetools-sync-java:1.2.0'
````

#### SBT

````
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "1.1.1"
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "1.2.0"
````

#### Ivy

````xml
<dependency org="com.commercetools" name="commercetools-sync-java" rev="1.1.1"/>
<dependency org="com.commercetools" name="commercetools-sync-java" rev="1.2.0"/>
````


Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# commercetools sync
[![Build Status](https://travis-ci.org/commercetools/commercetools-sync-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sync-java)
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
[![Benchmarks 1.1.1](https://img.shields.io/badge/Benchmarks-1.1.1-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
[![Benchmarks 1.2.0](https://img.shields.io/badge/Benchmarks-1.2.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
[![Download](https://api.bintray.com/packages/commercetools/maven/commercetools-sync-java/images/download.svg) ](https://bintray.com/commercetools/maven/commercetools-sync-java/_latestVersion)
[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/)
[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/)
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)


Expand Down Expand Up @@ -50,18 +50,18 @@ Here are the most popular ones:
<dependency>
<groupId>com.commercetools</groupId>
<artifactId>commercetools-sync-java</artifactId>
<version>1.1.1</version>
<version>1.2.0</version>
</dependency>
````
#### Gradle
````groovy
implementation 'com.commercetools:commercetools-sync-java:1.1.1'
implementation 'com.commercetools:commercetools-sync-java:1.2.0'
````
#### SBT
````
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "1.1.1"
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "1.2.0"
````
#### Ivy
````xml
<dependency org="com.commercetools" name="commercetools-sync-java" rev="1.1.1"/>
<dependency org="com.commercetools" name="commercetools-sync-java" rev="1.2.0"/>
````
10 changes: 7 additions & 3 deletions docs/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,15 @@
-->


<!--
### 1.3.0 - Jun 24, 2019
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/1.2.0...1.3.0) |
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/1.3.0/) |
[Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/1.3.0)
-->

### 1.2.0 - Jun 20, 2019
### 1.2.0 - Jun 14, 2019
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/1.1.1...1.2.0) |
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/) |
[Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/1.2.0)
Expand Down Expand Up @@ -62,7 +67,6 @@
- **Commons** - Bumped JaCoCo dependency to 0.8.4.
- **Commons** - Bumped gradle to version [gradle-5.4.1](https://docs.gradle.org/5.4.1/release-notes.html)
- **Commons** - Bumped `com.adarshr.test-logger` to 1.7.0.
-->


### 1.1.1 - Jan 16, 2019
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/CATEGORY_SYNC.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ otherwise they won't be matched.
reference would return its `key`.

**Note**: This library provides you with a utility method
[`replaceCategoriesReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/com/commercetools/sync/categories/utils/CategoryReferenceReplacementUtils.html#replaceCategoriesReferenceIdsWithKeys-java.util.List-)
[`replaceCategoriesReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/com/commercetools/sync/categories/utils/CategoryReferenceReplacementUtils.html#replaceCategoriesReferenceIdsWithKeys-java.util.List-)
that replaces the references id fields with keys, in order to make them ready for reference resolution by the sync:
````java
// Puts the keys in the reference id fields to prepare for reference resolution
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/IMPORTANT_USAGE_TIPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ productSync.sync(batch1)
By design, scaling the sync process should **not** be done by executing the batches themselves in parallel. However, it can be done either by:

- Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `sphereClient` configuration. It defines how many requests the client can execute in parallel.
- or changing the draft [batch size](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/com/commercetools/sync/commons/BaseSyncOptionsBuilder.html#batchSize-int-). It defines how many drafts can one batch contain.
- or changing the draft [batch size](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/com/commercetools/sync/commons/BaseSyncOptionsBuilder.html#batchSize-int-). It defines how many drafts can one batch contain.

The current overridable default [configuration](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) of the `sphereClient`
is the recommended good balance for stability and performance for the sync process.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/INVENTORY_SYNC.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ against a [InventoryEntryDraft](https://docs.commercetools.com/http-api-projects
reference would return its `key`.

**Note**: This library provides you with a utility method
[`replaceInventoriesReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/com/commercetools/sync/inventories/utils/InventoryReferenceReplacementUtils.html#replaceInventoriesReferenceIdsWithKeys-java.util.List-)
[`replaceInventoriesReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/com/commercetools/sync/inventories/utils/InventoryReferenceReplacementUtils.html#replaceInventoriesReferenceIdsWithKeys-java.util.List-)
that replaces the references id fields with keys, in order to make them ready for reference resolution by the sync:
````java
// Puts the keys in the reference id fields to prepare for reference resolution
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/PRODUCT_SYNC.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ order for the sync to resolve the actual ids of those references, those `key`s h
reference would return its `key`.

**Note**: This library provides you with a utility method
[`replaceProductsReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.1.1/com/commercetools/sync/products/utils/ProductReferenceReplacementUtils.html#replaceProductsReferenceIdsWithKeys-java.util.List-)
[`replaceProductsReferenceIdsWithKeys`](https://commercetools.github.io/commercetools-sync-java/v/1.2.0/com/commercetools/sync/products/utils/ProductReferenceReplacementUtils.html#replaceProductsReferenceIdsWithKeys-java.util.List-)
that replaces the references id fields with keys, in order to make them ready for reference resolution by the sync:
````java
// Puts the keys in the reference id fields to prepare for reference resolution
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<dependency>
<groupId>com.commercetools</groupId>
<artifactId>commercetools-sync-java</artifactId>
<version>1.1.1</version>
<version>1.2.0</version>
</dependency>
````
- For Gradle users:
Expand All @@ -48,7 +48,7 @@ implementation 'com.commercetools.sdk.jvm.core:commercetools-java-client:1.37.0'
implementation 'com.commercetools.sdk.jvm.core:commercetools-convenience:1.37.0'
// Add commercetools-sync-java dependency.
implementation 'com.commercetools:commercetools-sync-java:1.1.1'
implementation 'com.commercetools:commercetools-sync-java:1.2.0'
````

### 2. Setup Syncing Options
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ nav:
- Advanced:
- Sync Options: usage/SYNC_OPTIONS.md
- Usage Tips: usage/IMPORTANT_USAGE_TIPS.md
- Javadoc: https://commercetools.github.io/commercetools-sync-java/v/1.1.1/
- Javadoc: https://commercetools.github.io/commercetools-sync-java/v/1.2.0/
- Release notes: RELEASE_NOTES.md
- Roadmap: https://github.com/commercetools/commercetools-sync-java/milestones
- Issues: https://github.com/commercetools/commercetools-sync-java/issues
Expand Down

0 comments on commit ee4dbca

Please sign in to comment.