Merge pull request #89 from ESA-APEx/documentation

docs: created quarto docs and publish to github pages

Author: JanssenBrm

.github/workflows/publish_docs.yaml

@@ -0,0 +1,55 @@
+name: Publish content to GitHub pages
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+concurrency: publish-docs
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    permissions:
+      pages: write
+      contents: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          tinytex: true
+          version: '1.6.31'
+      - name: Render documentation pages
+        run: quarto render --output-dir _build
+      - name: Setup GitHub pages
+        uses: actions/configure-pages@v5
+      - name: Upload build artifacts
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/_build"
+      - name: Upload build folder
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-folder
+          path: "docs/_build"
+
+  deploy-documentation-ghpages:
+    runs-on: ubuntu-latest
+    needs: build-documentation
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/README.md

@@ -0,0 +1,35 @@
+project:
+  type: website
+  preview:
+    port: 4200
+
+
+website:
+  repo-url: "https://github.com/ESA-APEx/apex_algorithms"
+  repo-branch: "main"
+  search:
+    location: sidebar
+    type: textbox
+    copy-button: true
+
+  navbar:
+    pinned: true
+
+  page-navigation: true
+
+  title: "APEx Algorithms - Documentation"
+
+  sidebar:
+    style: "floating"
+    collapse-level: 2
+    contents:
+      - href: index.md
+        text: Welcome
+      - href: benchmarking.md
+
+format:
+  html:
+    toc-depth: 4
+    page-layout: full
+    theme: zephyr
+bread-crumbs: true

docs/_quarto.yml

@@ -1,5 +1,6 @@
-
-# APEx Algorithm Benchmarking
+---
+title: APEx Algorithm Benchmarking
+---
 
 The hosted APEx Algorithms are executed automatically and regularly
 following certain benchmark scenarios in order to:
@@ -18,15 +19,16 @@ in the form of JSON files in the [`openeo_udp`](../openeo_udp/) folder.
 These JSON files follow the standard openEO process definition schema,
 for example as used for the `GET /process_graphs/{process_graph_id}` endpoint of the openEO API.
 
-> [!NOTE]
-> These openEO process definitions are commonly referred to
-> as "UDPs" or "user-defined processes",
-> which stems from the original openEO API specification
-> with an isolated "user" concept.
-> The scope of algorithm publishing and hosting in APEx
-> goes well beyond isolated, individual users.
-> As such, it can get confusing to overthink the "user-defined" part,
-> and it might be better to just think of "openEO process definitions".
+::: {.callout-note}
+These openEO process definitions are commonly referred to
+as "UDPs" or "user-defined processes",
+which stems from the original openEO API specification
+with an isolated "user" concept.
+The scope of algorithm publishing and hosting in APEx
+goes well beyond isolated, individual users.
+As such, it can get confusing to overthink the "user-defined" part,
+and it might be better to just think of "openEO process definitions".
+:::
 
 
 Example process definition:

docs/benchmarking.md

@@ -0,0 +1,5 @@
+---
+title: APEx Algorithms
+---
+
+Welcome to the APEx Algorithm repository!