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

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", "/usr/app/doc/docs-site/antora-playbook.yml"]

doc/content/antora.yml

@@ -0,0 +1,11 @@
+name: syson
+title: SysON
+version: true
+nav:
+  - modules/ROOT/nav.adoc
+
+asciidoc:
+  attributes:
+    bug: "https://github.com/ObeoNetwork/SysON/issues"
+    product-name: "SysON"
+    website: "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[]
+* xref:product-legal:index.adoc[]
+
+* xref:installation-guide:index.adoc[]
+include::user-manual:partial$nav.adoc[]

doc/content/modules/ROOT/pages/README

@@ -0,0 +1,4 @@
+Required; Reserved
+
+Directory that contains all of a module’s AsciiDoc files.
+These files are automatically enlisted by Antora and converted to standalone HTML pages.

doc/content/modules/ROOT/pages/general-information.adoc

@@ -0,0 +1,13 @@
+= Overview
+* Name: {product-name}
+
+== Source code
+* License: xref:product-legal:index.adoc[Obeo]
+
+== Tracker
+
+* Bug tracker: {bug}
+
+== Communication
+
+* Website: {website}

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

@@ -0,0 +1,8 @@
+= Welcome
+
+Welcome to the {product-name} Help Center!
+From here, you can access the different documentations.
+
+Use the menu on the left to navigate or the menu bar at the top of the page.
+
+include::general-information.adoc[leveloffset=+1]

doc/content/modules/ROOT/partials/README

@@ -0,0 +1,5 @@
+Optional; Reserved
+
+Directory that contains AsciiDoc files that can be inserted into the files stored in pages.
+These files aren’t converted to HTML by Antora directly.
+Instead, they must be referenced by an include directive in a page in the pages directory.

doc/content/modules/installation-guide/README

@@ -0,0 +1 @@
+This folder contains documentation about how to install the product.

doc/content/modules/installation-guide/assets/README

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

doc/content/modules/installation-guide/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/installation-guide/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/installation-guide/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/installation-guide/pages/README

@@ -0,0 +1,4 @@
+Required; Reserved
+
+Directory that contains all of a module’s AsciiDoc files.
+These files are automatically enlisted by Antora and converted to standalone HTML pages.

doc/content/modules/installation-guide/pages/environment.adoc

@@ -0,0 +1,21 @@
+= Environment
+
+[Environment]
+|===
+| |Client |Server |Comment
+
+|Operating Systems
+|Windows, Linux, macOS
+|n/a
+|
+
+|Java
+|Java 8
+|n/a
+|
+
+|Eclipse Platform
+|Photon
+|n/a
+|
+|===

doc/content/modules/installation-guide/pages/executables.adoc

@@ -0,0 +1,4 @@
+= Get {product-name}
+
+[.small .gray]#_Details how the software is distributed: update-site? standalone software?and where the executables are available, link to nightly/released update sites or any page explaining where to find it._#
+

doc/content/modules/installation-guide/pages/index.adoc

@@ -0,0 +1,9 @@
+= Installation guide
+
+include::environment.adoc[leveloffset=+1]
+include::executables.adoc[leveloffset=+1]
+
+== Installation procedure
+[.small .gray]#_Details how to install the product. Details if the software comes with an installer or with a kind of assistant for the configuration or the steps to do the installation by hand._#
+
+include::migration-process.adoc[leveloffset=+1]

doc/content/modules/installation-guide/pages/migration-process.adoc

@@ -0,0 +1,3 @@
+= Migration process
+
+[.small .gray]#_Details the migration process_#

doc/content/modules/installation-guide/partials/README

@@ -0,0 +1,5 @@
+Optional; Reserved
+
+Directory that contains AsciiDoc files that can be inserted into the files stored in pages.
+These files aren’t converted to HTML by Antora directly.
+Instead, they must be referenced by an include directive in a page in the pages directory.

doc/content/modules/product-legal/README

@@ -0,0 +1,2 @@
+This folder contains documentation about legal public information.
+This documentation can be shared **publicly**.

doc/content/modules/product-legal/assets/README

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

doc/content/modules/product-legal/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/product-legal/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/product-legal/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.