Update docs

commercetools · Sep 7, 2023 · 5de344b · 5de344b
1 parent 0938b15
commit 5de344b
Show file tree

Hide file tree

Showing 33 changed files with 1,730 additions and 4,998 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,25 @@
 ![commercetools-java-sync-logos 002](https://user-images.githubusercontent.com/9512131/31182587-90d47f0a-a924-11e7-9716-66e6bec7f79b.png)
-# commercetools sync (version 10)
+# commercetools sync java
 [![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
 [![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
-[![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/)
+[![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/)
 [![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
 
 
-> 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).
-> 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).
+> 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).
+> 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).
 
 More at https://commercetools.github.io/commercetools-sync-java
 
 Java library which allows to import/synchronise (import changes) the data from any arbitrary source to commercetools project.
 
-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)
+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)
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Usage](#usage)
-  - [Quick Start](/docs/sdk2/usage/QUICK_START.md)
+  - [Quick Start](/docs/usage/QUICK_START.md)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
     - [Maven](#maven)
@@ -39,7 +39,7 @@ Notes:
 - 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.
 - During a synchronisation, resources are either created or updated, but **not** deleted.
 
-⚡ See the [Quick Start Guide](/docs/sdk2/usage/QUICK_START.md) for more information on building a product importer!
+⚡ See the [Quick Start Guide](/docs/usage/QUICK_START.md) for more information on building a product importer!
 
 ![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/3469524/126317637-a946a81c-2948-4751-86bb-02bcecfeca95.png)
 

diff --git a/docs/sdk2/MIGRATION_GUIDE.md → docs/MIGRATION_GUIDE.md b/docs/sdk2/MIGRATION_GUIDE.md → docs/MIGRATION_GUIDE.md
@@ -4,17 +4,17 @@
 
 - [Migration Guide](#migration-guide)
   - [Migrate syncers of supported resources](#migrate-syncers-of-supported-resources)
-    - [Categories](/docs/sdk2/usage/CATEGORY_SYNC.md#migration-guide), 
-    - [Products](/docs/sdk2/usage/PRODUCT_SYNC.md#migration-guide)
-    - [InventoryEntries](/docs/sdk2/usage/INVENTORY_SYNC.md#migration-guide)
-    - [ProductTypes](/docs/sdk2/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
-    - [Types](/docs/sdk2/usage/TYPE_SYNC.md#migration-guide)
-    - [CartDiscounts](/docs/sdk2/usage/CART_DISCOUNT_SYNC.md#migration-guide)
-    - [States](/docs/sdk2/usage/STATE_SYNC.md#migration-guide)
-    - [TaxCategories](/docs/sdk2/usage/TAX_CATEGORY_SYNC.md#migration-guide)
-    - [CustomObjects](/docs/sdk2/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
-    - [Customers](/docs/sdk2/usage/CUSTOMER_SYNC.md#migration-guide)
-    - [ShoppingLists](/docs/sdk2/usage/SHOPPING_LIST_SYNC.md#migration-guide)
+    - [Categories](/docs/usage/CATEGORY_SYNC.md#migration-guide), 
+    - [Products](/docs/usage/PRODUCT_SYNC.md#migration-guide)
+    - [InventoryEntries](/docs/usage/INVENTORY_SYNC.md#migration-guide)
+    - [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
+    - [Types](/docs/usage/TYPE_SYNC.md#migration-guide)
+    - [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md#migration-guide)
+    - [States](/docs/usage/STATE_SYNC.md#migration-guide)
+    - [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md#migration-guide)
+    - [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
+    - [Customers](/docs/usage/CUSTOMER_SYNC.md#migration-guide)
+    - [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md#migration-guide)
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 # Migration Guide
@@ -60,17 +60,17 @@ private static <T, S, U extends Collection<CompletableFuture<S>>> U mapValuesToF
 ```
 ## Migrate syncers of supported resources
 
-- [Categories](/docs/sdk2/usage/CATEGORY_SYNC.md#migration-guide), 
-- [Products](/docs/sdk2/usage/PRODUCT_SYNC.md#migration-guide)
-- [InventoryEntries](/docs/sdk2/usage/INVENTORY_SYNC.md#migration-guide)
-- [ProductTypes](/docs/sdk2/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
-- [Types](/docs/sdk2/usage/TYPE_SYNC.md#migration-guide)
-- [CartDiscounts](/docs/sdk2/usage/CART_DISCOUNT_SYNC.md#migration-guide)
-- [States](/docs/sdk2/usage/STATE_SYNC.md#migration-guide)
-- [TaxCategories](/docs/sdk2/usage/TAX_CATEGORY_SYNC.md#migration-guide)
-- [CustomObjects](/docs/sdk2/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
-- [Customers](/docs/sdk2/usage/CUSTOMER_SYNC.md#migration-guide)
-- [ShoppingLists](/docs/sdk2/usage/SHOPPING_LIST_SYNC.md#migration-guide)
+- [Categories](/docs/usage/CATEGORY_SYNC.md#migration-guide), 
+- [Products](/docs/usage/PRODUCT_SYNC.md#migration-guide)
+- [InventoryEntries](/docs/usage/INVENTORY_SYNC.md#migration-guide)
+- [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
+- [Types](/docs/usage/TYPE_SYNC.md#migration-guide)
+- [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md#migration-guide)
+- [States](/docs/usage/STATE_SYNC.md#migration-guide)
+- [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md#migration-guide)
+- [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
+- [Customers](/docs/usage/CUSTOMER_SYNC.md#migration-guide)
+- [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md#migration-guide)
 
 
 
diff --git a/docs/README.md b/docs/README.md
@@ -2,9 +2,9 @@
 # commercetools sync
 [![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
 [![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
-[![Benchmarks 9.2.3](https://img.shields.io/badge/Benchmarks-9.2.3-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
-[![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) 
-[![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/)
+[![Benchmarks 10.0.0](https://img.shields.io/badge/Benchmarks-10.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
+[![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) 
+[![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/)
 [![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
 
 
@@ -40,18 +40,18 @@ Here are the most popular ones:
 <dependency>
   <groupId>com.commercetools</groupId>
   <artifactId>commercetools-sync-java</artifactId>
-  <version>9.2.3</version>
+  <version>10.0.0</version>
 </dependency>
 ````
 #### Gradle
 ````groovy
-implementation 'com.commercetools:commercetools-sync-java:9.2.3'
+implementation 'com.commercetools:commercetools-sync-java:10.0.0'
 ````
 #### SBT 
 ````
-libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "9.2.3"
+libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "10.0.0"
 ````
 #### Ivy 
 ````xml
-<dependency org="com.commercetools" name="commercetools-sync-java" rev="9.2.3"/>
+<dependency org="com.commercetools" name="commercetools-sync-java" rev="10.0.0"/>
 ````
diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -27,6 +27,14 @@
 7. Add Migration guide section which specifies explicitly if there are breaking changes and how to tackle them.
 -->
 
+### 10.0.0-beta.1 - Sep 8, 2023
+[Commits](https://github.com/commercetools/commercetools-sync-java/compare/9.2.3...10.0.0) |
+[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/10.0.0/) |
+[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/10.0.0/jar)
+- 🚧 **Breaking Changes** (1)
+  - 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.
+
+
 ### 9.2.3 - Mar 21, 2023
 [Commits](https://github.com/commercetools/commercetools-sync-java/compare/9.2.1...9.2.3) |
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/9.2.3/) |