docs(bulk-model-sync-gradle): add docs for bulk sync plugin

Author: mhuster23

docs/global/modules/core/images/model-sync-gradle.png

@@ -167,19 +167,19 @@ Inside the `metamodel` block a `names` block can be declared to configure `prefi
 |"N_"
 |""
 
-|`typedNodeImpl``
+|`typedNodeImpl`
 |"\_N_TypedImpl_"
 |""
 
 |`untypedConcept`
 |"\_C_UntypedImpl_"
 |""
 
-|`typedConcept``
+|`typedConcept`
 |"C_"
 |""
 
-|`typedConceptImpl``
+|`typedConceptImpl`
 |"\_C_TypedImpl_"
 |""
 

docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc

@@ -0,0 +1,142 @@
+== Gradle Plugin for synchronizing models between model-api endpoints
+:navtitle: `model-sync-gradle`
+
+:tip-caption: 🔗 Quick Links
+[TIP]
+--
+https://github.com/modelix/modelix.core[Repository^] | https://github.com/modelix/modelix.core/blob/main/model-sync-gradle/build.gradle.kts[buildfile^]
+--
+
+== Overview
+
+The `model-sync` gradle plugin synchronizes models between `model-api` endpoints.
+A common example would be synchronizing a local MPS project to a `model-server`.
+
+image::model-sync-gradle.png[]
+
+It allows the definition of sync directions by specifying source and target endpoint.
+Based on these directions, Gradle tasks will be generated, which can be run to trigger the corresponding synchronization.
+
+Internally, the node data will be bulk exported from the source endpoint and stored as json files.
+After that, those json files serve as a specification to incrementally update the target model through via the target `model-api` endpoint.
+This means that only a minimal amount of write operations is used to update the target model.
+
+== Configuration settings
+
+=== modelSync configuration
+[%header, cols="1,1,2"]
+|===
+|method
+|parameter type
+|description
+
+|`dependsOn`
+|Any
+|Adds the given task as a dependency of this task.
+
+|`direction`
+|String, Action<SyncDirection>
+|Defines a new sync direction with the given name.
+|===
+
+=== SyncDirection configuration
+[%header, cols="1,1,2"]
+|===
+|method
+|parameter type
+|description
+
+|`fromLocal`
+|Action<LocalSource>
+|Defines a local source (MPS).
+
+|`toModelServer`
+|Action<ServerTarget>
+|Defines a model-server target.
+
+|`fromModelServer`
+|Action<ServerSource>
+|Defines a model-server source.
+
+|`toLocal`
+|Action<LocalTarget>
+|Defines a local target (MPS).
+
+|`registerLanguage`
+|ILanguage
+|Registers the given language and all of its concepts for the synchronisation process.
+
+|`includeModule`
+|String
+|Includes the module specified by the given fully qualified name in the synchronisation process.
+|===
+
+=== LocalSource/-Target configuration
+[%header, cols="1,1,2"]
+|===
+|setting
+|type
+|description
+
+|`mpsHome`
+|File
+|Location of the MPS to be used for the sync.
+
+|`mpsHeapSize`
+|String
+|MPS heap size specified as a String, e.g. "2g" for 2GB (default: "2g")
+
+|`repositoryDir`
+|File
+|Directory in which the modules are stored.
+|===
+
+=== ServerSource/-Target configuration
+[%header, cols="1,1,2"]
+|===
+|setting
+|type
+|description
+
+|`url`
+|String
+|URL of the model-server API endpoint.
+
+|`repositoryId`
+|String
+|Id of the target/source model-server repository.
+
+|`branchName`
+|String
+|Name of the target/source model-server branch.
+
+|`revision`
+|String
+|Source model-server revision. Can be used instead of `repositoryId` and `branchName`. Only available in ServerSource.
+
+|===
+
+== Example
+
+[source,kotlin]
+--
+modelSync {
+    dependsOn(someOtherTask)
+    direction("pushToMyServer") {
+        registerLanguage(L_MyGeneratedLanguage)
+        includeModule("MySolution")
+        fromLocal {
+            mpsHome = buildDir.resolve("mps")
+            mpsHeapSize = "4g"
+            repositoryDir = projectDir.resolve("my-repo")
+        }
+        toModelServer {
+            url = "http://0.0.0.0:28101/v2"
+            repositoryId = "my-repo"
+            branchName = "dev"
+        }
+    }
+}
+--
+
+Generated gradle task to perform synchronization: `runSyncPushToMyServer`.

docs/global/modules/core/pages/reference/component-model-sync-gradle.adoc

@@ -3,5 +3,6 @@
 * xref:core:reference/component-metamodel-export.adoc[]
 * xref:core:reference/component-model-api-gen.adoc[]
 * xref:core:reference/component-model-api-gen-gradle.adoc[]
+* xref:core:reference/component-model-sync-gradle.adoc[]
 * xref:core:reference/component-light-model-client.adoc[]
 * xref:core:reference/component-mps-model-server-plugin.adoc[]