Skip to content

Commit ac2133e

Browse files
authored
Merge pull request #69 from SpineEventEngine/use-theme-variables
Use theme variables
2 parents 5424abc + 11dba81 commit ac2133e

14 files changed

Lines changed: 49 additions & 67 deletions

File tree

SPINE_RELEASE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ use `{{% version %}}` shortcode:
137137
```markdown
138138
[CoreJvm]({{% version %}})
139139
140-
[CoreJvm {{% version %}}]({{% get-site-data "spine.core_jvm_repo" %}}/index.html)
140+
[CoreJvm {{% version %}}]({{% get-site-data "repositories.core_jvm_repo" %}}/index.html)
141141
```
142142

143143
Will be rendered as:
@@ -150,8 +150,8 @@ Will be rendered as:
150150

151151
Where:
152152

153-
* {{% get-site-data "spine.core_jvm_repo" %}} will apply the `core_jvm_repo`
154-
from the `data/spine.yml` file.
153+
* {{% get-site-data "repositories.core_jvm_repo" %}} will apply the `core_jvm_repo`
154+
from the `site-commons` -> `data/repositories.yml` file.
155155
* {{% version %}} adds the full version of the current page -> `1.9.0`, or `2.0.0`.
156156

157157
To provide a specific version for example in FAQ or Release Notes, use:

docs/content/docs/1/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ the overview of the documentation sections.
1212

1313
## [Quick Start](docs/quick-start/)
1414
In this section you can learn what it's like to develop with Spine by going
15-
through the code of the [Hello World]({{% get-site-data "spine.examples" %}}/hello/)
15+
through the code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello/)
1616
example.
1717

1818
## [Introduction](docs/introduction/)
@@ -31,7 +31,7 @@ This sections provides links to the generated documentation.
3131

3232
## [Examples](docs/examples/)
3333
This page is the entry point for learning from the code of
34-
the [example applications]({{% get-site-data "spine.examples" %}}).
34+
the [example applications]({{% get-site-data "repositories.examples" %}}).
3535

3636
## [DDD Resources](docs/resources/)
3737
A brief selection of learning materials we recommend to the colleagues in DDD.

docs/content/docs/1/client-libs/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ headline: Documentation
55

66
# Java Client Library
77

8-
* [Reference documentation]({{% get-site-data "spine.core_api_doc" %}}/client/)
9-
* [Source code]({{% get-site-data "spine.core_jvm_repo" %}}/tree/master/client/)
8+
* [Reference documentation]({{% get-site-data "repositories.core_api_doc" %}}/client/)
9+
* [Source code]({{% get-site-data "repositories.core_jvm_repo" %}}/tree/master/client/)

docs/content/docs/1/client-libs/dart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ headline: Documentation
44
---
55

66
# Dart Client Library
7-
* [Reference documentation]({{% get-site-data "spine.dart_api_doc" %}}/client/)
8-
* [Source code]({{% get-site-data "spine.dart_repo" %}}/tree/master/client/)
7+
* [Reference documentation]({{% get-site-data "repositories.dart_api_doc" %}}/client/)
8+
* [Source code]({{% get-site-data "repositories.dart_repo" %}}/tree/master/client/)

docs/content/docs/1/client-libs/js.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ headline: Documentation
55

66
# JavaScript Client Library
77

8-
* [Reference documentation]({{% get-site-data "spine.js_api_doc" %}})
9-
* [Source code]({{% get-site-data "spine.web_repo" %}}/tree/master/client-js/)
8+
* [Reference documentation]({{% get-site-data "repositories.js_api_doc" %}})
9+
* [Source code]({{% get-site-data "repositories.web_repo" %}}/tree/master/client-js/)

docs/content/docs/1/examples/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@ headline: Spine Examples
44
---
55

66
{{% note-block class="lead" %}}
7-
Examples are available through the [Spine Examples]({{% get-site-data "spine.examples" %}})
7+
Examples are available through the [Spine Examples]({{% get-site-data "repositories.examples" %}})
88
GitHub organization.
99
{{% /note-block %}}
1010

