diff --git a/doc/content/modules/ROOT/pages/features.adoc b/doc/content/modules/ROOT/pages/features.adoc index ffcb445..c98ba51 100644 --- a/doc/content/modules/ROOT/pages/features.adoc +++ b/doc/content/modules/ROOT/pages/features.adoc @@ -2,7 +2,7 @@ Uncover the capabilities of {product} through an exploration of its features and foundational concepts. -[cols="2*^", %noheader, frame=none, grid=none] +[cols="3*^", %noheader, frame=none, grid=none] |=== a|image::overview.svg[xref=user-manual:features/features.adoc] @@ -12,20 +12,20 @@ Explore the {product} features in details. xref:user-manual:features/features.adoc[Explore] -a|image::settings_heart.svg[xref:user-manual:concepts.adoc] +a|image::settings_heart.svg[xref=user-manual:concepts.adoc] *Key Concepts* Addressing pivotal inquiries and offering a comprehensive understanding of the platform's fundamentals -xref:user-manual:concepts.adoc[Learn essentials] +xref:user-manual:integration/interoperability.adoc[Learn essentials] -a| image::hub.svg[xref=user-manual:integration/interoperability.adoc] +a| image::hub.svg[xref=user-manual:features/sysmlv2-overview.adoc] **Overview of {sysmlv2}** Delve into the foundational concepts of {sysmlv2}. -xref:user-manual:sysmlv2-overview.adoc[Learn more] +xref:user-manual:features/sysmlv2-overview.adoc[Learn more] |=== \ No newline at end of file diff --git a/doc/content/modules/ROOT/pages/user-interface-overview.adoc b/doc/content/modules/ROOT/pages/user-interface-overview.adoc index 7260f23..b2c17ae 100644 --- a/doc/content/modules/ROOT/pages/user-interface-overview.adoc +++ b/doc/content/modules/ROOT/pages/user-interface-overview.adoc @@ -4,19 +4,20 @@ Uncover the {product}'s user interface through a guided-tour and access helpful [cols="2*^", %noheader, frame=none, grid=none] |=== -a|image::travel_explore.svg[xref=user-manual:features/features.adoc] +a|image::travel_explore.svg[xref=user-manual:tour.adoc] *Tour the interface* Embark on a comprehensive exploration of {product}'s interface as this guide navigates you through the key features and functionalities -xref:user-manual:tour.adoc[Explore now] a|image::footprint.svg[xref:user-manual:hands-on/hands-on.adoc] +xref:user-manual:tour.adoc[Explore now] + + a|image::footprint.svg[xref=user-manual:hands-on/hands-on.adoc] *How-Tos and Tutorials* Step-by-step guides, ensuring users can adeptly learn essential tasks and use the potential of {product} -xref:user-manual:hands-on/hands-on.adoc[Delve into] -a|image::developer_guide.svg[xref:user-manual:key-features.adoc] +xref:user-manual:hands-on/hands-on.adoc[Delve into] |=== \ No newline at end of file diff --git a/doc/content/modules/installation-guide/assets/images/download.png b/doc/content/modules/installation-guide/assets/images/download.png index e0311ad..fd0b378 100644 Binary files a/doc/content/modules/installation-guide/assets/images/download.png and b/doc/content/modules/installation-guide/assets/images/download.png differ diff --git a/doc/content/modules/installation-guide/assets/images/latest-version.png b/doc/content/modules/installation-guide/assets/images/latest-version.png index 18501cc..6ba2e4b 100644 Binary files a/doc/content/modules/installation-guide/assets/images/latest-version.png and b/doc/content/modules/installation-guide/assets/images/latest-version.png differ diff --git a/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png b/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png new file mode 100644 index 0000000..87b742c Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/requirement-managment-fromBackground-creation.png differ diff --git a/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png b/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png new file mode 100644 index 0000000..ce85412 Binary files /dev/null and b/doc/content/modules/user-manual/assets/images/requirement-managment-fromRequirement-creation.png differ diff --git a/doc/content/modules/user-manual/pages/features/action-flow-view.adoc b/doc/content/modules/user-manual/pages/features/action-flow-view.adoc index 922c74a..7aed642 100644 --- a/doc/content/modules/user-manual/pages/features/action-flow-view.adoc +++ b/doc/content/modules/user-manual/pages/features/action-flow-view.adoc @@ -1,3 +1,7 @@ = {afv} -The {afv} is used to ... \ No newline at end of file +The {afv} describes input and output flows between different actions within a system. This type of diagram is useful for understanding and analyzing the dynamic behavior of a system, focusing on action sequences and interaction between system elements. + +This view is under development and will be available soon. We encourage users to wait next releases to enjoy all functionalities and concepts on this view. +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. + diff --git a/doc/content/modules/user-manual/pages/features/cm.adoc b/doc/content/modules/user-manual/pages/features/cm.adoc index e3e91bc..54477ce 100644 --- a/doc/content/modules/user-manual/pages/features/cm.adoc +++ b/doc/content/modules/user-manual/pages/features/cm.adoc @@ -1 +1,9 @@ -= Version Control and change management \ No newline at end of file += Version Control and change management + +There are no built-in versioning tools in SysOn. + +If user want to control version of its project, he can use an external Git repository. +Indeed, for each version/iteration of its project, he can xref:hands-on/how-tos/project-management.adoc#download-project[download] its project. +Then he merges the zip archive result on the Git repository. + +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/details.adoc b/doc/content/modules/user-manual/pages/features/details.adoc index 2aa4581..d848275 100644 --- a/doc/content/modules/user-manual/pages/features/details.adoc +++ b/doc/content/modules/user-manual/pages/features/details.adoc @@ -4,4 +4,7 @@ The {details} view provides a comprehensive overview of the selected element, pr image::details-right-sidebar-details.png[{details}] -CAUTION : It's important to note that any changes made in the {details} view have a direct and immediate effect on the underlying model, making these modifications instantly available to everyone accessing the model. \ No newline at end of file +[WARNING] +==== +It's important to note that any changes made in the {details} view have a direct and immediate effect on the underlying model, making these modifications instantly available to everyone accessing the model. +==== \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/editor.adoc b/doc/content/modules/user-manual/pages/features/editor.adoc index 21a8a78..def26fd 100644 --- a/doc/content/modules/user-manual/pages/features/editor.adoc +++ b/doc/content/modules/user-manual/pages/features/editor.adoc @@ -70,6 +70,7 @@ The {editor} area contains one or more editors. image::editor-editor.png[{editor} Main Editor] Discover the diverse range of representation options available and find the most suitable ones for your specific modeling needs. + xref:features/features.adoc#sysmlv2-views[Explore various types of representations...] === Right Sidebar diff --git a/doc/content/modules/user-manual/pages/features/other-views.adoc b/doc/content/modules/user-manual/pages/features/other-views.adoc index 2af3f4b..46d4f56 100644 --- a/doc/content/modules/user-manual/pages/features/other-views.adoc +++ b/doc/content/modules/user-manual/pages/features/other-views.adoc @@ -1 +1,13 @@ -= Other views \ No newline at end of file += Other views + +Following views are planned to be available in SysON as soon as possible: + +* Sequence View, +* Geometry View, +* Grid View, +* Browser View. + +To understand the purpose of each views, refer to the xref:user-manual:features/sysmlv2-overview.adoc[{sysmlv2} in practice] section in the user manual. + +Wait until the next release to enjoy these views. +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/requirement-management.adoc b/doc/content/modules/user-manual/pages/features/requirement-management.adoc index f08b620..5208f53 100644 --- a/doc/content/modules/user-manual/pages/features/requirement-management.adoc +++ b/doc/content/modules/user-manual/pages/features/requirement-management.adoc @@ -2,4 +2,28 @@ == Creating and linking requirements +By using SysON, requirements can be well integrated and defined with the {gv}. + +Remember that a requirement is a kind of constraint representing the constraints given by stakeholders that a solution must satisfy. For example, the requirement of a maximum speed of a vehicle. + +From the {gv} diagram, user can easily create a new requirement by using **from the background** of the diagram from a simple click that displays tool bar. + +image::requirement-managment-fromBackground-creation.png[Requirement creation from Diagram Background] + +User can also create requirement **in other element** such as a requirement. + +image::requirement-managment-fromRequirement-creation.png[Requirement creation from Requirement] + +A Requirement Definition is represented by rectangular node style whereas a Requirement Usage is represented by rectangular node style with rounded corner. + +image::requirement-managment-node-representation.png[Requirement creation from Requirement] + +For now, {gv} diagram authorize only to create requirement Definition and Usage. _Satisfy_ relationship to define connection between requirements are not available. + +Work around requirements are among the topics to be processed soon. + +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. + == Traceability features + +TODO \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/state-transition-view.adoc b/doc/content/modules/user-manual/pages/features/state-transition-view.adoc index 27d473e..27ae2c8 100644 --- a/doc/content/modules/user-manual/pages/features/state-transition-view.adoc +++ b/doc/content/modules/user-manual/pages/features/state-transition-view.adoc @@ -1,3 +1,6 @@ = State transition view -The {stv} is used to ... \ No newline at end of file +The {stv} is describes the logical transition of a system through various states of a system and the transitions between those states. This view shows the behavior of complex system, e.g. how it evolves over time in response to specific events/stimuli. + +This view is under development and will be available soon. We encourage users to wait next releases to enjoy all functionalities and concepts on this view. +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/features/validation.adoc b/doc/content/modules/user-manual/pages/features/validation.adoc index bff6c81..5c197e7 100644 --- a/doc/content/modules/user-manual/pages/features/validation.adoc +++ b/doc/content/modules/user-manual/pages/features/validation.adoc @@ -3,4 +3,6 @@ The {validation} view displays diagnostics for the entire project, organized by their kind (such as `ERROR`, `WARNING`, or `INFO`). Users can conveniently toggle the visibility of diagnostics using an accordion widget. -Validation view is disable for now and no diagnostic are available. \ No newline at end of file +Validation view is disable for now and no diagnostic are available. + +Feel free to https://www.obeosoft.com/en/[contact Obeo] for more details. \ No newline at end of file diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc index dcecf52..8917d6c 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc @@ -46,9 +46,9 @@ To filter elements in the {explorer} using the filter bar: . Choose a tree item in the {explorer}. . Press `Ctrl+f` (Windows/Linux) or `Cmd+f` (MacOS) to enable the filter bar. . Enter a value in the filter bar. - ++ image::hands-on-filter-name-shortcut.png[Filter name shortcut] - ++ . All visible tree items containing the typed value will be highlighted. . Use the filter button inside the filter bar to hide all visible tree items that do not contain the entered value. diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc index b93c9df..36e7349 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc @@ -45,9 +45,9 @@ To upload a model from a file previously exported, follow these steps: . Click on the `Upload` button at the top of the {explorer} in the tool bar. . It will open the `Upload Model` modal. . Select a model from your file system. - ++ image::hands-on-upload-model.png[Upload model] - ++ . The uploaded model will be automatically created and opened. [#rename-model] diff --git a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc index 80372f9..66359d0 100644 --- a/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc @@ -22,19 +22,26 @@ Refer to the xref:features/editor.adoc[{editor} page] to understand how to use i To create a new project from a `Template`: -. Click in the corresponding template card at the top of the homepage. - +1. Click in the corresponding template card at the top of the homepage. ++ +-- The first three templates are directly visible in the {homepage} top region. If more templates are available, you can click the `Show all templates` card to open a dialog displaying all the available templates, possibly on multiple pages. image::hands-on-new-template.png[Create New Template] +-- ++ -. The new project is automatically created and opened. +2. The new project is automatically created and opened. ++ +-- Depending on the template, an initial representation (e.g., a diagram) might also be automatically opened. The following example shows the result project _Batmobile_ create from _Batmobile_ template: image::hands-on-new-template_batmobile.png[Batmobile Template] +-- ++ [NOTE] ==== @@ -68,14 +75,14 @@ To upload a project from an archive exported, follow these steps: . Go to the {homepage}. . Click the _Upload Project_ card. - -image::hands-on-upload.png[Upload project] - ++ +image::hands-on-upload.png[Upload project] ++ . It opens the _Upload Project_ page. -. Select a ZIP from your file system. - +. Select a ZIP from your file system. ++ image::hands-on-upload-select-file.png[Select file to upload] - ++ . The uploaded project is automatically created and opened. Refer to the xref:features/editor.adoc[{editor} page] to understand how to use it for xref:hands-on/how-tos/model-management.adoc#create-model[creating your own models] and xref:hands-on/how-tos/representation-operations.adoc#create-representation[representations]. @@ -99,9 +106,9 @@ You can delete a project from the {homepage}: . Click the {projects-list-menu} next to the project in the {projects-list}. . Select the `Delete` option. - ++ image::hands-on-delete-project-homepage.png[Delete Project from Homepage] - ++ . Confirm the deletion by clicking on the `Delete` button in the modal. === From the {editor} @@ -110,9 +117,9 @@ You can delete a project from the {editor}: . Click the {projects-list-menu} next to the project name in the project toolbar. . Select the `Delete` option. - ++ image::hands-on-delete-project-editor.png[Delete Project from editor] - ++ . Confirm the deletion by clicking on the `Delete` button in the modal. [#rename-project] @@ -136,9 +143,9 @@ You can update the project name from the {homepage}: . Click the {projects-list-menu} next to the project in the {projects-list}. . Select the `Rename` option. - ++ image::hands-on-rename-project-homepage.png[Rename Project from Homepage] - ++ . Update the name in the editable field. . Click on `Rename`. @@ -148,9 +155,9 @@ You can update the project name from the {editor}: . Click the {projects-list-menu} next to the project name in the toolbar. . Select the `Rename` option. - ++ image::hands-on-rename-project-editor.png[Rename Project from editor] - ++ . Update the name in the editable field. . Click on `Rename`. diff --git a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc index 7a4fd0a..73ec78a 100644 --- a/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc +++ b/doc/content/modules/user-manual/pages/hands-on/tutorials/batmobile.adoc @@ -17,12 +17,12 @@ A default `{gv}` representation associated with the package is opened in the mai . In the main editor area, click on the diagram background to open the {diag-toolbar}. . Click on the `New Part Definition` tool to create a new part definition. - ++ [NOTE] ==== The new elements created from the {diag-toolbar} are visible either from the {explorer} or the {editor} main central area. ==== - ++ . Rename the part definition to `Vehicle` using the xref:hands-on/how-tos/model-management.adoc#representation[direct-edit action] or the xref:hands-on/how-tos/model-management.adoc#update-element#details[{details} view]. . Select the `Vehicle` part definition and click on the `New Item` tool to create an item usage. . Rename the item usage to `driver`. diff --git a/doc/content/modules/user-manual/pages/key-features.adoc b/doc/content/modules/user-manual/pages/key-features.adoc index 768aee3..c9c62a3 100644 --- a/doc/content/modules/user-manual/pages/key-features.adoc +++ b/doc/content/modules/user-manual/pages/key-features.adoc @@ -15,115 +15,95 @@ This dual categorization allows users to choose features based on their comfort == Features Overview -[cols="4*^",width="100%"] +[cols="3*^",width="100%"] |=== -| Feature| {sysmlv2} Standard| Open source ({product})|Enterprise Add-ons ({ocp}) +| Feature| Open source ({product})|Enterprise Add-ons ({ocp}) -4+h|Projects Management +3+h|Projects Management |xref:features/homepage.adoc[Projects Browser] -a|icon:times[role=Red] a|icon:check[role=Green] a|icon:check[role=Green] |xref:features/editor.adoc[Project Editor] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:features/editor.adoc#project-actions[Manage Project] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:user-manual:support.adoc[Teams] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] -4+h|{sysmlv2} Views +3+h|{sysmlv2} Views |xref:user-manual:features/general-view.adoc[{gv}] -a|icon:check[role=green] a|icon:check[role=gray] partial a|icon:check[role=gray] partial |xref:user-manual:features/interconnection-view.adoc[{iv}] -a|icon:check[role=green] a|icon:check[role=gray] partial a|icon:check[role=gray] partial |xref:user-manual:features/sysmlv2-overview.adoc[{afv}] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[{stv}] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Sequence View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Geometry View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Grid View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] |xref:user-manual:features/sysmlv2-overview.adoc[Browser View] -a|icon:check[role=green] a|icon:times[role=red] a|icon:times[role=red] -4+h|Collaboration & Interoperability +3+h|Collaboration & Interoperability |xref:features/collaboration.adoc[Share Projects] -a|icon:times[role=red] a|icon:times[role=gray] (All the projects are Public) a|icon:times[role=gray] (All the projects are Public) |xref:features/collaboration.adoc[Share Diagram] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:integration/interoperability.adoc[Download / Upload JSON format] -a|icon:times[role=red] a|icon:check[role=green] a|icon:check[role=green] |xref:integration/interoperability.adoc[Download / Upload Standard {sysmlv2} JSON format] a|icon:times[role=red] a|icon:times[role=red] -a|icon:times[role=red] |xref:integration/interoperability.adoc[Download / Upload {sysmlv2} textual format] -a|icon:times[role=green] a|icon:check[role=gray] Experimental a|icon:check[role=gray] Experimental |xref:user-manual:support.adoc[Live Collaboration] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] -4+h|Advanced +3+h|Advanced |xref:user-manual:support.adoc[Authentication (SSO, LDAP, AD)] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] |xref:user-manual:support.adoc[Accounts Administration] a|icon:times[role=red] -a|icon:times[role=red] a|icon:check[role=green] |=== diff --git a/doc/content/modules/user-manual/partials/nav-integration.adoc b/doc/content/modules/user-manual/partials/nav-integration.adoc index 91d0f86..46d49da 100644 --- a/doc/content/modules/user-manual/partials/nav-integration.adoc +++ b/doc/content/modules/user-manual/partials/nav-integration.adoc @@ -1,4 +1,3 @@ -* xref:user-manual:features/collaboration.adoc[] * xref:user-manual:integration/interoperability.adoc[] * xref:user-manual:integration/capella.adoc[] * xref:user-manual:integration/api.adoc[] \ No newline at end of file