Latest

.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 14
+  - package-ecosystem: "npm"
+    directory: "/trento-docs-site"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 14
+  - package-ecosystem: "npm"
+    directory: "/trento-docs-site-ui"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 14

.github/workflows/build-page.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: SUSE LLC
+# SPDX-License-Identifier: Apache-2.0
+
 name: Publish Trento documentation on GitHub Pages
 on:
   push:
@@ -14,19 +17,19 @@ permissions:
   id-token: write
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
       with:
         fetch-depth: 0
     - name: Configure Pages
-      uses: actions/configure-pages@v5
+      uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5
     - name: Install Node.js
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
       with:
         node-version: '18'
     - name: Install Antora with the Antora Lunr Extension
@@ -36,9 +39,9 @@ jobs:
       working-directory: trento-docs-site
       run: npx antora antora-playbook.yml
     - name: Upload Artifacts
-      uses: actions/upload-pages-artifact@v3
+      uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
       with:
         path: trento-docs-site/build/trento-docs-site-public
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v4
+      uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

.github/workflows/extension-tests.yaml

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: SUSE LLC
+# SPDX-License-Identifier: Apache-2.0
+
+name: Run Trento docs extension tests
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'trento-docs-site/extensions/**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'trento-docs-site/extensions/**'
+  workflow_dispatch:
+
+jobs:
+  test-extensions:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+      - name: Install Node.js
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: trento-docs-site/package-lock.json
+      - name: Install dependencies
+        working-directory: trento-docs-site
+        run: npm install --no-audit --no-fund
+      - name: Run extension tests
+        working-directory: trento-docs-site
+        run: npm test

.github/workflows/validate-suse-docs.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: SUSE LLC
+# SPDX-License-Identifier: Apache-2.0
+
 name: Validate user facing documentation
 
 on:
@@ -25,22 +28,22 @@ jobs:
       allow-build: ${{ steps.select-dc-build.outputs.allow-build }}
       relevant-branches: ${{ steps.select-dc-build.outputs.relevant-branches }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
 
       - name: Checking basic soundness of DC files
-        uses: openSUSE/doc-ci@gha-select-dcs
+        uses: openSUSE/doc-ci@e349aced35306105cd981adfa9243836deb119ea # gha-select-dcs
         with:
           mode: soundness
 
       - name: Selecting DC files to validate
         id: select-dc-validate
-        uses: openSUSE/doc-ci@gha-select-dcs
+        uses: openSUSE/doc-ci@e349aced35306105cd981adfa9243836deb119ea # gha-select-dcs
         with:
           mode: list-validate
 
       - name: Selecting DC files to build
         id: select-dc-build
-        uses: openSUSE/doc-ci@gha-select-dcs
+        uses: openSUSE/doc-ci@e349aced35306105cd981adfa9243836deb119ea # gha-select-dcs
         with:
           mode: list-build
           original-org: trento-project
@@ -54,8 +57,8 @@ jobs:
       matrix:
         dc-files: ${{ fromJson(needs.select-dc-files.outputs.validate-list) }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
       - name: Validating DC file(s) ${{ matrix.dc-files }}
-        uses: openSUSE/doc-ci@gha-validate
+        uses: openSUSE/doc-ci@bd6cbd0ef4bb85994839ef42cf904a2ce08b55fd # gha-validate
         with:
-          dc-files: ${{ matrix.dc-files }}
+          dc-files: ${{ matrix.dc-files }}

.gitignore

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: SUSE LLC
+# SPDX-License-Identifier: Apache-2.0
+
+.env
 .elixir_ls
 
 

.licenserc.yaml

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: SUSE LLC
+# SPDX-License-Identifier: Apache-2.0
+
+header:
+  comment: on-failure
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: SUSE LLC
+    software-name: trento-docs
+    content: |
+      SPDX-FileCopyrightText: SUSE LLC
+      SPDX-License-Identifier: Apache-2.0
+  paths-ignore:
+    - "**/*.adoc"
+    - "**/*.drawio"
+    - "**/*.dump"
+    - "**/*.eslintrc"
+    - "**/*.hbs"
+    - "**/*.json"
+    - "**/*.nvmrc"
+    - "**/*.stylelintrc"
+    - "**/*.svg"
+    - ".github/dependabot.yml"
+    - ".tool-versions"
+    - "LICENSE"
+    - "content/**"
+    - "trento/**"
+
+  language:
+    JavaScript:
+      extensions:
+        - ".js"
+        - ".jsx"
+        - ".mjs"
+        - ".cjs"
+      comment_style_id: DoubleSlash