1111
Please see the selected list of the examples with the descriptions below.
1212

1313
## Java
1414

15-
- [Hello World]({{% get-site-data "spine.examples" %}}/hello/) — a minimal
15+
- [Hello World]({{% get-site-data "repositories.examples" %}}/hello/) — a minimal
1616
client-server solution described in the [Quick Start](docs/quick-start/) guide.
17-
- [Blog]({{% get-site-data "spine.examples" %}}/blog/) — shows server-side
17+
- [Blog]({{% get-site-data "repositories.examples" %}}/blog/) — shows server-side
1818
functionality of a simple blog.
19-
- [Kanban]({{% get-site-data "spine.examples" %}}/kanban/) — shows orchestrating
19+
- [Kanban]({{% get-site-data "repositories.examples" %}}/kanban/) — shows orchestrating
2020
Aggregates using Process Managers.
21-
- [Airport]({{% get-site-data "spine.examples" %}}/airport/) — integrating
21+
- [Airport]({{% get-site-data "repositories.examples" %}}/airport/) — integrating
2222
a third-party systems using a Bounded Context. This example accompanies
2323
the [“Integration with a Third Party”](docs/guides/integration/) guide.
24-
- [To-Do List]({{% get-site-data "spine.examples" %}}/todo-list/) — a simple
24+
- [To-Do List]({{% get-site-data "repositories.examples" %}}/todo-list/) — a simple
2525
task management system with multiple client applications.
2626
If you want to see a bigger picture of a Spine-based solution,
2727
have a look at this example.
2828

2929
## JavaScript
3030

31-
- [Simple HTML/JS To-Do List client]({{% get-site-data "spine.examples" %}}/todo-list/tree/master/client/html-js/)
31+
- [Simple HTML/JS To-Do List client]({{% get-site-data "repositories.examples" %}}/todo-list/tree/master/client/html-js/)
3232
— a client app with very basic features.
33-
- [To-Do List client on Angular]({{% get-site-data "spine.examples" %}}/todo-list/tree/master/client/angular/)
33+
- [To-Do List client on Angular]({{% get-site-data "repositories.examples" %}}/todo-list/tree/master/client/angular/)
3434
— a more featured client built with Angular 10.

docs/content/docs/1/guides/gradle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Spine Model Compiler is a Gradle plugin which executes all the code generation r
158158
Gradle tasks as well as the `modelCompiler { }` extension, which allows you to configure those
159159
tasks.
160160

161-
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/)
162-
and the [codegen configuration options]({{% get-site-data "spine.base_api_doc" %}}/model-compiler/model-compiler/io.spine.tools.gradle.compiler/-extension/)
161+
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/)
162+
and the [codegen configuration options]({{% get-site-data "repositories.base_api_doc" %}}/model-compiler/model-compiler/io.spine.tools.gradle.compiler/-extension/)
163163

164164
### ProtoJS Plugin
165165

@@ -168,5 +168,5 @@ The plugin adds the `generateJsonParsers` task, which appends generated JS files
168168
Protobuf messages out of plain JS objects.
169169

170170
The plugin also provides the `protoJs { }` extension, which allows you to configure JS code
171-
generation. See the [API reference]({{% get-site-data "spine.base_api_doc" %}}/proto-js-plugin/proto-js-plugin/io.spine.js.gradle/-extension/)
171+
generation. See the [API reference]({{% get-site-data "repositories.base_api_doc" %}}/proto-js-plugin/proto-js-plugin/io.spine.js.gradle/-extension/)
172172
for more info.

docs/content/docs/1/guides/integration.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ parse and validate domain Events, which we then publish to a Bounded Context, im
8686

8787
The Event Consumer, as depicted above, implements the Event transformation logic. In order to
8888
establish this communication channel, the **Airplane Supplies** system declares a [gRPC](https://grpc.io/)
89-
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):
89+
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):
9090

