Skip to content

Commit 286d873

Browse files
authored
Merge pull request #318 from eclipse-esmf/317-documentation-move-release-notes-one-level-up
Documentation: move Release Notes one level up
2 parents 66bb29f + 328487b commit 286d873

File tree

4 files changed

+22
-11
lines changed

4 files changed

+22
-11
lines changed

documentation/antora.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ start_page: ROOT:index.adoc
55
nav:
66
- modules/ROOT/nav.adoc
77
- modules/appendix/nav.adoc
8+
- modules/release-notes/nav.adoc
89
- modules/legal/nav.adoc

documentation/modules/appendix/nav.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,5 @@ SPDX-License-Identifier: MPL-2.0
1111
.Appendix
1212
* xref:best-practices.adoc[Best Practices]
1313
* xref:model-evolution.adoc[Model Evolution]
14-
* xref:release-notes.adoc[Release Notes]
1514
* xref:unitcatalog.adoc[Unit Catalog]
1615
* xref:bibliography.adoc[Bibliography]
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
////
2+
Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
3+
4+
See the AUTHORS file(s) distributed with this work for additional information regarding authorship.
5+
6+
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
7+
If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/
8+
SPDX-License-Identifier: MPL-2.0
9+
////
10+
11+
* xref:release-notes.adoc[Release Notes]

documentation/modules/appendix/pages/release-notes.adoc renamed to documentation/modules/release-notes/pages/release-notes.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ on validation and documentation as follows:
2828
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/161[Issue on Github].
2929

3030
* Validation of
31-
xref:samm-specification:ROOT:characteristics#time-series-characteristic[samm-c:TimeSeries] was
31+
xref:ROOT:characteristics#time-series-characteristic[samm-c:TimeSeries] was
3232
improved: The referenced type is checked by the validation now.
3333
https://github.com/eclipse-esmf/esmf-sdk/issues/194[Issue on Github].
3434

@@ -50,23 +50,23 @@ https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/161[Issue
5050
** https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/documentation/decisions/0005-rdf-vocabulary.md[Aspect Meta Model RDF Vocabulary]
5151
** https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/documentation/decisions/0006-unit-catalog.md[Unit Catalog: Use UNECE Recommendation 20]
5252

53-
* Section on xref:samm-specification:ROOT:modeling-guidelines.adoc#declaring-events[Declaring
54-
Events] was added; wrong edges in the xref:samm-specification:ROOT:meta-model-elements.adoc[Meta
53+
* Section on xref:ROOT:modeling-guidelines.adoc#declaring-events[Declaring
54+
Events] was added; wrong edges in the xref:ROOT:meta-model-elements.adoc[Meta
5555
Model Elements overview diagram] were fixed.
5656
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/104[Issue on Github].
5757

58-
* xref:samm-specification:ROOT:modeling-guidelines.adoc#naming-rules[Naming convention] for Events
58+
* xref:ROOT:modeling-guidelines.adoc#naming-rules[Naming convention] for Events
5959
was clarified: Events should use UpperCamelCase, like Aspects, Entities, Constraints and
6060
Characteristics. https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/147[Issue on Github].
6161

62-
* Section on xref:samm-specification:appendix:model-evolution.adoc[Model Evolution] was added in
62+
* Section on xref:appendix:model-evolution.adoc[Model Evolution] was added in
6363
appendix. https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/82[Issue on
6464
Github].
6565

6666
* Reference to outdated terminology "leaf Characteristic" was fixed.
6767
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/pull/215[Issue on Github].
6868

69-
* Japanese sample text in xref:samm-specification:ROOT:datatypes.adoc[Data Types] was fixed.
69+
* Japanese sample text in xref:ROOT:datatypes.adoc[Data Types] was fixed.
7070
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/issues/172[Issue on Github].
7171

7272
[[samm-2.1.0-others]]
@@ -104,19 +104,19 @@ re-released as Eclipse Semantic Modeling Framework (ESMF) Semantic Aspect Meta M
104104
of an element is the local name part of its URI, i.e., the part following the `#` symbol.
105105
* The meta model elements `Unit`, `QuantityKinds` and their corresponding attributes have been moved
106106
from the `unit` namespace to the `bamm` namespace. The unit namespace is now solely reserved for
107-
the units of the xref:samm-specification:appendix:unitcatalog.adoc#unit-catalog-units[unit
107+
the units of the xref:appendix:unitcatalog.adoc#unit-catalog-units[unit
108108
catalog] itself.
109109
* The
110110
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/src/main/resources/samm/unit/2.0.0/units.ttl[formal
111111
description (units.ttl)] of the units catalog is now automatically generated from its original
112-
source (see xref:samm-specification:ROOT:units.adoc[Units]) and the
112+
source (see xref:ROOT:units.adoc[Units]) and the
113113
https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/esmf-samm-build-plugin/src/main/resources/custom-units.ttl[local adjustments].
114114
* The `localeCode` and `languageCode` attributes have been moved from the `bamm` namespace to the
115115
`bamm-c` namespace.
116116
* Shared model elements have been adjusted:
117-
** The xref:samm-specification:ROOT:entities.adoc#point-3d[Point3d Entity] has been changed to use
117+
** The xref:ROOT:entities.adoc#point-3d[Point3d Entity] has been changed to use
118118
Abstract Properties for its components;
119-
** The xref:samm-specification:ROOT:entities.adoc#time-series-entity[Time Series Entity] has been
119+
** The xref:ROOT:entities.adoc#time-series-entity[Time Series Entity] has been
120120
changed to use an Abstract Property for its `value` component
121121
* The attributes `bamm:properties`, `bamm:operations` and `bamm:events` on `bamm:Aspect` are now
122122
optional, i.e., they do not have to be added any more even when they are empty lists.

0 commit comments

Comments
 (0)