Skip to content

Commit

Permalink
[doc] Different fixes in documentation
Browse files Browse the repository at this point in the history
Contribute to troubleshooting.adoc
Add missing information in extend.adoc and contribute.adoc pages
Remove duplicated extend.adoc file
Update application start command line argument in install.adoc

Signed-off-by: Mélanie Bats <melanie.bats@obeo.fr>
  • Loading branch information
mbats committed Jul 1, 2024
1 parent 43b3eb5 commit ca60e6c
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 21 deletions.
7 changes: 5 additions & 2 deletions doc/content/modules/developer-guide/pages/extend.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
= Customization and extensions

{product} is extendable, making use of an open source low-code platform called https://eclipse.dev/sirius/sirius-web.html{sw}.
{product} is extendable, making use of an open source low-code platform called https://eclipse.dev/sirius/sirius-web.html[{sw}].
The platform enables the contribution of new specific views and the specific methodologies implementation.
With {sw}, users can seamlessly extend {product}'s capability to meet their specific requirements, such as creating dedicated libraries or contributing specific metadata by adding new representations.
Extensibility is a key strength of {product}, offering organizations the potential to enhance their System Engineering `SE` processes within the tool, ensuring consistency in modeling practices throughout their SE practitioners.
Extensibility is a key strength of {product}, offering organizations the potential to enhance their System Engineering `SE` processes within the tool, ensuring consistency in modeling practices throughout their SE practitioners.
Interested in extending {product}?
Feel free to xref:ROOT:help.adoc[contact us] for more details.
25 changes: 22 additions & 3 deletions doc/content/modules/installation-guide/pages/how-tos/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ Before you proceed with the installation, please ensure you have the following x
{product} is distributed as a single _executable Java Archive_ `JAR` which contains the complete {product} application along with all its dependencies.
This distribution simplifies the setup process, enabling convenient exploration of {product}'s features.

[CAUTION]
.Stable versions
====
Only `YEAR.MONTH.0` versions are stable and suitable for production deployments.
Other versions, such as intermediate releases, are intended solely for testing purposes.
They're not recommended for production use due to their potential for further changes and instability.
Always use the stable `.0` releases for any production environments to ensure reliability and support.
For more details see xref:user-manual:cycle.adoc[].
====

To download the latest pre-built JAR for {product}, follow these steps:

. Before you begin the installation process, navigate to the {packages-url}[download] page for `{product-jar}` to access all versions.
Expand Down Expand Up @@ -49,6 +59,16 @@ docker run -p 5434:5432 --name syson-postgres \
-d postgres
----

[TIP]
====
For Windows users, here is the same command on one line:
[source, bash]
----
docker run -p 5434:5432 --name syson-postgres -e POSTGRES_USER=dbuser -e POSTGRES_PASSWORD=dbpwd -e POSTGRES_DB=syson-db -d postgres
----
====

[NOTE]
====
This may take a while the first time you run this as Docker will first pull the PostgreSQL image.
Expand All @@ -66,11 +86,10 @@ Go to the folder containing the {product-jar} and run the command:"

[source, bash]
----
java -jar syson-application.jar \
java -jar path\to\your\syson-application-YEAR.MONTH.0.jar \
--spring.datasource.url=jdbc:postgresql://localhost:5434/syson-db \
--spring.datasource.username=dbuser \
--spring.datasource.password=dbpwd \
--spring.liquibase.change-log=classpath:db/changelog/syson.db.changelog.xml
--spring.datasource.password=dbpwd
----

== Open your web browser
Expand Down
29 changes: 27 additions & 2 deletions doc/content/modules/installation-guide/pages/troubleshooting.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
= Troubleshooting

Even the most straightforward installation process can encounter unforeseen issues.
Even the most straightforward installation process can meet unforeseen issues.
This section offers comprehensive troubleshooting tips and solutions to common problems encountered during installation.

If you encounter any troubleshooting, please xref:ROOT:help.adoc[contact us] to have solution and to share your troubleshooting to this page.
If you meet any troubleshooting, please xref:ROOT:help.adoc[contact us] to have solution and to share your troubleshooting to this page.

== Connection refused
If the server fails to start and displays a `Connection refused` error such as:
[source, bash]
----
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'liquibase' defined in class path resource [org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration$LiquibaseConfiguration.class]: org.postgresql.util.PSQLException: Connection to localhost:5434 refused.
----

Make sure you have a clean database running without any earlier data, and start the server.
You should delete your existing container `docker rm syson-postgres` and even the image `docker rmi image-ID` to ensure a fresh start.