9191
<embed-code file="examples/airport/airplane-supplies/src/main/proto/spine/example/airport/supplies/supplies_service.proto"
9292
start="message Subscription*"
@@ -111,7 +111,7 @@ enum EventType {
111111
PREFLIGHT_CHECK_COMPLETE = 3;
112112
}
113113
```
114-
The **Airplane Supplies** system [implements]({{% get-site-data "spine.examples" %}}/airport/blob/master/airplane-supplies/src/main/java/io/spine/example/airport/supplies/SuppliesEventProducer.java)
114+
The **Airplane Supplies** system [implements]({{% get-site-data "repositories.examples" %}}/airport/blob/master/airplane-supplies/src/main/java/io/spine/example/airport/supplies/SuppliesEventProducer.java)
115115
the service and exposes it on an endpoint available to the **Takeoffs and Landings** system:
116116

117117
<embed-code file="examples/airport/airplane-supplies/src/main/java/io/spine/example/airport/supplies/SuppliesEventProducer.java"
@@ -138,9 +138,9 @@ public final class SuppliesEventProducer extends SuppliesEventProducerImplBase {
138138
```
139139
The event producer obtains cached historical events, matches them to the received subscription,
140140
and sends them to the client. The **Takeoffs and Landings** system implements
141-
an&nbsp;[event consumer]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/supplies/SuppliesEventConsumer.java)
141+
an&nbsp;[event consumer]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/supplies/SuppliesEventConsumer.java)
142142
which constructs a subscription and maintains it as long as the system needs to receive more events.
143-
The consumer broadcasts the received Events via an instance of [`ThirdPartyContext`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.integration/-third-party-context/):
143+
The consumer broadcasts the received Events via an instance of [`ThirdPartyContext`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.integration/-third-party-context/):
144144

145145
<embed-code file="examples/airport/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/supplies/SuppliesEventConsumer.java"
146146
fragment="onNext"></embed-code>
@@ -161,7 +161,7 @@ public void onNext(SuppliesEvent event) {
161161
context.emittedEvent(eventMessage, actorContext);
162162
}
163163
```
164-
The [`AircraftAggregate`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/AircraftAggregate.java)
164+
The [`AircraftAggregate`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/AircraftAggregate.java)
165165
reacts on those events. Note that all the events published through `ThirdPartyContext` are always
166166
`external`, so should be the subscriber and reactor methods.
167167

@@ -194,8 +194,8 @@ the Customer/Supplier, **Takeoffs and Landings** Context is downstream from anot
194194
case from **Weather**. Unlike the Customer/Supplier, **Weather** does not provide a specific
195195
Event Producer, which would adapt **Weather** Events to the needs of **Takeoffs and Landings**.
196196
Also, the Event Consumer on the **Takeoffs and Landings** side is rather thin and devoid of logic.
197-
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)
198-
and [`WeatherUpdateEndpoint`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateEndpoint.java).
197+
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)
198+
and [`WeatherUpdateEndpoint`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateEndpoint.java).
199199
The client polls the pull-style API of the **Weather** system.
200200

201201
<embed-code file="examples/airport/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/weather/WeatherUpdateClient.java"
@@ -250,7 +250,7 @@ public void receiveNew(WeatherMeasurement measurement) {
250250
previous = measurement;
251251
}
252252
```
253-
The [`FlightAggregate`]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java)
253+
The [`FlightAggregate`]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java)
254254
reacts on those events and changes its state as the result:
255255

