Skip to content

Commit 5de344b

Browse files
committed
Update docs
1 parent 0938b15 commit 5de344b

33 files changed

+1730
-4998
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
![commercetools-java-sync-logos 002](https://user-images.githubusercontent.com/9512131/31182587-90d47f0a-a924-11e7-9716-66e6bec7f79b.png)
2-
# commercetools sync (version 10)
2+
# commercetools sync java
33
[![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
44
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
5-
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/9.2.3/)
5+
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/10.0.0/)
66
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
77

88

9-
> Note: The current version of this library uses [JVM-SDK-V2](http://commercetools.github.io/commercetools-sdk-java-v2). This doc already contains updated information. Please migrate to this version, using our [Migration Guide](/docs/sdk2/MIGRATION_GUIDE.md).
10-
> If migration isn't an option for you, you can still use deprecated versions of this library available at [Maven central](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/9.2.3/jar).
9+
> Note: The current version of this library uses [JVM-SDK-V2](http://commercetools.github.io/commercetools-sdk-java-v2). This doc already contains updated information. Please migrate to this version, using our [Migration Guide](/docs/MIGRATION_GUIDE.md).
10+
> If migration isn't an option for you, you can still use deprecated versions of this library available at [Maven central](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/10.0.0/jar).
1111
1212
More at https://commercetools.github.io/commercetools-sync-java
1313

1414
Java library which allows to import/synchronise (import changes) the data from any arbitrary source to commercetools project.
1515

16-
Supported resources: [Categories](/docs/sdk2/usage/CATEGORY_SYNC.md), [Products](/docs/sdk2/usage/PRODUCT_SYNC.md), [InventoryEntries](/docs/sdk2/usage/INVENTORY_SYNC.md), [ProductTypes](/docs/sdk2/usage/PRODUCT_TYPE_SYNC.md), [Types](/docs/sdk2/usage/TYPE_SYNC.md), [CartDiscounts](/docs/sdk2/usage/CART_DISCOUNT_SYNC.md), [States](/docs/sdk2/usage/STATE_SYNC.md), [TaxCategories](/docs/sdk2/usage/TAX_CATEGORY_SYNC.md), [CustomObjects](/docs/sdk2/usage/CUSTOM_OBJECT_SYNC.md), [Customers](/docs/sdk2/usage/CUSTOMER_SYNC.md), [ShoppingLists](/docs/sdk2/usage/SHOPPING_LIST_SYNC.md)
16+
Supported resources: [Categories](/docs/usage/CATEGORY_SYNC.md), [Products](/docs/usage/PRODUCT_SYNC.md), [InventoryEntries](/docs/usage/INVENTORY_SYNC.md), [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md), [Types](/docs/usage/TYPE_SYNC.md), [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md), [States](/docs/usage/STATE_SYNC.md), [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md), [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md), [Customers](/docs/usage/CUSTOMER_SYNC.md), [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md)
1717

1818
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1919
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2020

2121
- [Usage](#usage)
22-
- [Quick Start](/docs/sdk2/usage/QUICK_START.md)
22+
- [Quick Start](/docs/usage/QUICK_START.md)
2323
- [Prerequisites](#prerequisites)
2424
- [Installation](#installation)
2525
- [Maven](#maven)
@@ -39,7 +39,7 @@ Notes:
3939
- There is dockerized ready-to-use CLI application [commercetools-project-sync](https://github.com/commercetools/commercetools-project-sync) which based on this library can synchronize entire data catalogue between the 2 commercetools projects.
4040
- During a synchronisation, resources are either created or updated, but **not** deleted.
4141

42-
⚡ See the [Quick Start Guide](/docs/sdk2/usage/QUICK_START.md) for more information on building a product importer!
42+
⚡ See the [Quick Start Guide](/docs/usage/QUICK_START.md) for more information on building a product importer!
4343

4444
![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/3469524/126317637-a946a81c-2948-4751-86bb-02bcecfeca95.png)
4545

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
- [Migration Guide](#migration-guide)
66
- [Migrate syncers of supported resources](#migrate-syncers-of-supported-resources)
7-
- [Categories](/docs/sdk2/usage/CATEGORY_SYNC.md#migration-guide),
8-
- [Products](/docs/sdk2/usage/PRODUCT_SYNC.md#migration-guide)
9-
- [InventoryEntries](/docs/sdk2/usage/INVENTORY_SYNC.md#migration-guide)
10-
- [ProductTypes](/docs/sdk2/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
11-
- [Types](/docs/sdk2/usage/TYPE_SYNC.md#migration-guide)
12-
- [CartDiscounts](/docs/sdk2/usage/CART_DISCOUNT_SYNC.md#migration-guide)
13-
- [States](/docs/sdk2/usage/STATE_SYNC.md#migration-guide)
14-
- [TaxCategories](/docs/sdk2/usage/TAX_CATEGORY_SYNC.md#migration-guide)
15-
- [CustomObjects](/docs/sdk2/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
16-
- [Customers](/docs/sdk2/usage/CUSTOMER_SYNC.md#migration-guide)
17-
- [ShoppingLists](/docs/sdk2/usage/SHOPPING_LIST_SYNC.md#migration-guide)
7+
- [Categories](/docs/usage/CATEGORY_SYNC.md#migration-guide),
8+
- [Products](/docs/usage/PRODUCT_SYNC.md#migration-guide)
9+
- [InventoryEntries](/docs/usage/INVENTORY_SYNC.md#migration-guide)
10+
- [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
11+
- [Types](/docs/usage/TYPE_SYNC.md#migration-guide)
12+
- [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md#migration-guide)
13+
- [States](/docs/usage/STATE_SYNC.md#migration-guide)
14+
- [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md#migration-guide)
15+
- [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
16+
- [Customers](/docs/usage/CUSTOMER_SYNC.md#migration-guide)
17+
- [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md#migration-guide)
1818
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1919

2020
# Migration Guide
@@ -60,17 +60,17 @@ private static <T, S, U extends Collection<CompletableFuture<S>>> U mapValuesToF
6060
```
6161
## Migrate syncers of supported resources
6262

63-
- [Categories](/docs/sdk2/usage/CATEGORY_SYNC.md#migration-guide),
64-
- [Products](/docs/sdk2/usage/PRODUCT_SYNC.md#migration-guide)
65-
- [InventoryEntries](/docs/sdk2/usage/INVENTORY_SYNC.md#migration-guide)
66-
- [ProductTypes](/docs/sdk2/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
67-
- [Types](/docs/sdk2/usage/TYPE_SYNC.md#migration-guide)
68-
- [CartDiscounts](/docs/sdk2/usage/CART_DISCOUNT_SYNC.md#migration-guide)
69-
- [States](/docs/sdk2/usage/STATE_SYNC.md#migration-guide)
70-
- [TaxCategories](/docs/sdk2/usage/TAX_CATEGORY_SYNC.md#migration-guide)
71-
- [CustomObjects](/docs/sdk2/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
72-
- [Customers](/docs/sdk2/usage/CUSTOMER_SYNC.md#migration-guide)
73-
- [ShoppingLists](/docs/sdk2/usage/SHOPPING_LIST_SYNC.md#migration-guide)
63+
- [Categories](/docs/usage/CATEGORY_SYNC.md#migration-guide),
64+
- [Products](/docs/usage/PRODUCT_SYNC.md#migration-guide)
65+
- [InventoryEntries](/docs/usage/INVENTORY_SYNC.md#migration-guide)
66+
- [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
67+
- [Types](/docs/usage/TYPE_SYNC.md#migration-guide)
68+
- [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md#migration-guide)
69+
- [States](/docs/usage/STATE_SYNC.md#migration-guide)
70+
- [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md#migration-guide)
71+
- [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
72+
- [Customers](/docs/usage/CUSTOMER_SYNC.md#migration-guide)
73+
- [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md#migration-guide)
7474

7575

7676

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# commercetools sync
33
[![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
44
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
5-
[![Benchmarks 9.2.3](https://img.shields.io/badge/Benchmarks-9.2.3-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6-
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-9.2.3-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/9.2.3/jar)
7-
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/9.2.3/)
5+
[![Benchmarks 10.0.0](https://img.shields.io/badge/Benchmarks-10.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6+
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-10.0.0-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/10.0.0/jar)
7+
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/10.0.0/)
88
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
99

1010

@@ -40,18 +40,18 @@ Here are the most popular ones:
4040
<dependency>
4141
<groupId>com.commercetools</groupId>
4242
<artifactId>commercetools-sync-java</artifactId>
43-
<version>9.2.3</version>
43+
<version>10.0.0</version>
4444
</dependency>
4545
````
4646
#### Gradle
4747
````groovy
48-
implementation 'com.commercetools:commercetools-sync-java:9.2.3'
48+
implementation 'com.commercetools:commercetools-sync-java:10.0.0'
4949
````
5050
#### SBT
5151
````
52-
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "9.2.3"
52+
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "10.0.0"
5353
````
5454
#### Ivy
5555
````xml
56-
<dependency org="com.commercetools" name="commercetools-sync-java" rev="9.2.3"/>
56+
<dependency org="com.commercetools" name="commercetools-sync-java" rev="10.0.0"/>
5757
````

docs/RELEASE_NOTES.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@
2727
7. Add Migration guide section which specifies explicitly if there are breaking changes and how to tackle them.
2828
-->
2929

30+
### 10.0.0-beta.1 - Sep 8, 2023
31+
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/9.2.3...10.0.0) |
32+
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/10.0.0/) |
33+
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/10.0.0/jar)
34+
- 🚧 **Breaking Changes** (1)
35+
- commercetools-sync-java is now fully migrated to `commercetools-sdk-java-v2`. See [Migration Guide](./MIGRATION_GUIDE.md) on how to use this library version.
36+
37+
3038
### 9.2.3 - Mar 21, 2023
3139
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/9.2.1...9.2.3) |
3240
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/9.2.3/) |

0 commit comments

Comments
 (0)