Skip to content

Commit

Permalink
Fix FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
mbats committed Jun 25, 2024
1 parent 26f91bc commit daa99e9
Show file tree
Hide file tree
Showing 23 changed files with 370 additions and 146 deletions.
20 changes: 11 additions & 9 deletions doc/content/modules/ROOT/pages/security-policy.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
= Security policy

== Supported versions
{product} is an open source project maintained by a community of dedicated contributors.
While we strive to ensure the highest security standards, our support and maintenance are provided on a best-effort basis.

The versions of the project that are supported with security updates.
Here are the key points of the {product} security policy:

[]
|===
|Version | Supported
* Supported Versions: We don't officially designate specific versions as supported or unsupported.
The efforts are focused on maintaining and improving the latest release.
* Issue Handling: Security fixes and updates are applied only to the latest release.
Users are encouraged to upgrade to the latest version to benefit from the latest security enhancements and fixes.
* Professional Support: For users with specific security needs or who require support beyond the community-driven efforts, we recommend seeking professional support.
This can offer dedicated help and tailored solutions to meet your unique requirements.
|2023.12
| icon:check
|===
If you have specific security concerns or need more in-depth support, please consider professional services that can offer comprehensive security solutions and ongoing maintenance for your {product} deployment.

== Reporting a vulnerability

You can report a vulnerability by contacting us via our xref:user-manual:support.adoc[support] page.
You can report a vulnerability by contacting us through the xref:user-manual:support.adoc[support] page.
2 changes: 1 addition & 1 deletion doc/content/modules/developer-guide/pages/extend.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Customization and extensions

{product} is extendable, making use of an open source low-code platform called {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.
31 changes: 31 additions & 0 deletions doc/content/modules/installation-guide/pages/how-tos/https.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
= Configuring HTTPS for local server deployment of {product}

[WARNING]
====
Enabling HTTPS with a self-signed certificate is intended for testing purposes only and shouldn't be used in a production environment.
Self-signed certificates don't provide the same level of security and trust as certificates issued by a trusted Certificate Authority (CA).
For production deployments, obtain a valid certificate from a trusted CA to ensure secure and reliable communication.
====

If you intend to install {product} on a local server or machine and allow several users to access it, you must enable HTTPS.
If you don't have a certificate, you can generate one by using https://docs.oracle.com/en/java/javase/11/tools/keytool.html[keytool] for testing purposes only.

. Create a self-signed certificate:
+
[source, bash]
----
keytool -genkeypair -alias myalias -keyalg RSA -keysize 2048 -validity 365 -keystore keystore.jks
----
. Place the certificate file next to your `{product}-application` JAR file
. Launch your JAR (as explained in the xref:installation-guide:how-tos/install.adoc#start-app[start the application section] with the following extra properties:
+
[source, bash]
----
--server.ssl.key-store=./keystore.jks \
--server.ssl.key-store-password=PASSWORD_USED_IN_STEP_1 \
--server.ssl.key-store-type=JKS \
--server.ssl.key-alias=myalias \
--server.ssl.key-password=PASSWORD_USED_IN_STEP_1
----
. Every user in your local network can now access the application at:
`https://{product}_SERVER_IP:8080`
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Before you proceed with the installation, please ensure you have the following x
== Get {product}
[#download]

{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, allowing for easy exploration of {product}'s features.
{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.

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

Expand Down Expand Up @@ -57,6 +57,7 @@ This may take a while the first time you run this as Docker will first pull the
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-app]
== Start the application

To run the application, you'll need to use the Java Runtime Environment (JRE) to execute the pre-build JAR ({product-jar}) you xref:how-tos/install.adoc#download[downloaded] earlier.
Expand All @@ -80,4 +81,7 @@ To end your local testing session, ensure you stop the running PostgreSQL Docker
Please note that this will erase all the data you have generated during testing.
====

If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.

== Other resources
xref:installation-guide:how-tos/https.adoc[]
1 change: 1 addition & 0 deletions doc/content/modules/installation-guide/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
// Each navigation file must be declared in the component descriptor if you want it to be displayed in the component’s navigation menu.
* xref:installation-guide:requirements.adoc[]
* xref:installation-guide:how-tos/install.adoc[]
* xref:installation-guide:how-tos/https.adoc[]
* xref:installation-guide:troubleshooting.adoc[]
* xref:installation-guide:migration-process.adoc[]
6 changes: 3 additions & 3 deletions doc/content/modules/user-manual/pages/best-practices.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
= {product} Best Practices
= {product} best practices

Explore in-depth or quickly grasp best Practices and tips.
Explore in-depth or quickly grasp best-practices and tips.

== Best practices

A compilation of in-depth guides to help you make the most of {product}.

{product} invites contributions of best practices from end user on system engineering subjects for example but also from the specifier/developer on the design of DSL view for example.
{product} invites contributions of best practices from users on systems engineering topics, as well as from studio makers and developers on {product} extensions.

Please xref:ROOT:help.adoc[contact us] to share your best practices.

Expand Down
34 changes: 33 additions & 1 deletion doc/content/modules/user-manual/pages/cycle.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
= {product} dev cycle
= {product} development cycle

{product}, as an open source project, follows a well-defined development cycle to ensure regular and structured updates.
The cycle spans 8 weeks and includes three main phases:

* Development (4 Weeks):
* Focus: This phase is dedicated to actively working on new features, bug fixes, and enhancements.
* Activities: Contributors, including community members and core developers, work together to develop new functionalities, perform code reviews, and integrate changes.
Collaboration and transparency are key during this phase.
* Stabilization and Feature Freeze (2 Weeks):
* Focus: We enter a feature freeze period where no new features are introduced.
* Activities: During this time, the focus shifts to thorough testing and stabilization of the new features.
This ensures the software's quality and reliability.
Any remaining issues or bugs are addressed to prepare for the release.
* Cool Down and Planning (2 Weeks):
* Focus: This phase involves wrapping up the current cycle and preparing for the next one.
* Activities: Contributors work on upgrading dependencies, resolving minor issues, and documenting the latest changes.
Additionally, the team discusses and plans the features and tasks for the next cycle, ensuring a smooth transition.
The General Availability (GA) release of {product} occurs on the eighteenth week of each development cycle.
== Team Organization

Being an open source project, {product} thrives on community participation and collaboration.
Here's how the team is organized:
* Core Developers: these are the primary maintainers who oversee the project's direction, manage releases, and ensure code quality.
* Contributors: this includes anyone from the community who contributes code, documentation, or ideas.
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].
Loading

0 comments on commit daa99e9

Please sign in to comment.