256256
<embed-code file="examples/airport/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java"
@@ -294,12 +294,12 @@ a large monolithic legacy system (a.k.a. a Big Ball of Mud) into Bounded Context
294294
an ACL prevents the new "clean" Contexts from merging back into the Mud. If you are looking for
295295
a way to add functionality to a complex legacy system without increasing the technical debt, look
296296
no further. The Anticorruption Layer between **Takeoffs and Landings** and **Security Checks**
297-
is composed of a [polling client]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/PassengerClient.java),
297+
is composed of a [polling client]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/PassengerClient.java),
298298
which performs all the technical work of obtaining and validating data, and a [Process Manager](docs/introduction/concepts#process-manager)
299-
for the [Boarding process]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/BoardingProcman.java).
299+
for the [Boarding process]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/BoardingProcman.java).
300300
The **Security Checks** API provides data for each passenger independently. The client polls
301301
the data and publishes many intermediate `PassengerBoarded` or `PassengerDeniedBoarding` external
302-
events via [`ThirdPartyContext`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.integration/-third-party-context/):
302+
events via [`ThirdPartyContext`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.integration/-third-party-context/):
303303

304304
<embed-code file="examples/airport/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/PassengerClient.java"
305305
fragment="Fetch passengers"></embed-code>
@@ -327,9 +327,9 @@ private void emitIfStatusKnown(TsaPassenger tsaPassenger) {
327327
}
328328
}
329329
```
330-
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)
330+
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)
331331
accumulates the Events and, once the whole *Flight* is boarded, emits a `BoardingComplete` event,
332-
which is later consumed by the&nbsp;[*Flight* Aggregate]({{% get-site-data "spine.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java).
332+
which is later consumed by the&nbsp;[*Flight* Aggregate]({{% get-site-data "repositories.examples" %}}/airport/blob/master/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/FlightAggregate.java).
333333

334334
<embed-code file="examples/airport/takeoffs-and-landings/src/main/java/io/spine/example/airport/tl/passengers/BoardingProcman.java"
335335
fragment="BoardingProcman"></embed-code>
@@ -357,4 +357,4 @@ your current system to work in an event-driven manner. A correct integration str
357357
isolate and perfect your own domain language while on the work of many external systems. Read more
358358
about Bounded Contexts and their interactions in the "Domain-Driven Design" book by Eric Evans.
359359

360-
The full version of the source code used in this article could be found in the&nbsp;[Airport Example repository]({{% get-site-data "spine.examples" %}}/airport).
360+
The full version of the source code used in this article could be found in the&nbsp;[Airport Example repository]({{% get-site-data "repositories.examples" %}}/airport).

docs/content/docs/1/introduction/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ assertEntity.hasStateThat()
216216
### Configuring Server Environment
217217

218218
For information on configuring server environment of a Spine-based application, please
219-
see the reference documentation of the [`ServerEnvironment`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server/-server-environment/)
219+
see the reference documentation of the [`ServerEnvironment`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server/-server-environment/)
220220
class.
221221

222222
### Assembling Application

docs/content/docs/1/introduction/concepts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ generates events in response to changes in the domain.
108108
{{% note-block class="note" %}}
109109
In some cases, Event Reactor may ignore the event, returning `Nothing`.
110110
It usually happens when a method returns one of the
111-
[`Either`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.tuple/-either/) types, with `Nothing` as
111+
[`Either`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.tuple/-either/) types, with `Nothing` as
112112
one of the possible options: `EitherOf2<TaskReAssigned, Nothing>`.
113113
{{% /note-block %}}
114114

@@ -186,9 +186,9 @@ Repository encapsulates storage, retrieval, and search of Entities as if it were
186186
a collection of objects. It isolates domain objects from the details of the database access code.
187187

188188
The applications you develop using Spine usually have the following types of repositories:
189-
* [`AggregateRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.aggregate/-aggregate-repository/),
190-
* [`ProcessManagerRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.procman/-process-manager/),
191-
* [`ProjectionRepository`]({{% get-site-data "spine.core_api_doc" %}}/server/server/io.spine.server.projection/-projection-repository/).
189+
* [`AggregateRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.aggregate/-aggregate-repository/),
190+
* [`ProcessManagerRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.procman/-process-manager/),
191+
* [`ProjectionRepository`]({{% get-site-data "repositories.core_api_doc" %}}/server/server/io.spine.server.projection/-projection-repository/).
192192

193193
### Snapshot
194194

0 commit comments

Comments
 (0)