Merge pull request #1 from bci-oss/transition-omp-to-esmf

Transition OMP to ESMF

Author: atextor

.github/workflows/antora-build.yml

@@ -4,27 +4,27 @@ on:
     branches:
     - main
   workflow_dispatch:
-  
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-20.04
 
     steps:
     - name: Checkout
-      uses: actions/[email protected]
-      with:
-        ref: main
-        fetch-depth: '0'
-    - name: Install Node
-      uses: actions/setup-node@v2
+      uses: actions/checkout@v3
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
       with:
-        node-version: '14'
-    - name: Install Antora
-      run: npm i -g @antora/[email protected] antora-site-generator-lunr
-    - name: Fetch and Build Antora site
-      run: antora --fetch site.yml --generator antora-site-generator-lunr --stacktrace   
+        distribution: 'temurin'
+        java-version: '17'
+
+    - name: Build
+      run: |
+        ./mvnw -B generate-resources -Pantora
+
     - name: Deploy
       uses: JamesIves/[email protected]
       with:
         branch: gh-pages
-        folder: build/site
+        folder: build/site

.gitignore

@@ -4,4 +4,9 @@ build
 node_modules
 site-local.yml
 package-lock.json
+package.json
+.idea
+node/
+.DS_Store
+
 

.mvn/wrapper/maven-wrapper.jar

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.5/apache-maven-3.8.5-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar

.mvn/wrapper/maven-wrapper.properties

@@ -1,31 +1,17 @@
-> THIS REPOSITORY HAS BEEN ARCHIVED. Open Manufacturing Platform has been formally closed.
+# ESMF documentation site
 
-# sds-documentation
+This repository contains the setup for the documentation of the [Eclipse Semantic Modeling Framework](https://projects.eclipse.org/projects/dt.esmf)
+(ESMF) that is available at [https://eclipse-esmf.github.io/](https://eclipse-esmf.github.io/).
 
-This repository belongs to the Semantic Data Structuring Working Group (SDS WG) in the Open
-Manufacturing Platform. It contains content to generate a joint SDS WG documentation across
-different SDS WG repositories using Antora.
-
-The documentation site is generated using Github actions and is available at
-[https://openmanufacturingplatform.github.io/sds-documentation/](https://openmanufacturingplatform.github.io/sds-documentation/).
-
-As of now, the Antora build for the website pulls the content from the following repositories and
-sources:
-
-- [SDS BAMM](https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/tree/main/src/docs)
-- [SDS SDK](https://github.com/OpenManufacturingPlatform/sds-sdk/tree/main/documentation/developer-guide)
+The documentation is built using [https://antora.org/](Antora). Refer to site.yml to see which
+documentation sources are included.
 
 ## Building locally
 
-To build the documentation locally, you will need [Node.js](https://nodejs.org/en/) >=14. After
-installing, run the following commands:
+To build the documentation locally, you will need to have Java installed. To build, run:
 
 ```sh
-# Installs the Antora CLI and the site generator
-npm i @antora/[email protected] antora-site-generator-lunr
-
-# Runs Antora to generate the documentation
-./node_modules/@antora/cli/bin/antora --fetch site.yml --generator antora-site-generator-lunr
+./mvnw generate-resources -Pantora
 ```
 
 After that, the documentation is available at `build/site/index.html`.

README.md

@@ -0,0 +1,4 @@
+name: esmf-documentation
+title: ESMF Documentation
+version: master
+start_page: ROOT:index.adoc

documentation/antora.yml

@@ -0,0 +1,79 @@
+= Eclipse Semantic Modeling Framework
+:page-layout: tiles
+
+
+Welcome to the documentation of the artifacts of the Eclipse Semantic Modeling Framework (ESMF).
+
+For a general introduction of the ESMF, please see the
+https://projects.eclipse.org/projects/dt.esmf[ESMF project page]. For more details on the artifacts
+see below:
+
+'''
+
+[.tile]
+[.icon-spec]
+--
+[.title]
+Semantic Aspect Meta Model (SAMM)
+
+[.text]
+Aspect models defined using the SAMM describe domain semantics.
+Find out how they are defined.
+
+[.link]
+xref:samm-specification:ROOT:index.adoc[Specification]
+--
+
+[.tile]
+[.icon-cli]
+--
+[.title]
+SAMM Command Line Interface (SAMM-CLI)
+
+[.text]
+Command line interface to work with Aspect Models: Validate and transform models into documentation
+and code.
+
+[.link]
+xref:esmf-developer-guide:tooling-guide:samm-cli.adoc[SAMM CLI]
+--
+
+[.tile]
+[.icon-cli]
+--
+[.title]
+Aspect Model Editor
+
+[.text]
+The Aspect Model Editor is a visual editor for Aspect Models, which automatically validates the
+models against the BAMM Aspect Meta Model version.
+
+[.link]
+xref:ame-guide:ROOT:introduction.adoc[Aspect Model Editor]
+--
+
+[.tile]
+[.icon-cli]
+--
+[.title]
+Java ESMF SDK
+
+[.text]
+The ESMF SDK helps you to build solutions, model your Aspect data, implement your own customized
+Aspect or want to integrate existing assets and systems within the Java programming language.
+[.link]
+xref:esmf-developer-guide:tooling-guide:java-aspect-tooling.adoc[Java SDK]
+--
+
+[.tile]
+[.icon-cli]
+--
+[.title]
+Python ESMF SDK
+
+[.text]
+The Python SDK offers functionality which helps software developers to work with Aspect Models in
+their Python applications.
+[.link]
+xref:python-sdk-guide:ROOT:index.adoc[Python SDK]
+--