CI/CD standard: Dependabot and TechDocs (DX-660)

.github/dependabot.yml

@@ -0,0 +1,49 @@
+# Dependabot for sample-data, from the template in revenexx/.github (DX-93,
+# DX-660). Two things here are pinned: the terminal UI's npm packages, by
+# tui/package-lock.json, and the actions in the workflows. The loader is bash,
+# curl and jq, and the Python and Node build tools in tools/ have no manifest,
+# so there is nothing of theirs to bump.
+#
+# Security updates are a repository setting, not something declared here; the
+# `npm-security` group below only bundles them. Version updates come monthly.
+# Minor and patch arrive as one pull request, a major on its own.
+version: 2
+
+updates:
+  - package-ecosystem: "npm"
+    directory: "/tui"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "chore(deps)"
+    ignore:
+      # The types follow the Node release CI runs (22), not ahead of it.
+      - dependency-name: "@types/node"
+        update-types: ["version-update:semver-major"]
+    groups:
+      npm-security:
+        applies-to: security-updates
+        patterns: ["*"]
+      npm-minor-and-patch:
+        applies-to: version-updates
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  # Third-party actions. Our own reusable workflows (revenexx/.github, @v1)
+  # are not touched: they move by their tag. ci.yml calls none of them yet,
+  # since this repository is public; the ignore is for the day it can.
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    commit-message:
+      prefix: "chore(ci)"
+    ignore:
+      - dependency-name: "revenexx/.github"
+      - dependency-name: "revenexx/.github/*"
+      - dependency-name: "revenexx/.github/**"
+    groups:
+      actions:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]

catalog-info.yaml

@@ -5,6 +5,7 @@ metadata:
   description: "Sample data for a revenexx shop: four industry catalogues with prices, stock and media, a buyer company and promotions, loaded and removed with one script."
   annotations:
     github.com/project-slug: revenexx/sample-data
+    backstage.io/techdocs-ref: url:https://github.com/revenexx/sample-data/tree/main/
 spec:
   type: other
   owner: group:default/developer-experience

docs/index.md

@@ -0,0 +1,36 @@
+# Sample Data
+
+A ready-made B2B shop for a revenexx tenant: four industry catalogues
+(`industrial`, `electrical`, `office`, `lab`) with prices, stock, images,
+drawings and 3D models, plus a base with a market, a buyer company and
+promotions. `./sample-data` loads and removes them, in a terminal UI or with
+flags for CI and scripts.
+
+The [README](https://github.com/revenexx/sample-data#readme) is the full guide:
+what each pack holds, what a load changes on the tenant, what removing leaves
+behind, and how to build a pack of your own.
+
+![The terminal UI at rest: what each pack has in the shop against what it holds](tui-overview.png)
+
+## How it is built
+
+- **Plain files.** Every record is JSON under `base/` and `packs/<pack>/`; a
+  `manifest.json` per folder lists the steps in load order.
+- **One loader.** `lib/load.sh` and `lib/remove.sh` call the revenexx API.
+  Beyond the usual Unix tools they need only `bash`, `curl` and `jq`.
+- **The terminal UI** in `tui/` is a Node project (Ink, React) that drives the
+  loader and reads its progress.
+- **Generators** in `tools/` write the packs, photos, drawings and data sheets.
+  Loading never needs them.
+
+## Checks
+
+Every pull request runs
+[ci.yml](https://github.com/revenexx/sample-data/blob/main/.github/workflows/ci.yml):
+format, lint, type check and tests of `tui/`, and `tests/run-lock.sh` for the
+loader's one-run lock. Apart from that lock, the data packs, the loader and the
+generators have no checks of their own yet.
+
+## Owner
+
+Developer Experience (`@revenexx/developer-experience`).

mkdocs.yml

@@ -0,0 +1,15 @@
+site_name: Sample Data
+site_description: >-
+  Sample data for a revenexx shop: four industry catalogues with prices, stock
+  and media, loaded and removed with one script.
+repo_url: https://github.com/revenexx/sample-data
+docs_dir: docs
+
+nav:
+  - Home: index.md
+
+theme:
+  name: material
+
+plugins:
+  - techdocs-core