Online documentation site migration to hextra

.github/workflows/pages.yaml

@@ -0,0 +1,77 @@
+# Sample workflow for building and deploying a Hugo site to GitHub Pages
+name: Deploy Hugo site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.156.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # fetch all history for .GitInfo and .Lastmod
+          submodules: recursive
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.26'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Setup Hugo
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            --gc --minify \
+            -s ./docs/doc-site
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/doc-site/public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/doc-site/.gitignore

@@ -0,0 +1,3 @@
+# Hugo
+**/.hugo_build.lock
+/public/

docs/doc-site/archetypes/default.md

@@ -0,0 +1,5 @@
+---
+date: '{{ .Date }}'
+draft: true
+title: '{{ replace .File.ContentBaseName "-" " " | title }}'
+---

docs/doc-site/content/_index.md

@@ -0,0 +1,13 @@
+---
+title: "Welcome"
+toc: false
+---
+
+Welcome to the documentation site for the COVESA Central Data Service Playground (CDSP)
+
+## Explore
+
+{{< cards >}}
+  {{< card link="docs" title="Documentation" icon="book-open" >}}
+  {{< card link="about" title="About" icon="user" >}}
+{{< /cards >}}

docs/doc-site/content/about.md

@@ -0,0 +1,6 @@
+---
+title: About
+type: about
+---
+
+This is the about page.

docs/doc-site/content/docs/_index.md

@@ -0,0 +1,19 @@
+---
+title: "Central Data Service Playground"
+---
+## Introduction
+{{< cards >}} {{< card link="overview" title="Overview" icon="document-text" subtitle="Learn the basics and benefits of using the playground" >}} {{< /cards >}}
+
+## Browse by section
+
+### Manuals
+This section contains user guides and reference manuals for the playground
+
+{{< cards >}}
+  {{< card link="manuals" title="Overview" icon="document-text" subtitle="Explore the available guides" >}}
+  {{< card link="apache-iotdb" title="Apache IoTDB data store" icon="document-text" subtitle="Apache IoTDB timeseries database guide" >}}
+  {{< card link="vissr-viss" title="VISSR (VISS data server)" icon="document-text" subtitle="VISSR (VISS data server) guide" >}}
+{{< /cards >}}
+
+### Examples
+{{< cards >}} {{< card link="examples" title="Examples" icon="document-text" subtitle="Learn how to use the playground by stepping through examples." >}} {{< /cards >}}

docs/doc-site/content/docs/manuals/_index.md

@@ -0,0 +1,16 @@
+---
+title: "Manuals"
+chapter: true
+weight: 15
+---
+
+# Introduction
+
+This section contains user guides and reference manuals for the playground
+
+{{< cards >}}
+  {{< card link="apache-iotdb" title="Apache IoTDB" icon="document-text" subtitle="Apache IoTDB reference manual" >}}
+  {{< card link="vissr-viss" title="VISS/VISSR" icon="document-text" subtitle="Reference manual for the VISSR data server that implements VISS" >}}
+{{< /cards >}}
+
+

docs/doc-site/content/docs/overview/_index.md

@@ -0,0 +1,19 @@
+---
+title: "Playground overview"
+chapter: true
+weight: 10
+---
+
+# Introduction
+
+The Central Data Service Playground (CDSP) serves as a neutral, open playground for data services both within and outside the vehicle in the context of data-centric architectures. It enables investigation into the internals of these services and how they can be combined. Furthermore, the playground provides a means to publish and collaborate on such work in the open.
+
+The playground was first conceived by the COVESA Data Architecture team to meet their needs. They also recognized that there were the same needs in the wider community inside and outside COVESA. For example, to demonstrate how VSS data can be used with its eco-system for newcomers.
+
+# Foundational concepts
+
+{{< cards >}}
+  {{< card link="cdsp-logical-concept" title="Logical concept" icon="document-text" subtitle="Explore the logical concept for CDSP" >}}
+  {{< card link="cdsp-implementation-concept" title="Implementation concept" icon="document-text" subtitle="Explore how the logical concept has been implemented" >}}
+  {{< card link="covesa-and-beyond" title="COVESA eco-system and beyond" icon="document-text" subtitle="Explore how the playground fits into the wider eco-system" >}}
+{{< /cards >}}

