[doc] Contribute initial version of the documentation

README.md

@@ -1,20 +1,47 @@
-# SysON Project (Temporary Repository)
+# Eclipse SysON: Web-based SysML Modeling Tool
 
-Welcome to the temporary repository of the Eclipse SysON project.
+## Overview
 
-🚧 **Note:** This repository is temporary and is awaiting the official creation of the repository by the Eclipse Foundation. The proposal for the project is available here: [Eclipse SysON Proposal](https://projects.eclipse.org/proposals/eclipse-syson).
+The SysON project provides an open-source and interoperable tool for editing SysMLv2 models conforming to the OMG Standard, tailored for the MBSE community. It features a user-friendly web-based interface, offering a range of editors (graphical, form-based, etc.) to facilitate the creation, modification, and visualization of SysML v2 models. SysON leverages the [Sirius Web](https://eclipse.dev/sirius/sirius-web.html) platform and seamlessly integrates with other open-source solutions like Papyrus and Capella.
 
+## Key Features
 
-## Overview
+* Web-based: Access SysON from any computer with a web browser.
+* Open-source: Freely download and install SysON.
+* Interoperable: Exchange models seamlessly with other SysML tools.
+* User-friendly: Intuitive interface for easy model creation and editing.
 
-The SysON project provides an open-source and interoperable tool for editing SysMLv2 models conforming to the OMG Standard, tailored for the MBSE community. It features a user-friendly web-based interface, offering a range of editors (graphical, form-based, etc.) to facilitate the creation, modification, and visualization of SysML v2 models. SysON leverages the [Sirius Web](https://eclipse.dev/sirius/sirius-web.html) platform and seamlessly integrates with other open-source solutions like Papyrus and Capella.
 
-## License
+## Examples
+// TODO : Quick overview of an example based on the ones provides with the OMG reference implementation
 
-This project is licensed under the EPLv2 - see the [LICENSE](https://github.com/ObeoNetwork/SysON/blob/main/LICENSE) file for details.
+## Installation
+
+* Download and install the latest version of SysON from the GitHub repository.
+* Launch the SysON application from your web browser.
+* Start creating and editing SysML models.
+
+## Troubleshooting
+// TODO : Link to troubleshooting documentation
 
----
+## Documentation:
 
-This README is a temporary document. For official information, updates, and contributions, please refer to the upcoming official repository on the Eclipse Foundation.
+* Extensive documentation covering SysON features and usage.
+* Tutorials and guides for beginners and experienced users.
+* FAQ section addressing common questions and issues.
+
+## Changelog
+// TODO : Link to Changelog
+
+## Contributions:
+
+. Join the active community of SysON developers and contribute to the project.
+. Submit bug reports and feature requests.
+.Review and improve existing code and documentation.
+
+## License information
+
+This project is licensed under the EPLv2 - see the [LICENSE](https://github.com/ObeoNetwork/SysON/blob/main/LICENSE) file for details.
+This project is maintained by Obeo and the CEA List - see the project [insights](https://github.com/eclipse-syson/syson/pulse) for details.
+More information is available in the documentation: // TODO : link to the license inforamtion section in the doc
 
-For questions or inquiries, feel free to [contact us](mailto:[email protected]).

doc/Dockerfile

@@ -6,7 +6,7 @@ WORKDIR /usr/app
 
 COPY doc-ui /usr/app
 
-RUN npm install 
+RUN npm install
 RUN ./node_modules/gulp/bin/gulp.js bundle
 
 FROM alpine:latest AS UI
@@ -27,7 +27,7 @@ WORKDIR  /home/antora
 COPY docs-site/package.json .
 COPY docs-site/package-lock.json .
 
-RUN npm install 
+RUN npm install
 RUN gem install asciidoctor
 RUN gem install asciidoctor-pdf
 RUN gem install rouge
@@ -39,4 +39,4 @@ COPY --from=UI /usr/app/ui-bundle.zip .
 
 WORKDIR /usr/app
 
-CMD ["antora", "--clean", "--stacktrace", "/usr/app/doc/docs-site/antora-playbook.yml"]
+CMD ["antora", "--clean", "--stacktrace", "--log-level=all", "/usr/app/doc/docs-site/antora-playbook.yml"]

doc/README

@@ -0,0 +1,7 @@
+# Documentation best practices
+
+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

doc/content/antora.yml

@@ -6,6 +6,31 @@ nav:
 
 asciidoc:
   attributes:
-    bug: "https://github.com/ObeoNetwork/SysON/issues"
-    product-name: "SysON"
-    website: "https://eclipse.dev/syson/"
+    bug-url: "https://github.com/eclipse-syson/syson/issues"
+    changelog-url: "https://github.com/eclipse-syson/syson/blob/main/CHANGELOG.adoc"
+    details: "Details"
+    diag-toolbar: "Contextual Toolbar"
+    editor: "Project Editor"
+    explorer-filter-bar: "Project Explorer Filter Bar"
+    explorer-menu: "Element Options Menu"
+    explorer: "Project Explorer"
+    forum-url: "https://github.com/eclipse-syson/syson/discussions"
+    fromsyson: "Included in Community version"
+    fromocp: "Included in Enterprise version"
+    gv: "General View"
+    homepage: "Projects Browser"
+    ocp: "Obeo Cloud Platform"
+    packages-url: "https://github.com/eclipse-syson/syson/packages"
+    product: "SysON"
+    product-jar: "syson-application.jar"
+    projects-list: "Projects List"
+    projects-list-menu: "Project Options Menu"
+    related-elements: "Related Elements"
+    representations-view: "Representations"
+    source-code-url: "https://github.com/eclipse-syson/syson"
+    status-exp: "Status: Experimental"
+    status-stable: "Status: Stable"
+    sysmlv1: "SysML v1"
+    sysmlv2: "SysML v2"
+    validation: "Validation"
+    website-url: "https://eclipse.dev/syson/"

doc/content/modules/ROOT/nav.adoc

@@ -3,7 +3,7 @@
 // A navigation file contains one or more AsciiDoc lists.
 // Each navigation file must be declared in the component descriptor if you want it to be displayed in the component’s navigation menu.
 * xref:index.adoc[]
-* xref:getting-started.adoc[]
-* xref:product-legal:index.adoc[]
-* xref:installation-guide:index.adoc[]
 include::user-manual:partial$nav.adoc[]
+include::installation-guide:partial$nav.adoc[]
+include::developer-guide:partial$nav.adoc[]
+* xref:product-legal:index.adoc[]

doc/content/modules/ROOT/pages/authors.adoc

@@ -0,0 +1,3 @@
+= Authors
+
+Discover the individuals who contribute to the {product} project: https://projects.eclipse.org/projects/modeling.syson/who

doc/content/modules/ROOT/pages/expand-knowledge.adoc

@@ -0,0 +1,14 @@
+= Expand your knowledge
+
+[cols="1*^", %noheader, frame=none, grid=none]
+|===
+a|image::travel_explore.svg[xref=user-manual:features/features.adoc]
+
+*{product} features*
+
+Explore the {product} features in details.
+
+xref:user-manual:features/features.adoc[Explore ...]
+|===
+
+Or dive in all our xref:user-manual:hands-on/hands-on.adoc[step-by-step guides] and get some hands-on experience thanks to our xref:user-manual:hands-on/tutorials/tutorials.adoc[tutorials].