Skip to content

Commit

Permalink
Fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
mbats committed Jun 25, 2024
1 parent daa99e9 commit ee92674
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 41 deletions.
64 changes: 32 additions & 32 deletions doc/content/modules/user-manual/pages/faq/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,56 @@ If you have a question not addressed here, please xref:ROOT:help.adoc[contact us

== General questions

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

.What's the difference between {product} and other {sysml} modeling tools?
.*What's the difference between {product} and other {sysml} modeling tools?*
[%collapsible%open]
====
To understand the intent of {product}, see the xref:user-manual:what-is.adoc[What's?] section in the user manual.
====

.What are the key features of {product}?
.*What are the key features of {product}?*
[%collapsible%open]
====
To discover the {product} features, see the xref:user-manual:key-features.adoc[Key features] section in the user manual.
====

.What is your licensing model for your {sysmlv2} product?
.*What is your licensing model for your {sysmlv2} product?*
[%collapsible%open]
====
{product} is a free and open source product xref:product-legal:index.adoc[licensed under the Eclipse Public License v2].
====

.What are the supported {sysmlv2} modeling elements?
.*What are the supported {sysmlv2} modeling elements?*
[%collapsible%open]
====
To explore the supported {sysmlv2} elements, read the xref:user-manual:features/features.adoc[Features] section in the user manual.
====

.What are the supported diagram types?
.*What are the supported diagram types?*
[%collapsible%open]
====
To explore the supported {sysmlv2} views, read the xref:user-manual:features/features.adoc[Features] section in the user manual.
====

.To what extent will your tool comply with the {sysmlv2} specification?
.*To what extent will your tool comply with the {sysmlv2} specification?*
[%collapsible%open]
====
{product} aims at full compliance with the {sysmlv2} specification.
{product} already implements the OMG {sysmlv2} metamodel, including both a built-in {sysmlv2} and {kerml} implementation.
====

.To what extent will your tool comply with the Systems Modeling API & Services specification?
.*To what extent will your tool comply with the Systems Modeling API & Services specification?*
[%collapsible%open]
====
{product} aims at full compliance with the Systems Modeling API & Services specification.
====

.To what extent will your tool support collaborative modeling with configuration management?
.*To what extent will your tool support collaborative modeling with configuration management?*
[%collapsible%open]
====
As a web application, {product} is inherently collaborative.
Expand All @@ -63,19 +63,19 @@ We believe that organizations and users should have the freedom to choose their
For those requiring professional support, we recommend referring to the xref:user-manual:support.adoc[Professional support] page for information about how to .
====

.How do I create a new model?
.*How do I create a new model?*
[%collapsible%open]
====
To create a new model, read the xref:user-manual:hands-on/how-tos/model-management.adoc#create-model[Create a new model] section in the user manual.
====

.Will you have a beta version for customers to try? If yes, when will it be available?
.*Will you have a beta version for customers to try? If yes, when will it be available?*
[%collapsible%open]
====
{product} is free and open source, it's already available to try, see xref:installation-guide:index.adoc[installation guide].
====

.When do you plan to have a commercial version of your {sysmlv2} tool available and what capabilities will it support?
.*When do you plan to have a commercial version of your {sysmlv2} tool available and what capabilities will it support?*
[%collapsible%open]
====
{product} is an open source project, and as such, there is no planned commercial version directly from the project itself.
Expand All @@ -85,51 +85,51 @@ The project provides updates and fixes on a best-effort basis, specifically targ
For those requiring professional support, we recommend referring to the xref:user-manual:support.adoc[Professional support] page for information about how to obtain customized solutions and services that meet your specific needs.
====

.Will other software products be needed to use the {sysmlv2} tool?
.*Will other software products be needed to use the {sysmlv2} tool?*
[%collapsible%open]
====
No.
====

== Integration with other tools

.Will the {sysmlv2} tool support textual notation?
.*Will the {sysmlv2} tool support textual notation?*
[%collapsible%open]
====
{product} supports import and export with the textual notation.
Certain information within {product} can be edited by using the textual notation.
We're currently working on integrating {product} with SysIDE, an open source textual editor for the {sysmlv2} syntax.
====

.How do I import and export models?
.*How do I import and export models?*
[%collapsible%open]
====
To import /export models, read the xref:user-manual:integration/interoperability.adoc[Interoperability] section in the user manual.
====

* xref:user-manual:features/collaboration.adoc[How do I collaborate with others on models?]

.How will models developed in your tool, be shared with other vendor {sysmlv2} tools? Are there any limitations we should be aware of?
.*How will models developed in your tool, be shared with other vendor {sysmlv2} tools? Are there any limitations we should be aware of?*
[%collapsible%open]
====
We're fully compatible with the {sysmlv2} standard.
Models can be shared using the {sysmlv2} textual notation and the {sysmlv2} API.
====

.How will models in {sysmlv2} and models in {sysmlv1} co-exist?
.*How will models in {sysmlv2} and models in {sysmlv1} co-exist?*
[%collapsible%open]
====
{product} is a pure {sysmlv2} player.
Currently, {sysmlv1} models can't coexist within {product}, but coexistence might be possible within your {sysmlv1} tool.
====

.How do I integrate {product} with other tools or systems?
.*How do I integrate {product} with other tools or systems?*
[%collapsible%open]
====
{product} is a specialized tool for {sysmlv2}, focusing on the latest standards and methodologies, offering robust compatibility with {sysmlv2} through features such as textual notation support for model import/export, full compliance with the {sysmlv2} API for seamless integration with other tools, and ongoing integration efforts with Capella for enhanced model interoperability.
====

.How's your {sysmlv2} tool integrated with other products you offer?
.*How's your {sysmlv2} tool integrated with other products you offer?*
[%collapsible%open]
====
{product} is designed to be a specialized tool for {sysmlv2}, focusing on the latest standards and methodologies.
Expand All @@ -142,7 +142,7 @@ This facilitates sharing and integration with other {sysmlv2} compatible tools.
This will enable users to leverage {product}'s {sysmlv2} capabilities alongside Capella's powerful system architecture modeling tools, ensuring model interoperability.
====

.Will you have a method to convert {sysmlv1} models to {sysmlv2} models?
.*Will you have a method to convert {sysmlv1} models to {sysmlv2} models?*
[%collapsible%open]
====
While addressing {sysmlv1} model support is currently beyond the scope of {product}, we acknowledge its potential as a valuable extension for the tool.
Expand All @@ -158,82 +158,82 @@ We invite those who share our vision and are committed to enhancing {product}'s

== Extend {product}

.How do I customize the user interface of {product}?
.*How do I customize the user interface of {product}?*
[%collapsible%open]
====
{product} is an open source product, providing users with the flexibility to customize the user interface based on their specific needs.
Users can directly change the source code by forking the project and following the instructions in the developer guide to build their customized version.
For users seeking professional help or customization services, feel free to xref:user-manual:support.adoc[contact us] for personalized help with your customization requirements.
====

.How do I extend {product} with custom add-ons or extensions?
.*How do I extend {product} with custom add-ons or extensions?*
[%collapsible%open]
====
You can extend {product} with custom add-ons or extensions by using its modular architecture.
Refer to the developer documentation for guidelines on xref:developer-guide:extend.adoc[creating and integrating new modules].
For further help, consult the xref:user-manual:forum.adoc[community forum] or consider the xref:user-manual:support.adoc[professional support] options.
====

.What are the best practices for modeling complex systems with {product}?
.*What are the best practices for modeling complex systems with {product}?*
[%collapsible%open]
====
You can find and contribute to the xref:user-manual:best-practices.adoc[best-practices] page in the documentation.
====

.How do I learn more about {sysmlv2} modeling and best practices?
.*How do I learn more about {sysmlv2} modeling and best practices?*
[%collapsible%open]
====
To learn more about {sysmlv2} modeling and best practices, explore the official https://www.omgsysml.org/SysML-2.htm[{sysmlv2} website from the OMG], join the xref:user-manual:help.adoc[{product} online community], and consider attending webinars and industry conferences.
For hands-on learning, check out the xref:user-manual:hands-on/hands-on.adoc[{product} tutorials] and for more detailed guidance, refer to xref:user-manual:support.adoc[professional support options].
====

.Is there a mobile version of {product} available?
.*Is there a mobile version of {product} available?*
[%collapsible%open]
====
{product} is a web application that can be accessed from mobile devices; however,it's optimized for use with a minimum screen resolution of 1024 * 768 in a maximized browser window.
See xref:installation-guide:requirements.adoc[] for more details.
====

.How does version control work in {product}?
.*How does version control work in {product}?*
[%collapsible%open]
====
{product} doesn't include built-in version control, allowing users to integrate their preferred solutions.
For more details, see xref:user-manual:features/cm.adoc[].
====

.How do I access professional support for {product}?
.*How do I access professional support for {product}?*
[%collapsible%open]
====
To access professional support for {product}, refer to the xref:user-manual:support.adoc[] page in the documentation, which provides comprehensive information about how to get help and the services available.
====

.Is there a limit to the number of projects or models I can create in {product}?
.*Is there a limit to the number of projects or models I can create in {product}?*
[%collapsible%open]
====
Yes, refer to the xref:user-manual:features/scaling-limits.adoc[scaling limits] page for more details.
====

.How do I import and export models in {product}?
.*How do I import and export models in {product}?*
[%collapsible%open]
====
Read the xref:user-manual:integration/interoperability.adoc#import-export[] section of the documentation.
====

.What collaboration features are available in {product}?
.*What collaboration features are available in {product}?*
[%collapsible%open]
====
Read the xref:user-manual:features/collaboration.adoc[] page of the documentation.
====

.Does {product} provides a method?
.*Does {product} provides a method?*
[%collapsible%open]
====
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.
====

.Is it possible to generate documentation from {product} models?
.*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].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Below, we outline the primary scaling factors and limitations related to model s

* Maximum Model Size:
{product} is built to manage large models, but there are practical limits to its capacity.
The system can efficiently handle models up to about 10 GB in size.
The system can efficiently handle models up to about 10 MB in size.
Models larger than this might experience performance degradation, especially in terms of loading times and responsiveness.
* Impact on Performance:
As model size increases, users might meet longer loading times and slower response rates when performing operations such as editing or navigating the model.
Expand Down Expand Up @@ -52,7 +52,7 @@ Below, we outline the primary scaling factors and limitations related to model s
== Number of concurrent users

* User Capacity:
The system is designed to support up to 200 concurrent users on a single server.
The system is designed to support up to 80 concurrent users on a single server.
This capacity ensures that people can collaborate in real-time without encountering significant slowdowns or access issues.
* Collaboration Dynamics:
The performance of collaborative features, such as live editing and real-time updates, might vary depending on the number of users and the complexity of the operations being performed.
Expand All @@ -74,4 +74,6 @@ Below, we outline the primary scaling factors and limitations related to model s
This can help maintain smooth operation even as the scale of use increases.
* Contact us for custom solutions:
If your needs exceed the outlined limits or you require specific performance optimizations, please xref:ROOT:help.adoc[contact us].
Our team can provide tailored solutions and advice to ensure that {product} meets your scaling requirements effectively.
Our team can provide tailored solutions and advice to ensure that {product} meets your scaling requirements effectively.

If you need to go upper than the detailed limits contact-us.
12 changes: 6 additions & 6 deletions doc/content/modules/user-manual/pages/key-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ a|✅

2+h|{sysmlv2} Views
|xref:user-manual:features/general-view.adoc[{gv}]
a|✅ partial
a|✅ (Partial)

|xref:user-manual:features/interconnection-view.adoc[{iv}]
a|✅ partial
a|✅ (Partial)

|xref:user-manual:features/sysmlv2-overview.adoc[{afv}]
a|✅partial
a|✅ (Partial)

|xref:user-manual:features/sysmlv2-overview.adoc[{stv}]
a|✅partial
a|✅ (Partial)

|xref:user-manual:features/sysmlv2-overview.adoc[Sequence View]
a|❌
Expand Down Expand Up @@ -78,14 +78,14 @@ a|✅
a|❌

|xref:integration/interoperability.adoc[Download / Upload {sysmlv2} textual format]
a|✅ Partial
a|✅ (Partial)
|===

A detailed list of all {product} features is available in the xref:features/features.adoc[Features] section.

== Ongoing development

{product} is continually evolving, with a commitment to expanding its repertoire of views in alignment with the {sysmlv2} standard.
{product} is xref:user-manual:cycle.adoc[continually evolving], with a commitment to expanding its repertoire of views in alignment with the {sysmlv2} standard.
Future releases will introduce additional features, ensuring {product} remains a comprehensive and adaptable tool for system engineering.

== Others
Expand Down

0 comments on commit ee92674

Please sign in to comment.