== Changelog not found
If the server fails to start and displays `changelog.xml not found` error such as:
[source, bash]
----
Application run failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'liquibase' defined in class path resource [org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration$LiquibaseConfiguration.class]: ERROR: The file 'classpath:db/changelog/syson.db.changelog.xml' was not found.
----

Make sure you have included the correct argument to your `java` command according to your {product} version.

TIP: Check that you are consulting the documentation version that matches the JAR version you are trying to run.

Refer to the xref:installation-guide:install.adoc#start-app[] section for detailed instructions according to your version.
2 changes: 1 addition & 1 deletion doc/content/modules/user-manual/pages/contribute.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Embark on your {product} contribution journey today.

We invite organizations to join us in supporting the ongoing development and enhancement of {product}.
Your sponsorship can help us expand the capabilities of this open source project, ensuring it continues to meet the needs of the system engineering community.
If you are interested in sponsoring {product}, please xref:ROOT:support.adoc[reach out to us] to discuss sponsorship opportunities and how your support can make a difference.
If you are interested in sponsoring {product}, please xref:user-manual:support.adoc[reach out to us] to discuss sponsorship opportunities and how your support can make a difference.
18 changes: 17 additions & 1 deletion doc/content/modules/user-manual/pages/cycle.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,20 @@ Contributions are reviewed and merged by core developers.
* Community: a diverse group of users, testers, and enthusiasts who provide feedback, report bugs, and propose new features.

This collaborative approach allows {product} to continuously evolve while maintaining a high standard of quality and performance.
If you're interested in contributing or have any questions, feel free to join the xref:user-manual:forum.adoc[community discussions] or xref:user-manual:help.adoc[contact us].
If you're interested in contributing or have any questions, feel free to join the xref:user-manual:forum.adoc[community discussions] or xref:user-manual:help.adoc[contact us].

== Version and release policies

{product} adheres to a CalVer (Calendar Versioning) strategy to communicate the timeline and stability of its releases.
The versioning follows a `YEAR.MONTH.PATCH` format, where:

* `YEAR.MONTH.0`: These are the stable releases, marking significant milestones or major updates.
For example, a version like 2024.5.0 indicates a stable release from May 2024.
* Intermediate Releases: Between the .0 versions, there may be multiple intermediate releases, denoted by increasing the `PATCH` number (for example 2024.5.1, 2024.5.2).
These are intended to provide updates, fixes, and incremental improvements leading up to the next stable release.

Stable versions (.0 versions) are recommended for production environments, while intermediate versions offer early access to new features and fixes but might undergo further changes before the next stable release.

This strategy ensures that users can rely on a predictable and transparent update cycle, aligning with the continuous evolution and enhancement of {product}.

For all details about the different versions, see the https://github.com/eclipse-syson/syson/blob/main/CHANGELOG.adoc:`CHANGELOG`.
4 changes: 2 additions & 2 deletions doc/content/modules/user-manual/pages/faq/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -238,14 +238,14 @@ For further help, consult the xref:user-manual:forum.adoc[community forum] or co
====
No, {product} doesn't include a method by default.
However, being based on https://eclipse.dev/sirius/sirius-web.html[Sirius Web], {product} is inherently extendable.
Refer to the xref:user-manual:integration/extend.adoc[] page or xref:user-manual:help.adoc[contact us] for help.
Refer to the xref:developer-guide:extend.adoc[] page or xref:user-manual:help.adoc[contact us] for help.
====

.*Is it possible to generate documentation from {product} models?*
[%collapsible%open]
====
Yes, {product} can integrate with model-to-text solutions such as https://www.m2doc.org/[M2Doc].
Refer to the xref:user-manual:integration/extend.adoc[] page or xref:user-manual:help.adoc[contact us] for help.
Refer to the xref:developer-guide:extend.adoc[] page or xref:user-manual:help.adoc[contact us] for help.
====

== Additional resources
Expand Down
9 changes: 0 additions & 9 deletions doc/content/modules/user-manual/pages/integration/extend.adoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
* xref:user-manual:integration/developer-guide.adoc[]
* xref:user-manual:integration/extend.adoc[]
* xref:developer-guide:extend.adoc[]
* xref:user-manual:integration/interoperability.adoc[]
* xref:user-manual:integration/capella.adoc[]
* xref:user-manual:integration/api.adoc[]

0 comments on commit ca60e6c

Please sign in to comment.