docs/docs-gen/content/overview/cdsp-implementation-concept.md → docs/doc-site/content/docs/overview/cdsp-implementation-concept.md

@@ -1,5 +1,5 @@
 ---
-title: "Playground implementation"
+title: "Implementation concept"
 weight: 30
 ---
 
@@ -35,7 +35,7 @@ _"Apache IoTDB (Database for Internet of Things) is an IoT native database with
 
 The diagram below summarizes some of the features that make it an attractive addition to the playground.
 
-{{< figure src="Apache-IoTDB-feature-summary.drawio.svg" title="Summary of Apache IoTDB features" width=50pc >}}
+![Summary of Apache IoTDB features](/images/Apache-IoTDB-feature-summary.drawio.svg "Summary of Apache IoTDB features")
 
 + The focus on timeseries IoT data delivering high throughput, with low latency are a good fit with the automotive domain. The availability of a single node (Edge) server build is critical for in-vehicle investigations and is supported by the existence of a cluster build for the cloud if needed.
 

docs/docs-gen/content/overview/cdsp-logical-concept.md → docs/doc-site/content/docs/overview/cdsp-logical-concept.md

@@ -1,5 +1,5 @@
 ---
-title: "Playground logical concept"
+title: "Logical concept"
 weight: 20
 ---
 
@@ -49,7 +49,7 @@ The following sections address the Why, What and How in more detail.
 
 + VSS is a mechanism of abstraction. The COVESA logical architecture for the VSS eco-system shown below places operation in the 'big ECUs', in zonal ECUs and above. Discussion of next-gen and data-centric architectures suggests investigation into data services in zone, domain and HPC controller scenarios and the cooperation between them. Hence _Central_.
 
-{{< figure src="Logical-Architecture-Overview.drawio.svg" title="The COVESA Logical Architecture" width=50pc >}}
+![The COVESA Logical Architecture](/images/Logical-Architecture-Overview.drawio.svg "The COVESA Logical Architecture")
 
 + A repeating pattern of discussion in the COVESA Data Architecture team is the combination of VSS Data Server and VSS Data Store with advanced features and their connection southbound to feeders/native data and northbound to clients and off-board. Hence _Data Service_.
 
@@ -67,7 +67,7 @@ The following sections address the Why, What and How in more detail.
 
 ### Requirements
 
-{{< figure src="cdsp-logical-concept.drawio.svg" title="The data service core requirements" >}}
+![The data service core requirements](/images/cdsp-logical-concept.drawio.svg "The data service core requirements")
 
 At its core the service has requirements in three key areas:
 
