diff --git a/SPINE_RELEASE.md b/SPINE_RELEASE.md index dbf5927..8d7c4cd 100644 --- a/SPINE_RELEASE.md +++ b/SPINE_RELEASE.md @@ -137,7 +137,7 @@ use `{{% version %}}` shortcode: ```markdown [CoreJvm]({{% version %}}) -[CoreJvm {{% version %}}]({{% get-site-data "spine.core_jvm_repo" %}}/index.html) +[CoreJvm {{% version %}}]({{% get-site-data "repositories.core_jvm_repo" %}}/index.html) ``` Will be rendered as: @@ -150,8 +150,8 @@ Will be rendered as: Where: -* {{% get-site-data "spine.core_jvm_repo" %}} will apply the `core_jvm_repo` - from the `data/spine.yml` file. +* {{% get-site-data "repositories.core_jvm_repo" %}} will apply the `core_jvm_repo` + from the `site-commons` -> `data/repositories.yml` file. * {{% version %}} adds the full version of the current page -> `1.9.0`, or `2.0.0`. To provide a specific version for example in FAQ or Release Notes, use: diff --git a/docs/content/docs/1/_index.md b/docs/content/docs/1/_index.md index 6fcdd2e..f958bd7 100644 --- a/docs/content/docs/1/_index.md +++ b/docs/content/docs/1/_index.md @@ -12,7 +12,7 @@ the overview of the documentation sections. ## [Quick Start](docs/quick-start/) In this section you can learn what it's like to develop with Spine by going -through the code of the [Hello World]({{% get-site-data "spine.examples" %}}/hello/) +through the code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello/) example. ## [Introduction](docs/introduction/) @@ -31,7 +31,7 @@ This sections provides links to the generated documentation. ## [Examples](docs/examples/) This page is the entry point for learning from the code of -the [example applications]({{% get-site-data "spine.examples" %}}). +the [example applications]({{% get-site-data "repositories.examples" %}}). ## [DDD Resources](docs/resources/) A brief selection of learning materials we recommend to the colleagues in DDD. diff --git a/docs/content/docs/1/client-libs/_index.md b/docs/content/docs/1/client-libs/_index.md index 66e4f26..f35ba9f 100755 --- a/docs/content/docs/1/client-libs/_index.md +++ b/docs/content/docs/1/client-libs/_index.md @@ -5,5 +5,5 @@ headline: Documentation # Java Client Library - * [Reference documentation]({{% get-site-data "spine.core_api_doc" %}}/client/) - * [Source code]({{% get-site-data "spine.core_jvm_repo" %}}/tree/master/client/) + * [Reference documentation]({{% get-site-data "repositories.core_api_doc" %}}/client/) + * [Source code]({{% get-site-data "repositories.core_jvm_repo" %}}/tree/master/client/) diff --git a/docs/content/docs/1/client-libs/dart.md b/docs/content/docs/1/client-libs/dart.md index f43d31c..e52e6f8 100755 --- a/docs/content/docs/1/client-libs/dart.md +++ b/docs/content/docs/1/client-libs/dart.md @@ -4,5 +4,5 @@ headline: Documentation --- # Dart Client Library - * [Reference documentation]({{% get-site-data "spine.dart_api_doc" %}}/client/) - * [Source code]({{% get-site-data "spine.dart_repo" %}}/tree/master/client/) + * [Reference documentation]({{% get-site-data "repositories.dart_api_doc" %}}/client/) + * [Source code]({{% get-site-data "repositories.dart_repo" %}}/tree/master/client/) diff --git a/docs/content/docs/1/client-libs/js.md b/docs/content/docs/1/client-libs/js.md index 21dbf0b..57e7863 100755 --- a/docs/content/docs/1/client-libs/js.md +++ b/docs/content/docs/1/client-libs/js.md @@ -5,5 +5,5 @@ headline: Documentation # JavaScript Client Library - * [Reference documentation]({{% get-site-data "spine.js_api_doc" %}}) - * [Source code]({{% get-site-data "spine.web_repo" %}}/tree/master/client-js/) + * [Reference documentation]({{% get-site-data "repositories.js_api_doc" %}}) + * [Source code]({{% get-site-data "repositories.web_repo" %}}/tree/master/client-js/) diff --git a/docs/content/docs/1/examples/_index.md b/docs/content/docs/1/examples/_index.md index bc7063f..c8cee6b 100755 --- a/docs/content/docs/1/examples/_index.md +++ b/docs/content/docs/1/examples/_index.md @@ -4,7 +4,7 @@ headline: Spine Examples --- {{% note-block class="lead" %}} -Examples are available through the [Spine Examples]({{% get-site-data "spine.examples" %}}) +Examples are available through the [Spine Examples]({{% get-site-data "repositories.examples" %}}) GitHub organization. {{% /note-block %}} @@ -12,23 +12,23 @@ Please see the selected list of the examples with the descriptions below. ## Java -- [Hello World]({{% get-site-data "spine.examples" %}}/hello/) — a minimal +- [Hello World]({{% get-site-data "repositories.examples" %}}/hello/) — a minimal client-server solution described in the [Quick Start](docs/quick-start/) guide. -- [Blog]({{% get-site-data "spine.examples" %}}/blog/) — shows server-side +- [Blog]({{% get-site-data "repositories.examples" %}}/blog/) — shows server-side functionality of a simple blog. -- [Kanban]({{% get-site-data "spine.examples" %}}/kanban/) — shows orchestrating +- [Kanban]({{% get-site-data "repositories.examples" %}}/kanban/) — shows orchestrating Aggregates using Process Managers. -- [Airport]({{% get-site-data "spine.examples" %}}/airport/) — integrating +- [Airport]({{% get-site-data "repositories.examples" %}}/airport/) — integrating a third-party systems using a Bounded Context. This example accompanies the [“Integration with a Third Party”](docs/guides/integration/) guide. -- [To-Do List]({{% get-site-data "spine.examples" %}}/todo-list/) — a simple +- [To-Do List]({{% get-site-data "repositories.examples" %}}/todo-list/) — a simple task management system with multiple client applications. If you want to see a bigger picture of a Spine-based solution, have a look at this example. ## JavaScript -- [Simple HTML/JS To-Do List client]({{% get-site-data "spine.examples" %}}/todo-list/tree/master/client/html-js/) +- [Simple HTML/JS To-Do List client]({{% get-site-data "repositories.examples" %}}/todo-list/tree/master/client/html-js/) — a client app with very basic features. -- [To-Do List client on Angular]({{% get-site-data "spine.examples" %}}/todo-list/tree/master/client/angular/) +- [To-Do List client on Angular]({{% get-site-data "repositories.examples" %}}/todo-list/tree/master/client/angular/) — a more featured client built with Angular 10. diff --git a/docs/content/docs/1/guides/gradle.md b/docs/content/docs/1/guides/gradle.md index 4d3dbba..a15e3e4 100755 --- a/docs/content/docs/1/guides/gradle.md +++ b/docs/content/docs/1/guides/gradle.md @@ -158,8 +158,8 @@ Spine Model Compiler is a Gradle plugin which executes all the code generation r Gradle tasks as well as the `modelCompiler { }` extension, which allows you to configure those tasks. -See the API reference for the list of the [declared tasks]({{% get-site-data "spine.base_api_doc" %}}/plugin-base/plugin-base/io.spine.tools.gradle/-model-compiler-task-name/) -and the [codegen configuration options]({{% get-site-data "spine.base_api_doc" %}}/model-compiler/model-compiler/io.spine.tools.gradle.compiler/-extension/) +See the API reference for the list of the [declared tasks]({{% get-site-data "repositories.base_api_doc" %}}/plugin-base/plugin-base/io.spine.tools.gradle/-model-compiler-task-name/) +and the [codegen configuration options]({{% get-site-data "repositories.base_api_doc" %}}/model-compiler/model-compiler/io.spine.tools.gradle.compiler/-extension/) ### ProtoJS Plugin @@ -168,5 +168,5 @@ The plugin adds the `generateJsonParsers` task, which appends generated JS files Protobuf messages out of plain JS objects. The plugin also provides the `protoJs { }` extension, which allows you to configure JS code -generation. See the [API reference]({{% get-site-data "spine.base_api_doc" %}}/proto-js-plugin/proto-js-plugin/io.spine.js.gradle/-extension/) +generation. See the [API reference]({{% get-site-data "repositories.base_api_doc" %}}/proto-js-plugin/proto-js-plugin/io.spine.js.gradle/-extension/) for more info. diff --git a/docs/content/docs/1/guides/integration.md b/docs/content/docs/1/guides/integration.md index 97413a6..0e90a31 100755 --- a/docs/content/docs/1/guides/integration.md +++ b/docs/content/docs/1/guides/integration.md @@ -86,7 +86,7 @@ parse and validate domain Events, which we then publish to a Bounded Context, im The Event Consumer, as depicted above, implements the Event transformation logic. In order to establish this communication channel, the **Airplane Supplies** system declares a [gRPC](https://grpc.io/) -service. In [`supplies_service.proto`]({{% get-site-data "spine.examples" %}}/airport/blob/master/airplane-supplies/src/main/proto/spine/example/airport/supplies/supplies_service.proto): +service. In [`supplies_service.proto`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/airplane-supplies/src/main/proto/spine/example/airport/supplies/supplies_service.proto): @@ -161,7 +161,7 @@ public void onNext(SuppliesEvent event) { context.emittedEvent(eventMessage, actorContext); } ``` -The [`AircraftAggregate`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/AircraftAggregate.java) +The [`AircraftAggregate`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/AircraftAggregate.java) reacts on those events. Note that all the events published through `ThirdPartyContext` are always `external`, so should be the subscriber and reactor methods. @@ -194,8 +194,8 @@ the Customer/Supplier, **Takeoffs and Landings** Context is downstream from anot case from **Weather**. Unlike the Customer/Supplier, **Weather** does not provide a specific Event Producer, which would adapt **Weather** Events to the needs of **Takeoffs and Landings**. Also, the Event Consumer on the **Takeoffs and Landings** side is rather thin and devoid of logic. -The Consumer consists of two parts: [`WeatherUpdateClient`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateClient.java) -and [`WeatherUpdateEndpoint`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateEndpoint.java). +The Consumer consists of two parts: [`WeatherUpdateClient`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateClient.java) +and [`WeatherUpdateEndpoint`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateEndpoint.java). The client polls the pull-style API of the **Weather** system. @@ -327,9 +327,9 @@ private void emitIfStatusKnown(TsaPassenger tsaPassenger) { } } ``` -The [Process Manager]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/BoardingProcman.java) +The [Process Manager]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/BoardingProcman.java) accumulates the Events and, once the whole *Flight* is boarded, emits a `BoardingComplete` event, -which is later consumed by the [*Flight* Aggregate]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java). +which is later consumed by the [*Flight* Aggregate]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java). @@ -357,4 +357,4 @@ your current system to work in an event-driven manner. A correct integration str isolate and perfect your own domain language while on the work of many external systems. Read more about Bounded Contexts and their interactions in the "Domain-Driven Design" book by Eric Evans. -The full version of the source code used in this article could be found in the [Airport Example repository]({{% get-site-data "spine.examples" %}}/airport). +The full version of the source code used in this article could be found in the [Airport Example repository]({{% get-site-data "repositories.examples" %}}/airport). diff --git a/docs/content/docs/1/introduction/_index.md b/docs/content/docs/1/introduction/_index.md index b78abd5..493befd 100644 --- a/docs/content/docs/1/introduction/_index.md +++ b/docs/content/docs/1/introduction/_index.md @@ -216,7 +216,7 @@ assertEntity.hasStateThat() ### Configuring Server Environment For information on configuring server environment of a Spine-based application, please -see the reference documentation of the [`ServerEnvironment`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server/-server-environment/) +see the reference documentation of the [`ServerEnvironment`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server/-server-environment/) class. ### Assembling Application diff --git a/docs/content/docs/1/introduction/concepts.md b/docs/content/docs/1/introduction/concepts.md index a36c562..1b5ae86 100755 --- a/docs/content/docs/1/introduction/concepts.md +++ b/docs/content/docs/1/introduction/concepts.md @@ -108,7 +108,7 @@ generates events in response to changes in the domain. {{% note-block class="note" %}} In some cases, Event Reactor may ignore the event, returning `Nothing`. It usually happens when a method returns one of the - [`Either`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.tuple/-either/) types, with `Nothing` as + [`Either`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.tuple/-either/) types, with `Nothing` as one of the possible options: `EitherOf2`. {{% /note-block %}} @@ -186,9 +186,9 @@ Repository encapsulates storage, retrieval, and search of Entities as if it were a collection of objects. It isolates domain objects from the details of the database access code. The applications you develop using Spine usually have the following types of repositories: -* [`AggregateRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.aggregate/-aggregate-repository/), -* [`ProcessManagerRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.procman/-process-manager/), -* [`ProjectionRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.projection/-projection-repository/). +* [`AggregateRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.aggregate/-aggregate-repository/), +* [`ProcessManagerRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.procman/-process-manager/), +* [`ProjectionRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.projection/-projection-repository/). ### Snapshot diff --git a/docs/content/docs/1/introduction/naming-conventions.md b/docs/content/docs/1/introduction/naming-conventions.md index 086c69d..ed3b5ed 100755 --- a/docs/content/docs/1/introduction/naming-conventions.md +++ b/docs/content/docs/1/introduction/naming-conventions.md @@ -290,7 +290,7 @@ which seem hierarchical for convenience. When it comes to placing source code fi in a project, there is usually nesting formed by the directories in a file system. Spine framework uses this notion of “nesting” for marking multiple packages of a server-side code -[belonging to a Bounded Context]({{% get-site-data "spine.core_api_doc" %}}/core/core/io.spine.core/-bounded-context/) +[belonging to a Bounded Context]({{% get-site-data "repositories.core_api_doc" %}}/core/core/io.spine.core/-bounded-context/) easier. But this is a convenience feature, not a requirement. Please see our recommendations for organizing generated and handcrafted code in sections below. diff --git a/docs/content/docs/1/quick-start/_index.md b/docs/content/docs/1/quick-start/_index.md index 6b410cc..4ac8ee2 100755 --- a/docs/content/docs/1/quick-start/_index.md +++ b/docs/content/docs/1/quick-start/_index.md @@ -24,7 +24,7 @@ tests the Hello context. 1. JDK version 8 or higher. 2. Git. -3. The source code of the [Hello World]({{% get-site-data "spine.examples" %}}/hello) example. +3. The source code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello) example. ```bash git clone git@github.com:spine-examples/hello.git diff --git a/docs/content/docs/1/reference/index.md b/docs/content/docs/1/reference/index.md index 364e81a..c63c7cd 100755 --- a/docs/content/docs/1/reference/index.md +++ b/docs/content/docs/1/reference/index.md @@ -7,19 +7,19 @@ headline: Documentation ## Java -- [Server]({{% get-site-data "spine.core_api_doc" %}}/server/) +- [Server]({{% get-site-data "repositories.core_api_doc" %}}/server/) -- [Client]({{% get-site-data "spine.core_api_doc" %}}/client/) +- [Client]({{% get-site-data "repositories.core_api_doc" %}}/client/) -- [Spine Web API]({{% get-site-data "spine.web_api_doc" %}}/web/). +- [Spine Web API]({{% get-site-data "repositories.web_api_doc" %}}/web/). This reference defines the API for communicating with a Spine-based backend using web requests. -- [Web API implementation on Firebase]({{% get-site-data "spine.web_api_doc" %}}/firebase-web/). +- [Web API implementation on Firebase]({{% get-site-data "repositories.web_api_doc" %}}/firebase-web/). This reference is on the implementation of the Spine Web API using the Firebase Realtime Database to deliver data to web clients. ## JavaScript -- [JavaScript Client]({{% get-site-data "spine.js_api_doc" %}}) +- [JavaScript Client]({{% get-site-data "repositories.js_api_doc" %}}) ## Dart -- [Dart Client]({{% get-site-data "spine.dart_api_doc" %}}/client/) +- [Dart Client]({{% get-site-data "repositories.dart_api_doc" %}}/client/) diff --git a/docs/data/spine.yml b/docs/data/spine.yml deleted file mode 100644 index 3fcff15..0000000 --- a/docs/data/spine.yml +++ /dev/null @@ -1,18 +0,0 @@ -examples: https://github.com/spine-examples - -site_repo: https://github.com/SpineEventEngine/SpineEventEngine.github.io -core_jvm_repo: https://github.com/SpineEventEngine/core-jvm -base_libraries_repo: https://github.com/SpineEventEngine/base-libraries -web_repo: https://github.com/SpineEventEngine/web -gcloud_java_repo: https://github.com/SpineEventEngine/gcloud-java -money_repo: https://github.com/SpineEventEngine/money -dart_repo: https://github.com/SpineEventEngine/dart -bootstrap_repo: https://github.com/SpineEventEngine/bootstrap -jdbc_storage_repo: https://github.com/SpineEventEngine/jdbc-storage -time_repo: https://github.com/SpineEventEngine/time - -base_api_doc: https://spine.io/base-libraries/dokka-reference -core_api_doc: https://spine.io/core-jvm/dokka-reference -dart_api_doc: https://spine.io/dart/reference -js_api_doc: https://spine.io/web/reference/client-js -web_api_doc: https://spine.io/web/dokka-reference