Merge pull request #6 from ObeoNetwork/meb/doc

init antora doc

.github/workflows/doc-gen.yml

@@ -0,0 +1,44 @@
+name: Deploy static documentation on Pages
+
+on:
+  push:
+    branches: ["*"]
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Run Doc generation script
+        run: doc/generate.bash
+
+      - name: Fix permissions
+        run: sudo chmod -c -R +rX 'doc/docs-site/build'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: 'doc/docs-site/build/site/'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -88,3 +88,7 @@ coverage/
 *.iws
 *.iml
 *.ipr
+
+
+# Doc
+doc/**/build

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

@@ -0,0 +1,42 @@
+FROM alpine:latest AS BUILD
+
+RUN apk add npm
+
+WORKDIR /usr/app
+
+COPY doc-ui /usr/app
+
+RUN npm install
+RUN ./node_modules/gulp/bin/gulp.js bundle
+
+FROM alpine:latest AS UI
+
+COPY --from=BUILD /usr/app/build/ui-bundle.zip /usr/app/ui-bundle.zip
+
+
+FROM alpine:latest
+
+RUN apk add git
+RUN apk add npm
+RUN apk add ruby
+
+RUN mkdir /home/antora
+
+WORKDIR  /home/antora
+
+COPY docs-site/package.json .
+COPY docs-site/package-lock.json .
+
+RUN npm install
+RUN gem install asciidoctor
+RUN gem install asciidoctor-pdf
+RUN gem install rouge
+RUN gem install kramdown-asciidoc
+
+ENV PATH="$PATH:/home/antora/node_modules/@antora/cli/bin/"
+
+COPY --from=UI /usr/app/ui-bundle.zip .
+
+WORKDIR /usr/app
+
+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

@@ -0,0 +1,36 @@
+name: syson
+title: SysON
+version: true
+nav:
+  - modules/ROOT/nav.adoc
+
+asciidoc:
+  attributes:
+    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/README

@@ -0,0 +1,6 @@
+Recommended; Reserved
+
+Directory that contains the ROOT module.
+This special directory does not appear in the output path.
+Instead, it becomes the parent folder of any additional, named modules that you create in a component.
+The directory name must be written in all uppercase letters.

doc/content/modules/ROOT/assets/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory where multimedia and supplemental files are organized by content type.

doc/content/modules/ROOT/assets/attachments/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains supplemental materials, such as PDFs or ZIP files, that readers can download via a link created in a page using the AsciiDoc link macro.

doc/content/modules/ROOT/assets/images/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains pictures, screenshots, diagrams, and other graphics files that are displayed in a page using the AsciiDoc image macro.

doc/content/modules/ROOT/examples/README

@@ -0,0 +1,3 @@
+Optional; Reserved
+
+Directory that contains non-AsciiDoc file types, such as source code or data values. These files are often inserted into listing blocks using the AsciiDoc include directive.

doc/content/modules/ROOT/nav.adoc

@@ -0,0 +1,9 @@
+// Optional; Reserved
+//
+// 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[]
+include::user-manual:partial$nav.adoc[]
+include::installation-guide:partial$nav.adoc[]
+include::developer-guide:partial$nav.adoc[]
+* xref:product-legal:index.adoc[]