From 4ef1415e7dcc687af8a6b245d132960772ff1680 Mon Sep 17 00:00:00 2001 From: Axel RICHARD Date: Fri, 19 Jul 2024 16:25:24 +0200 Subject: [PATCH] [doc] Add 2024.9.0 changelog in user-manual documentation Signed-off-by: Axel RICHARD --- CHANGELOG.adoc | 4 +- doc/content/README | 17 +++++--- .../pages/release-notes/2024.5.0.adoc | 8 ++-- .../pages/release-notes/2024.9.0.adoc | 43 +++++++++++++++++++ .../pages/release-notes/release-notes.adoc | 1 + 5 files changed, 62 insertions(+), 11 deletions(-) create mode 100644 doc/content/modules/user-manual/pages/release-notes/2024.9.0.adoc diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 4fff90053..16bd619ae 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -33,10 +33,10 @@ The changes are: - https://github.com/eclipse-syson/syson/issues/538[#538] [general-view] Add actions in _PartUsage_ and _PartDefinition_ - https://github.com/eclipse-syson/syson/issues/554[#554] [general-view] Add states in _PartUsage_ and _PartDefinition_ -- https://github.com/eclipse-syson/syson/issues/393[#393] [general-view] Add exhibit states on General View diagram +- https://github.com/eclipse-syson/syson/issues/393[#393] [general-view] Add _ExhibitStates_ on General View diagram - https://github.com/eclipse-syson/syson/issues/557[#557] [state-transition-view] Allow the creation of a StateTransitionView diagram on a _PartUsage_/_PartDefinition_ - https://github.com/eclipse-syson/syson/issues/558[#558] [state-transition-view] Allow the creation of a StateTransitionView diagram on a _StateUsage_/_StateDefinition_ -- https://github.com/eclipse-syson/syson/issues/261[#261] [interconnection-view] The _InterfaceUsage_ created by the New Interface edge tool in the Interconnection View diagram are now created under closest containing Definition/Package. +- https://github.com/eclipse-syson/syson/issues/261[#261] [interconnection-view] The _InterfaceUsage_ created by the New Interface edge tool in the Interconnection View diagram are now created under closest containing _Definition_/_Package_. === New features diff --git a/doc/content/README b/doc/content/README index 3ebb3443a..d4f500693 100644 --- a/doc/content/README +++ b/doc/content/README @@ -6,7 +6,6 @@ Use asciidoc attributes to reference URL. For reference to menus, key on the keyboard... use `backticks`. Use + on new line in table to force a new line - Decide what you are saying and how: Define the kind of narrator, your tone and your mood Repeat yourself: a tutorial will have a brief introduction to what you’re going to do, then the actual procedure, and finally a way for you to verify that you’ve done the thing correctly Avoid using demonstrative pronouns: Instead of saying “this” or “that,” you should add a noun to spell out exactly what you’re referring to. @@ -22,13 +21,21 @@ Avoid jargon and cliches Make use of whitespace # Vale + We use vale, it is a linter for prose # Antora use -* Ensure that docker is launch + +- Ensure that docker is launch + ## on linux -* Launch the script SysON\doc\generate.bash in a terminal + +- Launch the script SysON\doc\generate.bash in a terminal + ## on Windows -* Lunch the script SysON\doc\local-generation.ps1 in a Windows Power shell console + +- Launch the script SysON\doc\local-generation.ps1 in a Windows Power shell console + ## Result -* Generation result is available in SysON\doc\docs-site\build\site + +- Generation result is available in SysON\doc\docs-site\build\site diff --git a/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc index 3a1f737ca..6328809b4 100644 --- a/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/2024.5.0.adoc @@ -33,7 +33,7 @@ It has been deleted in this release. image::release-notes-attribut-compartmen-interconnection-view.png[Attribute compartment from {iv}] - No error is raised anymore when setting a valid new value (with primitive type) in the Details view. -- The body feature of a `Comment` remove now the "/\*" and "*/" characters while importing a model from Sysml textual format. +- The body feature of a `Comment` remove now the "/\*" and "*/" characters while importing a model from SysML textual format. - All `Memberships` are now contained in their parent through `ownedRelatedElement` instead of `ownedRelationship` reference. - Rename action from explorer is now renaming tree items as expected. - `EnumerationDefinition` is now created with a default name. @@ -43,7 +43,7 @@ image::release-notes-enumeration-definition.png[Enumeration definition node] - "Add existing element (recursive)" action has been updated to create child nodes for nested and owned usages at the root of the diagram. - While importing some of the standard examples, there are no more exception mainly when some of examples are linked to non resolved elements. - Hide capabilities have been restored and improved in the palette. -It's now possible to hide a node but also all its content (recursive) or symply direct content (Shhow valued content action). +It's now possible to hide a node but also all its content (recursive) or simply direct content (Show valued content action). image::release-notes-hide-capabilities.png[Restore and Improve hide capabilities] @@ -59,7 +59,7 @@ image::release-notes-avoid-nestedPart-cycle.png[Avoid nested part cycle] - Time performance has been improved when using `Become nested part` edge creation tool. - `state transition` and `actions` compartments are now available on `StateDefinition` and `StateUsage` node. -image::release-notes-state-transition-cpt.png[State transition compatment] +image::release-notes-state-transition-cpt.png[State transition compartment] - Inherited features in compartments don't display itself anymore. @@ -119,7 +119,7 @@ image::release-notes-requirements.png[Requirements] image::release-notes-become-nested-attribute.png[Become nested attribute edge tool] -- Creation tools (mainly `AttributeUsage`, `PartUsage`, `PortUsage` `ItemUsage`) have been addded in `ActionUsage`, `ConstraintUsage`, `InterfaceDefinition`, `RequirementDefinition` and `PortUsage`. +- Creation tools (mainly `AttributeUsage`, `PartUsage`, `PortUsage` `ItemUsage`) have been added in `ActionUsage`, `ConstraintUsage`, `InterfaceDefinition`, `RequirementDefinition` and `PortUsage`. - `UseCaseDefinition` and `UseCaseUsage` elements are now handled in {gv}. image::release-notes-handle-usecase.png[Handle Usecase elements] diff --git a/doc/content/modules/user-manual/pages/release-notes/2024.9.0.adoc b/doc/content/modules/user-manual/pages/release-notes/2024.9.0.adoc new file mode 100644 index 000000000..3ad356a95 --- /dev/null +++ b/doc/content/modules/user-manual/pages/release-notes/2024.9.0.adoc @@ -0,0 +1,43 @@ += 2024.9.0 (work in progress) + +== Key highlights + +- *Model conformance to SysMLv2 Beta 2 version*: The metamodel has been modified to conform to SysMLv2 Beta 2 specification released on the 3rd of February 2024(see https://www.omg.org/spec/SysML/ for more details) and KerML Beta 2 specification released on the 17the of February 2024(see https://www.omg.org/spec/KerML/ for more details). + +== Breaking changes + +- Move _StateTransitionCompartmentNodeDescriptionProvider_ from syson-diagram-statetransition-view to module syson-diagram-common-view. +- Code refactoring: +* Rename `ExhibitStatesCompartmentItemNodeDescriptionProvider` to `StatesCompartmentItemNodeDescriptionProvider`. +* _StatesCompartmentNodeDescriptionProvider_ now handles both exhibit and non-exhibit states. +- Align metamodel to SysMLv2 Beta 2 specification released on the 3rd of February 2024(see https://www.omg.org/spec/SysML/ for more details) and KerML Beta 2 specification released on the 17the of February 2024(see https://www.omg.org/spec/KerML/ for more details). +You may have to fix your existing SysON models/projects by your own means to still be able to open them with SysON. +Please download all your models/projects before upgrading to 2024.9.0. +The changes are: +* AnnotatingElement +** add derived reference "ownedAnnotatingRelationship : Annotation" +* Annotation +** add derived reference "owningAnnotatingElement : AnnotatingElement" +* Connector +** remove attribute "isDirected : boolean" +* OperatorExpression +** remove derived reference "operand : Expression" +* ParameterMembership +** add operation "parameterDirection() : FeatureDirectionKind" +* Type +** add operation "directionOfExcluding(Feature, Type[0..\*]) : FeatureDirectionKind" + +== Dependencies update + +== Bug fixes + +== Improvements + +- Add actions in _PartUsage_ and _PartDefinition_ +- Add states in _PartUsage_ and _PartDefinition_ +- Add _ExhibitStates_ on General View diagram +- Allow the creation of a StateTransitionView diagram on a _PartUsage_/_PartDefinition_ +- Allow the creation of a StateTransitionView diagram on a _StateUsage_/_StateDefinition_ +- The _InterfaceUsage_ created by the New Interface edge tool in the Interconnection View diagram are now created under closest containing _Definition_/_Package_. + +== New features diff --git a/doc/content/modules/user-manual/pages/release-notes/release-notes.adoc b/doc/content/modules/user-manual/pages/release-notes/release-notes.adoc index 9515bbe64..6631449e0 100644 --- a/doc/content/modules/user-manual/pages/release-notes/release-notes.adoc +++ b/doc/content/modules/user-manual/pages/release-notes/release-notes.adoc @@ -2,6 +2,7 @@ :sectnums!: +include::user-manual:release-notes/2024.9.0.adoc[leveloffset=+1] include::user-manual:release-notes/2024.7.0.adoc[leveloffset=+1] include::user-manual:release-notes/2024.5.0.adoc[leveloffset=+1] include::user-manual:release-notes/2024.3.0.adoc[leveloffset=+1]