Skip to content

Commit

Permalink
[doc] Complete documentation on views
Browse files Browse the repository at this point in the history
- Add general view documentation,
- Add interconnection view documentation,
- Add generic behavior documentation,
- complete/update hands-on documentation.

Signed-off-by: Jessy Mallet <[email protected]>
  • Loading branch information
jessymallet committed Apr 25, 2024
1 parent 57b3955 commit 6f14803
Show file tree
Hide file tree
Showing 172 changed files with 1,401 additions and 1,280 deletions.
11 changes: 10 additions & 1 deletion doc/README
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,13 @@ One sentence per line.
Use asciidoc attributes to reference elements of the application UI.
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
Use + on new line in table to force a new line

# Antora use
* Ensure that docker is launch
## on linux
* Launch the script SysON\doc\generate.bash in a terminal
## on Windows
* Lunch the script SysON\doc\generate.bash in a Windows Power shell console
## Result
* Generation result is available in SysON\doc\docs-site\build\site
2 changes: 2 additions & 0 deletions doc/content/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= Welcome to {product}

SysON represents an open-source web-based tooling to edit SysML v2 models. It includes a set of editors (graphical, textual, form-based, etc.) enabling users to build the various parts of system models.

Start your learning journey with {product}.

include::overview.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ Before you proceed with the installation, please ensure you have the following x

{product} uses PostgreSQL as its database.

TIP: For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker.
[TIP]
====
For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker.
====

[source, bash]
----
Expand All @@ -26,7 +29,10 @@ docker run -p 5434:5432 --name syson-postgres \
-d postgres
----

NOTE: This may take a while the first time you run this as Docker will first pull the PostgreSQL image.
[NOTE]
====
This may take a while the first time you run this as Docker will first pull the PostgreSQL image.
====

If you don't have Docker or prefer to utilize an existing PostgreSQL installation, modify the following command-line parameters and ensure the `POSTGRES_USER` possesses administrative rights on the database.
These rights are necessary for the automatic creation of the database schema.
Expand Down
15 changes: 12 additions & 3 deletions doc/content/modules/installation-guide/pages/requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ Before installing {product}, make sure you have the right software and infrastru
These system prerequisites lay the foundation for optimal performance and functionality, guaranteeing that {product} operates efficiently on your environment.
Take a moment to review and align your system with the recommended specifications outlined below to ensure a smooth installation and a robust user experience.

NOTE: If a platform and version is not listed on this page, it means we don't test it, fix bugs or provide assistance for it.
[NOTE]
====
If a platform and version is not listed on this page, it means we don't test it, fix bugs or provide assistance for it.
====

[#server-req]
== Server-side installation requirements
Expand Down Expand Up @@ -74,7 +77,10 @@ Please note that {product} is currently not supported on mobile devices.

WARNING: {product} does not support Internet Explorer.

NOTE: We support a minimum screen resolution of 1024 x 768 (when browsers are maximized).
[NOTE]
====
We support a minimum screen resolution of 1024 x 768 (when browsers are maximized).
====

=== Supported operating system

Expand All @@ -85,7 +91,10 @@ The minimum operating system (OS) requirements are:
* Any Linux OS that supports the browsers mentioned above
* Any Chrome OS that supports the browsers mentioned above

NOTE: You can find out what browser and operating system version you’re using via https://www.whatsmybrowser.org/[What’s my Browser].
[NOTE]
====
You can find out what browser and operating system version you’re using via https://www.whatsmybrowser.org/[What’s my Browser].
====

[CAUTION]
====
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 0 additions & 47 deletions doc/content/modules/user-manual/assets/images/editor-editor.svg

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6f14803

Please sign in to comment.