Skip to content

Commit 8279625

Browse files
committed
docs(bulk-model-sync-gradle): updated docs after renaming
1 parent f0849d2 commit 8279625

File tree

4 files changed

+9
-6
lines changed

4 files changed

+9
-6
lines changed
52.3 KB
Loading
-88.3 KB
Binary file not shown.

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
== Gradle Plugin for synchronizing models between model-api endpoints
2-
:navtitle: `model-sync-gradle`
2+
:navtitle: `bulk-model-sync-gradle`
33

44
:tip-caption: 🔗 Quick Links
55
[TIP]
@@ -9,16 +9,19 @@ https://github.com/modelix/modelix.core[Repository^] | https://github.com/modeli
99

1010
== Overview
1111

12-
The `model-sync` gradle plugin synchronizes models between `model-api` endpoints.
12+
The `bulk-model-sync` Gradle plugin synchronizes models between `model-api` endpoints.
1313
A common example would be synchronizing a local MPS project to a `model-server`.
1414

15-
image::model-sync-gradle.png[]
15+
IMPORTANT: For correct synchronization the used model-server is required to use IDs for roles. This can be achieved by starting the model-server with the `-useroleids` flag.
16+
17+
.Bulk Synchronization between MPS and model-server
18+
image::bulk-model-sync-gradle.overview.png[Bulk Synchronization between MPS and model-server]
1619

1720
It allows the definition of sync directions by specifying source and target endpoint.
1821
Based on these directions, Gradle tasks will be generated, which can be run to trigger the corresponding synchronization.
1922

20-
Internally, the node data will be bulk exported from the source endpoint and stored as json files.
21-
After that, those json files serve as a specification to incrementally update the target model through via the target `model-api` endpoint.
23+
Internally, the node data will be bulk exported from the source endpoint and stored as JSON files.
24+
After that, these JSON files serve as a specification to incrementally update the target model via the target `model-api` endpoint.
2225
This means that only a minimal amount of write operations is used to update the target model.
2326

2427
== Configuration settings

docs/global/modules/core/partials/nav-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
* xref:core:reference/component-metamodel-export.adoc[]
44
* xref:core:reference/component-model-api-gen.adoc[]
55
* xref:core:reference/component-model-api-gen-gradle.adoc[]
6-
* xref:core:reference/component-model-sync-gradle.adoc[]
6+
* xref:core:reference/component-bulk-model-sync-gradle.adoc[]
77
* xref:core:reference/component-light-model-client.adoc[]
88
* xref:core:reference/component-mps-model-server-plugin.adoc[]

0 commit comments

Comments
 (0)