Skip to content

Commit

Permalink
[doc] Complete empty documentation pages
Browse files Browse the repository at this point in the history
- complete empty diagram page,
- fix wrong numbering steps,
- complete empty requirement page,
- complete empty version control page,
- fix broken links to some pages,
- remove duplicate collaborative page,
- normalize caution/warning blocks,
- complete release note,
- clean unused pages,
- complete environment installation page
- update homepage,
- update menu with summary...

Signed-off-by: Jessy Mallet <[email protected]>
  • Loading branch information
jessymallet committed May 27, 2024
1 parent d93e981 commit 5e7a09c
Show file tree
Hide file tree
Showing 96 changed files with 428 additions and 298 deletions.
2 changes: 2 additions & 0 deletions doc/content/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,6 @@ include::user-manual:partial$nav-updates.adoc[]
--
+
* xref:user-manual:faq/faq.adoc[]
* xref:product-legal:index.adoc[]
14 changes: 14 additions & 0 deletions doc/content/modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Frequently Asked Questions

Find answers to questions we're frequently asked.

[cols="1*^", %noheader, frame=none, grid=none]
|===
a|image::travel_explore.svg[xref=user-manual:faq/faq.adoc]

*FAQ*

Explore answers to questions we're frequently asked.

xref:user-manual:faq/faq.adoc[Explore]
|===
10 changes: 5 additions & 5 deletions doc/content/modules/ROOT/pages/features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand All @@ -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]

|===
16 changes: 8 additions & 8 deletions doc/content/modules/ROOT/pages/get-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ Discover essential entry points for installation procedures and a quick tour des

[cols="3*^", %noheader, frame=none, grid=none]
|===
a|image::explore.svg[xref=installation-guide:index.adoc]

*How to install {product} ?*

Covers installation of {product}

xref:installation-guide:index.adoc[Install {product}]

a|image::person_play.svg[xref=installation-guide:requirements.adoc]

*Read the installation's prerequisites ?*
Expand All @@ -20,6 +12,14 @@ Installation requirements to run {product}

xref:installation-guide:requirements.adoc[Learn more]

a|image::explore.svg[xref=installation-guide:index.adoc]

*How to install {product} ?*

Covers installation of {product}

xref:installation-guide:index.adoc[Install {product}]

a|image::sprint.svg[xref=user-manual:hands-on/tutorials/batmobile.adoc]

*Follow a quick start guide for new users ?*
Expand Down
4 changes: 3 additions & 1 deletion doc/content/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ include::ROOT:integration.adoc[leveloffset=+1]

include::ROOT:help.adoc[leveloffset=+1]

include::ROOT:release-notes.adoc[leveloffset=+1]
include::ROOT:release-notes.adoc[leveloffset=+1]

include::ROOT:faq.adoc[leveloffset=+1]
3 changes: 0 additions & 3 deletions doc/content/modules/ROOT/pages/scaling.adoc

This file was deleted.

4 changes: 0 additions & 4 deletions doc/content/modules/ROOT/pages/troubleshooting.adoc

This file was deleted.

9 changes: 5 additions & 4 deletions doc/content/modules/ROOT/pages/user-interface-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
|===
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 20 additions & 1 deletion doc/content/modules/developer-guide/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,23 @@ git clone https://github.com/eclipse-syson/syson.git

== Setting Up your Development Environment

//TODO
. Download your coding environment https://spring.io/tools[Spring Tools 4.22.0]
. Ensure that m2e version from your environment is 2.6.0
+
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
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
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.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Configure Anti-virus software for use with {product} server

While we cannot directly recommend specific antivirus software for use with {product} applications, we would like to advise our customers that if you are experiencing slowness with your {product} application, try running it with virus checking disabled.
While we can't directly recommend specific antivirus software for use with {product} applications, we want to advise our customers that if you are experiencing slowness with your {product} application, try running it with virus checking disabled.

Due to the high volume of temporary files generated by {product} applications, antivirus software can significantly impact performance by causing excessive disk I/O and resource contention.
In some cases, even disabling antivirus software might not be sufficient to resolve performance issues.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ docker run -p 5434:5432 --name syson-postgres \
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.
If you don't have Docker or prefer to use 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.

== Start the application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,10 @@ It's recommended to use the Java runtime provided by the https://adoptium.net/fr

=== Supported browsers

Users can interact with the central server through following web browsers:

[%noheader]
|===
|*Browsers*
a|*Desktop browsers:*

* *Chrome* latest stable version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
Even the most straightforward installation process can encounter unforeseen issues.
This section offers comprehensive troubleshooting tips and solutions to common problems encountered during installation.

//TODO
If you encounter any troubleshooting, please xref:ROOT:help.adoc[contact us] to have solution and to share your troubleshooting to this page.
2 changes: 0 additions & 2 deletions doc/content/modules/sirius-web/README

This file was deleted.

3 changes: 0 additions & 3 deletions doc/content/modules/sirius-web/assets/README

This file was deleted.

3 changes: 0 additions & 3 deletions doc/content/modules/sirius-web/assets/attachments/README

This file was deleted.

3 changes: 0 additions & 3 deletions doc/content/modules/sirius-web/assets/images/README

This file was deleted.

3 changes: 0 additions & 3 deletions doc/content/modules/sirius-web/examples/README

This file was deleted.

Loading

0 comments on commit 5e7a09c

Please sign in to comment.