Skip to content

Commit

Permalink
Fix Doc content
Browse files Browse the repository at this point in the history
  • Loading branch information
mbats committed Jun 14, 2024
1 parent eaad65c commit 26f91bc
Show file tree
Hide file tree
Showing 43 changed files with 451 additions and 383 deletions.
13 changes: 6 additions & 7 deletions doc/content/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@ asciidoc:
explorer-menu: "Element Options Menu"
explorer: "Project Explorer"
forum-url: "https://github.com/eclipse-syson/syson/discussions"
fromsyson: "Included in Community version"
fromocp: "Included in Enterprise version"
gv: "General View"
gv: "General view"
homepage: "Projects Browser"
iv: "Interconnection View"
iv: "Interconnection view"
kerml: "KerML"
mbse: "Model-Based Systems Engineering"
obeo-url: ""
Expand All @@ -35,9 +33,10 @@ asciidoc:
source-code-url: "https://github.com/eclipse-syson/syson"
status-exp: "Status: Experimental"
status-stable: "Status: Stable"
stv: "State Transition View"
sysmlv1: "SysML v1"
sysmlv2: "SysML v2"
stv: "State Transition view"
sysml: "SysML"
sysmlv1: "{sysml} v1"
sysmlv2: "{sysml} v2"
sw: "Sirius Web"
validation: "Validation"
website-url: "https://eclipse.dev/syson/"
8 changes: 4 additions & 4 deletions doc/content/modules/developer-guide/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ git clone https://github.com/eclipse-syson/syson.git
image::environment-m2e-version.png[m2e version]
+
. Retrieve the source code or fork it if you want to make contribution
. Import _backend_ plugins from syson repository in your workspace
. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build
. Import _backend_ plugins from {product} repository in your workspace
. Update _settings.xml_ file from your _.m2_ folder to give access to other repositories during the build
In order to see dependance with access to add in _settings.xml_, have a look on _backend\application\syson-application\pom.xml_
You need to create https://github.com/settings/tokens[access tokens] on Github to complete _settings.xml_.
+
image::environment-settings.png[settings file]
+
+
. Right click on _syson-services_ module and then _Properties>JavaBuildPath>Source_
Add _main/generated_ folder and remove _excluded_ content and former _antlr/grammar_
You should retrieve the following _Java build path_
+
image::environment-java-build-path.png[Java build path]
+
+
. Update Maven project by launching "ALT+F5" shortcut on all modules of your workspace
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= How to install {product}?

This section delves into the detailed step-by-step instructions for installing {product}.
Each step is clearly explained to guide you through the process.
Detailed explanations walk you through each step.

[INFO]
====
Expand All @@ -11,7 +11,7 @@ Before you proceed with the installation, please ensure you have the following x
* https://www.docker.com/[Docker] installed, or an existing xref:requirements.adoc[supported database] installation with a user that has administrator privileges.
====

