Skip to content

Commit f9e2a16

Browse files
committed
#1201 rename docs folder
1 parent 03cbf49 commit f9e2a16

29 files changed

+67
-67
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@
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/MIGRATION_GUIDE.md). The support for JVM SDK v1 has been discontinued with [commercetools-sync-java v9.2.3](https://github.com/commercetools/commercetools-sync-java/tree/9.2.3)
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](/doc/MIGRATION_GUIDE.md). The support for JVM SDK v1 has been discontinued with [commercetools-sync-java v9.2.3](https://github.com/commercetools/commercetools-sync-java/tree/9.2.3)
1010
> If migration isn't an option for you, you can still use deprecated versions of this library available at [Maven central](https://central.sonatype.com/artifact/com.commercetools/commercetools-sync-java/9.2.3).
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/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)
16+
Supported resources: [Categories](/doc/usage/CATEGORY_SYNC.md), [Products](/doc/usage/PRODUCT_SYNC.md), [InventoryEntries](/doc/usage/INVENTORY_SYNC.md), [ProductTypes](/doc/usage/PRODUCT_TYPE_SYNC.md), [Types](/doc/usage/TYPE_SYNC.md), [CartDiscounts](/doc/usage/CART_DISCOUNT_SYNC.md), [States](/doc/usage/STATE_SYNC.md), [TaxCategories](/doc/usage/TAX_CATEGORY_SYNC.md), [CustomObjects](/doc/usage/CUSTOM_OBJECT_SYNC.md), [Customers](/doc/usage/CUSTOMER_SYNC.md), [ShoppingLists](/doc/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/usage/QUICK_START.md)
22+
- [Quick Start](/doc/usage/QUICK_START.md)
2323
- [Prerequisites](#prerequisites)
2424
- [Installation](#installation)
2525
- [Maven](#maven)
2626
- [Gradle](#gradle)
2727
- [SBT](#sbt)
2828
- [Ivy](#ivy)
29-
- [Release Notes](/docs/RELEASE_NOTES.md)
29+
- [Release Notes](/doc/RELEASE_NOTES.md)
3030

3131
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3232
## Usage
@@ -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/usage/QUICK_START.md) for more information on building a product importer!
42+
⚡ See the [Quick Start Guide](/doc/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

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# Building the Documentation Pages
2-
3-
The documentation pages are published here: https://commercetools.github.io/commercetools-sync-java
4-
5-
* [mkdocs documentation](http://mkdocs.org).
6-
* [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/).
7-
8-
9-
## Project layout
10-
11-
mkdocs.yml # The configuration file.
12-
docs/
13-
index.md # The documentation homepage.
14-
... # Other markdown pages, images and other files.
15-
16-
## Gradle tasks
17-
18-
* `mkdocsInit` - Create new mkdocs site (like this).
19-
* `mkdocsBuild` - Build the documentation site.
20-
* `mkdocsServe` - Start the live-reloading docs server.
21-
* `mkdocsPublish` - Publish generated site version to github pages.
22-
23-
## Mkdocs native Commands
24-
25-
* `mkdocs new [dir-name]` - Create a new project.
26-
* `mkdocs serve` - Start the live-reloading docs server.
27-
* `mkdocs build` - Build the documentation site.
1+
# Building the Documentation Pages
2+
3+
The documentation pages are published here: https://commercetools.github.io/commercetools-sync-java
4+
5+
* [mkdocs documentation](http://mkdocs.org).
6+
* [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/).
7+
8+
9+
## Project layout
10+
11+
mkdocs.yml # The configuration file.
12+
docs/
13+
index.md # The documentation homepage.
14+
... # Other markdown pages, images and other files.
15+
16+
## Gradle tasks
17+
18+
* `mkdocsInit` - Create new mkdocs site (like this).
19+
* `mkdocsBuild` - Build the documentation site.
20+
* `mkdocsServe` - Start the live-reloading docs server.
21+
* `mkdocsPublish` - Publish generated site version to github pages.
22+
23+
## Mkdocs native Commands
24+
25+
* `mkdocs new [dir-name]` - Create a new project.
26+
* `mkdocs serve` - Start the live-reloading docs server.
27+
* `mkdocs build` - Build the documentation site.
2828
* `mkdocs help` - Print this help message.

docs/MIGRATION_GUIDE.md renamed to doc/MIGRATION_GUIDE.md

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/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)
7+
- [Categories](/doc/usage/CATEGORY_SYNC.md#migration-guide),
8+
- [Products](/doc/usage/PRODUCT_SYNC.md#migration-guide)
9+
- [InventoryEntries](/doc/usage/INVENTORY_SYNC.md#migration-guide)
10+
- [ProductTypes](/doc/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
11+
- [Types](/doc/usage/TYPE_SYNC.md#migration-guide)
12+
- [CartDiscounts](/doc/usage/CART_DISCOUNT_SYNC.md#migration-guide)
13+
- [States](/doc/usage/STATE_SYNC.md#migration-guide)
14+
- [TaxCategories](/doc/usage/TAX_CATEGORY_SYNC.md#migration-guide)
15+
- [CustomObjects](/doc/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
16+
- [Customers](/doc/usage/CUSTOMER_SYNC.md#migration-guide)
17+
- [ShoppingLists](/doc/usage/SHOPPING_LIST_SYNC.md#migration-guide)
1818
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1919

2020
# Migration Guide
@@ -66,17 +66,17 @@ private static <T, S, U extends Collection<CompletableFuture<S>>> U mapValuesToF
6666
```
6767
## Migrate syncers of supported resources
6868

69-
- [Categories](/docs/usage/CATEGORY_SYNC.md#migration-guide),
70-
- [Products](/docs/usage/PRODUCT_SYNC.md#migration-guide)
71-
- [InventoryEntries](/docs/usage/INVENTORY_SYNC.md#migration-guide)
72-
- [ProductTypes](/docs/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
73-
- [Types](/docs/usage/TYPE_SYNC.md#migration-guide)
74-
- [CartDiscounts](/docs/usage/CART_DISCOUNT_SYNC.md#migration-guide)
75-
- [States](/docs/usage/STATE_SYNC.md#migration-guide)
76-
- [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md#migration-guide)
77-
- [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
78-
- [Customers](/docs/usage/CUSTOMER_SYNC.md#migration-guide)
79-
- [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md#migration-guide)
69+
- [Categories](/doc/usage/CATEGORY_SYNC.md#migration-guide),
70+
- [Products](/doc/usage/PRODUCT_SYNC.md#migration-guide)
71+
- [InventoryEntries](/doc/usage/INVENTORY_SYNC.md#migration-guide)
72+
- [ProductTypes](/doc/usage/PRODUCT_TYPE_SYNC.md#migration-guide)
73+
- [Types](/doc/usage/TYPE_SYNC.md#migration-guide)
74+
- [CartDiscounts](/doc/usage/CART_DISCOUNT_SYNC.md#migration-guide)
75+
- [States](/doc/usage/STATE_SYNC.md#migration-guide)
76+
- [TaxCategories](/doc/usage/TAX_CATEGORY_SYNC.md#migration-guide)
77+
- [CustomObjects](/doc/usage/CUSTOM_OBJECT_SYNC.md#migration-guide)
78+
- [Customers](/doc/usage/CUSTOMER_SYNC.md#migration-guide)
79+
- [ShoppingLists](/doc/usage/SHOPPING_LIST_SYNC.md#migration-guide)
8080

8181

8282

File renamed without changes.

docs/RELEASE_NOTES.md renamed to doc/RELEASE_NOTES.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@
549549
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/2.1.0/) |
550550
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/2.1.0/jar)
551551
- 🎉 **New Features** (2)
552-
- **CustomObject Sync** - Added support for syncing custom objects between ctp projects. [#565](https://github.com/commercetools/commercetools-sync-java/issues/565) For more info how to use it please refer to [CustomObject usage doc](/docs/usage/CUSTOM_OBJECT_SYNC.md).
552+
- **CustomObject Sync** - Added support for syncing custom objects between ctp projects. [#565](https://github.com/commercetools/commercetools-sync-java/issues/565) For more info how to use it please refer to [CustomObject usage doc](/doc/usage/CUSTOM_OBJECT_SYNC.md).
553553
- **CustomObject Sync** - Exposed `CustomObjectSyncUtils#hasIdenticalValue` which determines whether update process is required after comparing a `CustomObject` and a `CustomObjectDraft`. [#565](https://github.com/commercetools/commercetools-sync-java/issues/565)
554554

555555
- 🛠️ **Dependency Updates** (3)
@@ -603,10 +603,10 @@
603603
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/1.9.0/jar)
604604

605605
- 🎉 **New Features** (6)
606-
- **TaxCategory Sync** - Added support for syncing tax categories. [#417](https://github.com/commercetools/commercetools-sync-java/issues/417) For more info how to use it please refer to [TaxCategory usage doc](/docs/usage/TAX_CATEGORY_SYNC.md).
606+
- **TaxCategory Sync** - Added support for syncing tax categories. [#417](https://github.com/commercetools/commercetools-sync-java/issues/417) For more info how to use it please refer to [TaxCategory usage doc](/doc/usage/TAX_CATEGORY_SYNC.md).
607607
- **TaxCategory Sync** - Exposed `TaxCategorySyncUtils#buildActions` which calculates all needed update actions after comparing a `TaxCategory` and a `TaxCategoryDraft`. [#417](https://github.com/commercetools/commercetools-sync-java/issues/417)
608608
- **TaxCategory Sync** - Exposed `TaxCategoryUpdateActionUtils` which contains utils for calculating needed update actions after comparing individual fields of a `TaxCategory` and a `TaxCategoryDraft`. [#417](https://github.com/commercetools/commercetools-sync-java/issues/417)
609-
- **State Sync** - Added support for syncing states. [#409](https://github.com/commercetools/commercetools-sync-java/issues/409) For more info how to use it please refer to [States usage doc](/docs/usage/STATE_SYNC.md).
609+
- **State Sync** - Added support for syncing states. [#409](https://github.com/commercetools/commercetools-sync-java/issues/409) For more info how to use it please refer to [States usage doc](/doc/usage/STATE_SYNC.md).
610610
- **State Sync** - Exposed `StateSyncUtils#buildActions` which calculates all needed update actions after comparing a `State` and a `StateDraft`. [#409](https://github.com/commercetools/commercetools-sync-java/issues/409)
611611
- **State Sync** - Exposed `StateUpdateActionUtils` which contains utils for calculating needed update actions after comparing individual fields of a `State` and a `StateDraft`. [#409](https://github.com/commercetools/commercetools-sync-java/issues/409)
612612
Thanks, @jarzynp for the contributions!
@@ -786,7 +786,7 @@ failed fetches of missing references. [#426](https://github.com/commercetools/co
786786
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/1.3.0/jar)
787787

788788
- 🎉 **New Features** (6)
789-
- **CartDiscount Sync** - Added support for syncing cart discounts. [#379](https://github.com/commercetools/commercetools-sync-java/issues/379) For more info how to use it please refer to [CartDiscount usage doc](/docs/usage/CART_DISCOUNT_SYNC.md).
789+
- **CartDiscount Sync** - Added support for syncing cart discounts. [#379](https://github.com/commercetools/commercetools-sync-java/issues/379) For more info how to use it please refer to [CartDiscount usage doc](/doc/usage/CART_DISCOUNT_SYNC.md).
790790
- **CartDiscount Sync** - Introduced the new `CartDiscountSyncUtils#buildActions` which calculates all needed update actions after comparing a `CartDiscount` and a `CartDiscountDraft`. [#379](https://github.com/commercetools/commercetools-sync-java/issues/379)
791791
- **CartDiscount Sync** - Introduced the new `CartDiscountUpdateActionUtils` which contains utils for calculating needed update actions after comparing individual fields of a `CartDiscount` and a `CartDiscountDraft`. [#379](https://github.com/commercetools/commercetools-sync-java/issues/379)
792792
- **CartDiscount Sync** - Introduced the new `CartDiscountReferenceResolver` which resolves custom type references on CartDiscountDrafts. [#379](https://github.com/commercetools/commercetools-sync-java/issues/379)
@@ -871,7 +871,7 @@ failed fetches of missing references. [#426](https://github.com/commercetools/co
871871

872872
- 📋 **Documentation** (2)
873873
- **Commons** - Added link to [documentation pages](https://commercetools.github.io/commercetools-sync-java) in README of the github repo.
874-
- **Commons** - Fixed link of [`beforeUpdateCallback` for keeping other variants](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/products/templates/beforeupdatecallback/KeepOtherVariantsSyncIT.java) example in the [Sync Options](/docs/usage/SYNC_OPTIONS.md) doc page. [#360](https://github.com/commercetools/commercetools-sync-java/issues/360)
874+
- **Commons** - Fixed link of [`beforeUpdateCallback` for keeping other variants](https://github.com/commercetools/commercetools-sync-java/tree/master/src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/products/templates/beforeupdatecallback/KeepOtherVariantsSyncIT.java) example in the [Sync Options](/doc/usage/SYNC_OPTIONS.md) doc page. [#360](https://github.com/commercetools/commercetools-sync-java/issues/360)
875875

876876
### 1.0.0 - Dec 10, 2018
877877
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/v1.0.0-M14...1.0.0) |
@@ -892,7 +892,7 @@ the library. `1.0.0` is here for you to use with all new features, enhancements
892892
##### Full Release Notes
893893

894894
- 🎉 **New Features** (4)
895-
- **Type Sync** - Added support for syncing types. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300) For more info how to use it please refer to [Type usage doc](/docs/usage/TYPE_SYNC.md).
895+
- **Type Sync** - Added support for syncing types. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300) For more info how to use it please refer to [Type usage doc](/doc/usage/TYPE_SYNC.md).
896896
- **Type Sync** - Exposed `TypeSyncUtils#buildActions` which calculates all needed update actions after comparing a `Type` and a `TypeDraft`. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300)
897897
- **Type Sync** - Exposed `TypeUpdateActionUtils` which contains utils for calculating needed update actions after comparing individual fields of a `Type` and a `TypeDraft`. [#300](https://github.com/commercetools/commercetools-sync-java/issues/300)
898898
- **Commons** - Added `OptionalUtils#filterEmptyOptionals` which are utility methods that filter out the empty optionals in a supplied list (with a varargs variation) returning a list of the contents of the non-empty
@@ -938,8 +938,8 @@ the library. `1.0.0` is here for you to use with all new features, enhancements
938938

939939
- 📋 **Documentation** (4)
940940
- **Commons** - Added the documentation github pages. https://commercetools.github.io/commercetools-sync-java
941-
- **Commons** - Added a [Quick Start Guide](/docs/usage/QUICK_START.md) for a convenient entry into the library.
942-
- **Commons** - Moved documentation of sync options to a separate [doc](/docs/usage/SYNC_OPTIONS.md).
941+
- **Commons** - Added a [Quick Start Guide](/doc/usage/QUICK_START.md) for a convenient entry into the library.
942+
- **Commons** - Moved documentation of sync options to a separate [doc](/doc/usage/SYNC_OPTIONS.md).
943943
- **Commons** - Added a the earliest compatible version of the commercetools-jvm-sdk](https://github.com/commercetools/commercetools-jvm-sdk) as a prerequisite for using the library.
944944

945945
### v1.0.0-M14 - Oct 5, 2018
@@ -971,7 +971,7 @@ the library. `1.0.0` is here for you to use with all new features, enhancements
971971
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/v1.0.0-M13/jar)
972972

973973
- 🎉 **New Features** (15)
974-
- **ProductType Sync** - Support for syncing productTypes. [#286](https://github.com/commercetools/commercetools-sync-java/issues/286) For more info how to use it please refer to [ProductType usage doc](/docs/usage/PRODUCT_TYPE_SYNC.md).
974+
- **ProductType Sync** - Support for syncing productTypes. [#286](https://github.com/commercetools/commercetools-sync-java/issues/286) For more info how to use it please refer to [ProductType usage doc](/doc/usage/PRODUCT_TYPE_SYNC.md).
975975
- **Product Sync** - Support for syncing product prices. [#101](https://github.com/commercetools/commercetools-sync-java/issues/101)
976976
- **Product Sync** - `ProductSyncUtils#buildActions` now also calculates variants' all price update actions needed. [#101](https://github.com/commercetools/commercetools-sync-java/issues/101)
977977
- **Product Sync** - `ProductUpdateActionUtils#buildVariantsUpdateActions` now also calculates variants' all price update actions needed. [#101](https://github.com/commercetools/commercetools-sync-java/issues/101)
@@ -1074,7 +1074,7 @@ only be triggered on the full build. [#249](https://github.com/commercetools/com
10741074
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/v1.0.0-M10/jar)
10751075

10761076
- 🎉 **New Features** (1)
1077-
- **Commons** - Added [benchmarking setup](/docs/BENCHMARKS.md) for the library on every release. [#155](https://github.com/commercetools/commercetools-sync-java/issues/155)
1077+
- **Commons** - Added [benchmarking setup](/doc/BENCHMARKS.md) for the library on every release. [#155](https://github.com/commercetools/commercetools-sync-java/issues/155)
10781078

10791079
- **Changes** (3)
10801080
- **Commons** - Statistics counters are now of type `AtomicInteger` instead of int to support concurrency. [#242](https://github.com/commercetools/commercetools-sync-java/issues/242)
@@ -1146,7 +1146,7 @@ only be triggered on the full build. [#249](https://github.com/commercetools/com
11461146
- **Commons** - Fixed library version in User-Agent headers of JVM SDK clients using the library. [#191](https://github.com/commercetools/commercetools-sync-java/issues/191)
11471147

11481148
- 📋 **Documentation** (1)
1149-
- **Commons** - Added [Code of Conduct](/docs/CODE_OF_CONDUCT.md) doc.
1149+
- **Commons** - Added [Code of Conduct](/doc/CODE_OF_CONDUCT.md) doc.
11501150

11511151
- 🚧 **Migration guide** (6)
11521152
- **Product Sync** - Removed `removeOtherVariants` option which is already done by the sync by default. Removal of
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)