@@ -78,7 +78,7 @@ At its core the service has requirements in three key areas:
 3. Application logic / APIs: standardized APIs for accessing the data such as the [Vehicle Information Service Specification (VISS)](https://github.com/COVESA/vehicle-information-service-specification)
  or GraphQL.
 
-_Additional requirements:_ It is recognized that additional features, such as synchronization are absolutely desirable and have been a part of discussions in the Data Architecture team. Such features may also already be part of the feature set of the playground components. For example, the Apache IoTDB databases have sync capabilities. A base feature set is described as a starting point to help readers quickly grasp the concept. Additional features will be created or illustrated collectively based on interest and participation.
+_Additional requirements:_ It is recognized that additional features, such as synchronization are absolutely desirable and have been a part of discussions in the Data Architecture team. Such features may also already be part of the feature set of the playground components. For example, both the Apache IoTDB and MongoDB Realm databases have sync capabilities. A base feature set is described as a starting point to help readers quickly grasp the concept. Additional features will be created or illustrated collectively based on interest and participation.
 
 ### Components
 
@@ -119,7 +119,7 @@ Source: [vss-otaku](https://github.com/slawr/vss-otaku)
 
 **Logical domains**: Connections may also be made to other logical data domains. For example, there is an [knowledge layer proposal](https://wiki.covesa.global/x/cYI8B) made in the COVESA Data Architecture team that discusses the separation of concerns and interaction between knowledge, information and raw data layers as illustrated below. The Playground here could be used to provide the data/information layer services in its investigation.
 
-![Knowledge layer proposal](https://wiki.covesa.global/download/attachments/71074417/Knowledge-Layer-v3.png?api=v2?width=50pc "Deployment illustration from the proposal")
+![Knowledge layer proposal](https://covesa.atlassian.net/wiki/download/attachments/39065679/Knowledge-Layer-v3.png?api=v2?width=50pc "Deployment illustration from the proposal")
   Source: [knowledge layer proposal](https://wiki.covesa.global/x/cYI8B)
 
 ### Project success factors
@@ -144,4 +144,4 @@ Source: [vss-otaku](https://github.com/slawr/vss-otaku)
 
 + Follow the OSS mantra of adopt where you can, extend if needed, create where necessary.
 
-+ Promote flexible reconfiguration of components by favouring loose coupling over tight coupling.
++ Promote flexible reconfiguration of components by favouring loose coupling over tight coupling.

docs/docs-gen/content/overview/cdsp-overview.md → docs/doc-site/content/docs/overview/cdsp-overview.md

@@ -1,5 +1,5 @@
 ---
-title: "Playground overview"
+title: "Introduction"
 weight: 10
 ---
 The Central Data Service Playground (CDSP) serves as a neutral, open playground for data services both within and outside the vehicle in the context of data-centric architectures. It enables investigation into the internals of these services and how they can be combined. Furthermore, the playground provides a means to publish and collaborate on such work in the open.
@@ -8,6 +8,6 @@ The playground was first conceived by the COVESA Data Architecture team to meet
 
 Next steps:
 
-1. [Logical concept]({{< ref "/cdsp-logical-concept.md" >}} "Explore the logical concept")
-2. [Implementation concept]({{< ref "/cdsp-implementation-concept.md" >}} "Explore the implementation concept")
+1. [Logical concept]({{< ref "cdsp-logical-concept.md" >}} "Explore the logical concept")
+2. [Implementation concept]({{< ref "cdsp-implementation-concept.md" >}} "Explore the implementation concept")
 3. [COVESA eco-system and beyond]({{< ref "covesa-and-beyond.md" >}} "How the playground fits into the wider eco-system")

docs/doc-site/go.mod

@@ -0,0 +1,5 @@
+module github.com/COVESA/cdsp.git
+
+go 1.21.9
+
+require github.com/imfing/hextra v0.12.1 // indirect

docs/doc-site/go.sum

@@ -0,0 +1,2 @@
+github.com/imfing/hextra v0.12.1 h1:3t1n0bmJbDzSTVfht93UDcfF1BXMRjeFojA071ri2l8=
+github.com/imfing/hextra v0.12.1/go.mod h1:vi+yhpq8YPp/aghvJlNKVnJKcPJ/VyAEcfC1BSV9ARo=

docs/doc-site/hugo.yaml

@@ -0,0 +1,67 @@
+#baseURL: https://example.org/
+languageCode: en-us
+
+# Hugo configuration file
+title: Central Data Service Playground (CDSP)
+
+# import hextra as module
+module:
+  imports:
+  - path: github.com/imfing/hextra
+
+markup:
+  # allow raw html
+  goldmark:
+    renderer:
+      unsafe: true
+
+  # enable hextra syntax highlight
+  highlight:
+    noClasses: false
+
+menu:
+  main:
+    - name: Docs
+      pageRef: /docs
+      weight: 1
+    - name: About
+      pageRef: /about
+      weight: 2
+    - name: Contact ↗
+      url: "https://github.com/COVESA/cdsp/blob/main/README.md#project-resources"
+      weight: 3
+    - name: Search
+      weight: 4
+      params:
+        type: search
+    - name: GitHub
+      weight: 5
+      url: "https://github.com/COVESA/cdsp"
+      params:
+        icon: github
+    - name: Slack
+      weight: 6
+      url: "https://covesacommunity.slack.com/archives/C06353TRF5F"
+      params:
+        icon: slack
+    - name: LinkedIn
+      weight: 7
+      url: "https://www.linkedin.com/company/covesa-alliance/"
+      params:
+        icon: linkedin
+
+params:
+  navbar:
+    displayTitle: true
+    displayLogo: false
+
+  footer:
+    displayCopyright: false
+    displayPoweredBy: true
+
+  editURL:
+    enable: true
+    base: "https://github.com/COVESA/cdsp/edit/main/docs/doc-site/content"
+
+  imageZoom:
+    enable: true