== Get SysON
== Get {product}
[#download]

{product} is distributed as a single _executable Java Archive_ (JAR) which contains the complete {product} application along with all its dependencies.
Expand All @@ -23,13 +23,13 @@ To download the latest pre-built JAR for {product}, follow these steps:
. Identify the {product} latest available version for download.
+
image::latest-version.png[Latest version]
. Click on the latest version to open its specific page.
. Click the latest version to open its specific page.
. In the `Assets` section, locate the JAR file named `{product-jar}`.
+
image::download.png[Download JAR file]
. Click on the JAR file to initiate the download to your local machine.
. Click the JAR file to start the download to your local machine.

This process ensures that you obtain the most recent version of the {product} application in the form of a pre-built JAR file.
This process ensures that you get the most recent version of the {product} application in the form of a pre-built JAR file.

== Start the database instance

Expand Down
46 changes: 23 additions & 23 deletions doc/content/modules/user-manual/pages/contribute.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
= Contribute

== Make a Difference!
== Make a difference

{product} is an open source project and, we encourage everyone to participate and contribute to its development!
There are numerous ways to contribute, including:
{product}, being an open source project, encourages everyone to contribute to its development.
You can contribute to {product} in different ways, including:

* Joining our active community forum,
* Joining the active community forum,
* Identifying and reporting bugs,
* Proposing new features,
* Enhancing the documentation,
Expand All @@ -14,42 +14,42 @@ There are numerous ways to contribute, including:

== Get involved

=== Joining the Forum
=== Joining the forum

For any questions or inquiries, don't hesitate to participate in our xref:user-manual:forum.adoc[forum] on GitHub.
For any questions or inquiries, don't hesitate to contribute in the xref:user-manual:forum.adoc[forum] on GitHub.

=== Sharing your Feedback
=== Sharing your feedback

Your feedback is crucial to the continuous improvement of {product}.
If you believe something is missing, encounter strange behavior, or simply want to express your satisfaction with the current state, feel free to share your thoughts.
If you believe something is missing, meet strange behavior, or want to express your satisfaction with the current state, feel free to share your thoughts.

[#reporting-issues]
=== Reporting issues

Bug reports are essential, so please report any issues you encounter.
When reporting bugs, provide detailed descriptions, reproducible tests, example code, or any other relevant information that can aid in resolving the issue.
Bug reports are essential, so report any issues you meet.
When reporting bugs, offer detailed descriptions, reproducible tests, example code, or any other relevant information that can aid in resolving the issue.

Our issue tracker is hosted on GitHub: {bug-url}.
The issue tracker is hosted on GitHub: {bug-url}.

To submit a new issue, you'll need a GitHub account.
For guidance on searching for issues, refer to GitHub's help page.
For guidance on searching for issues, see GitHub's help page.

=== Enriching the Documentation
=== Enriching the documentation

Have you found errors or inconsistencies in our documentation?
We welcome your contributions!
Have you found errors or inconsistencies in the documentation?
We welcome your contributions.

{product}’s documentation resides on GitHub: {source-code-url}/tree/main/doc.
{product}’s documentation can be found on GitHub: {source-code-url}/tree/main/doc.

Clone our repository, update the documentation, and trigger a pull request.
Our documentation is written in AsciiDoc syntax, making it straightforward to contribute.
Refer to the developer guide's Documentation section for insights into our documentation building process.
Clone the repository, update the documentation, and trigger a pull request.
The documentation is written in AsciiDoc syntax, making it straightforward to contribute.
Refer to the developer guide's Documentation section for insights into the documentation building process.

== Contributing to the Code
== Contributing to the code

{product}'s code is hosted on GitHub, making it simple to retrieve and build from source.
Simply clone our repository, make your modifications, align them with our requirements, and initiate a pull request.
{Product} leverages GitHub for code hosting, enabling straightforward retrieval and source-code builds.
Clone the repository, make your modifications, align them with {product} requirements, and start a pull request.

Follow the xref:developer-guide:index.adoc[developer guide] to gain insights into setting up your development environment and get started with contributing to the {product} codebase.

Embark on your {product} contribution journey today!
Embark on your {product} contribution journey today.
14 changes: 7 additions & 7 deletions doc/content/modules/user-manual/pages/faq/faq.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
= Frequently Asked Questions

Here are answers to questions we are frequently asked.
Here are answers to questions we're often asked.
If you have a question not addressed here, please xref:ROOT:help.adoc[contact us].

== General Questions
== General questions

.What is {product}?
.What's {product}?
[%collapsible]
====
To understand the intent of {product}, refer to the xref:user-manual:what-is.adoc[What is?] section in the user manual.
To understand the intent of {product}, refer to the xref:user-manual:what-is.adoc[What's?] section in the user manual.
====

.What are the key features of {product}?
Expand Down Expand Up @@ -42,14 +42,14 @@ To import /export models, read the xref:user-manual:integration/interoperability
====

* xref:user-manual:features/collaboration.adoc[How do I collaborate with others on models?]
* xref:user-manual:what-is.adoc[What is the difference between {product} and other SysML modeling tools?]
* xref:user-manual:what-is.adoc[What is the difference between {product} and other {sysml} modeling tools?]

== Troubleshooting

* xref:installation-guide:requirements.adoc[What are the recommended system requirements for {product}?]
* xref:user-manual:contribute.adoc#reporting-issues[How do I report bugs or submit feature requests?]

== Advanced Questions
== Advanced questions

.How do I customize the user interface of {product}?
[%collapsible]
Expand All @@ -76,7 +76,7 @@ Does {product} provides a method?

Model 2 Doc ?

== Additional Resources
== Additional resources

* xref:ROOT:index.adoc[{product} documentation]
// * xref:ROOT:help.adoc[Community forums and support channels]
Expand Down
27 changes: 0 additions & 27 deletions doc/content/modules/user-manual/pages/faq/ocp.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
= {afv}

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.
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]

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 xref:ROOT:help.adoc[contact us] for more details.
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 xref:ROOT:help.adoc[contact us] for more details.

2 changes: 2 additions & 0 deletions doc/content/modules/user-manual/pages/features/admin.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
= Administration

include::user-manual:partial$before-you-start-os-experimental-all.adoc[]

13 changes: 7 additions & 6 deletions doc/content/modules/user-manual/pages/features/cm.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
= Version Control and change management
= Version control and change management

No built-in versioning tools exists in SysOn for now.
{product} doesn't include built-in version control tools.

If user want to control version of its project, user can use an external Git repository.
Indeed, for each version/iteration of its project, user can xref:hands-on/how-tos/project-management.adoc#download-project[download] its project.
Then user merges the zip archive result on the Git repository.
If you want to manage different versions of your project, you can use an external Git repository.
Here's how:
* For each version or iteration of your project, you can download it as a zip archive by following these instructions: xref:hands-on/how-tos/project-management.adoc#download-project[download project].
* Then you can integrate the downloaded zip archive into your Git repository.

Feel free to xref:ROOT:help.adoc[contact us] for more details.
Feel free to xref:ROOT:help.adoc[contact us] for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
Various solutions exist for collaborating with {product}.
Explore different collaboration methods to enhance your teamwork and communication within {product}.

* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/project-management.adoc#share-project[share projects], models, and xref:hands-on/how-tos/representation-operations.adoc#share-representation[diagrams] using straightforward methods.
* *Share Projects, Models, Diagrams*: Collaborating in {product} is a breeze with the ability to xref:hands-on/how-tos/project-management.adoc#share-project[share projects], models, and xref:hands-on/how-tos/representation-operations.adoc#share-representation[diagrams].
Sharing projects and models is as simple as providing a link, similar to the process of sharing diagrams.
* xref:integration/interoperability.adoc[*Exchange* Projects or Models].
2 changes: 2 additions & 0 deletions doc/content/modules/user-manual/pages/features/details.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= {details}

include::user-manual:partial$before-you-start-os-experimental-all.adoc[]

The {details} view provides a comprehensive overview of the selected element, presenting distinct _Property_ sections for each _characteristic_ of the semantic object.

image::details-right-sidebar-details.png[{details}]
Expand Down
33 changes: 11 additions & 22 deletions doc/content/modules/user-manual/pages/features/editor.adoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,14 @@
= {editor}

.Before you Start
[caption=]
====
// Edition
include::user-manual:partial$feature-edition-os.adoc[]
// Status
include::user-manual:partial$feature-status-stable.adoc[]
// Usage
include::user-manual:partial$feature-usage-all.adoc[]
====
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]

== What's' the {editor} ?

The **{editor}** page serves as the primary workspace for editing project content.

== Find your way around

For those new to {product}, the initial experience with the application may feel a bit challenging.
For those new to {product}, the initial experience with the application might feel a bit challenging.
To help you navigate seamlessly and Kickstart collaboration with your team, we provide a guided tour for you to familiarize yourself with the platform.

The {editor} features four distinct regions: a <<Toolbar>>, a <<Left Sidebar>>, a main <<Editor>>, and a <<Right Sidebar>>.
Expand All @@ -28,26 +17,26 @@ The layout has been simplified to ensure a clear understanding of the content wi
image::editor.png[{editor}]

=== Toolbar
The toolbar houses a selection of actions categorized into three groups: ': _Homepage_, _Project Actions_ (with the name of the project) and _Help_.
The toolbar houses a selection of actions categorized into three groups: _Homepage_, _Project Actions_ (with the name of the project) and _Help_.

image::editor-toolbar.png[{editor} Toolbar]

include::user-manual:partial$homepage-action.adoc[leveloffset=+3]

[#project-actions]
==== Projects Actions
==== Projects actions

Access project-level actions like _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, access project _xref:hands-on/how-tos/project-management.adoc#project-settings[settings]_, _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_.
Access project-level actions such as _xref:hands-on/how-tos/project-management.adoc#rename-project[rename]_, _xref:hands-on/how-tos/project-management.adoc#download-project[download]_, access project _xref:hands-on/how-tos/project-management.adoc#project-settings[settings]_, _xref:hands-on/how-tos/project-management.adoc#delete-project[delete]_.

image::editor-projectActions.png[{editor} Project Actions]

For further actions, refer to: xref:hands-on/hands-on.adoc[]
For further actions, see: xref:hands-on/hands-on.adoc[]

include::user-manual:partial$help-action.adoc[leveloffset=+3]

=== Left Sidebar
=== Left sidebar

The left sidebar contains different views like the xref:features/explorer.adoc[{explorer}] and the xref:features/validation.adoc[{validation}] to assist you working on your project.
The left sidebar has different views such as the xref:features/explorer.adoc[{explorer}] and the xref:features/validation.adoc[{validation}] to assist you working on your project.

[NOTE]
====
Expand All @@ -65,17 +54,17 @@ xref:hands-on/how-tos/user-interface-navigation.adoc#switch-left-sidebar[Explore

The main area to edit your models and representations.
You can open as many editors as you like.
The {editor} area contains one or more editors.
The {editor} area has 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
=== Right sidebar

The right sidebar contains different views like the xref:features/details.adoc[{details}], the xref:features/representations-view.adoc[{representations-view}] and the xref:features/related-elements.adoc[{related-elements}] views to ...
The right sidebar contains different views such as the xref:features/details.adoc[{details}], the xref:features/representations-view.adoc[{representations-view}] and the xref:features/related-elements.adoc[{related-elements}] views to ...

[NOTE]
====
Expand Down
Loading

0 comments on commit 26f91bc

Please sign in to comment.