first commit

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-dependabotyml
+version: 2
+
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+
+  - package-ecosystem: 'pip'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/deploy_github-pages.yml

@@ -0,0 +1,48 @@
+# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+# And: https://squidfunk.github.io/mkdocs-material/publishing-your-site/
+
+name: 'Deploy: GitHub Pages'
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: '.python-version'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Build
+        run: mkdocs build --site-dir www
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'www'
+
+  deploy:
+    needs: build
+    permissions:
+          pages: write
+          id-token: write
+    environment: github-pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+      - name: Finish
+        run: |
+          echo "Deployed at: ${{ steps.deployment.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY

.github/workflows/test_markdown-syntax.yml

@@ -0,0 +1,23 @@
+# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+
+name: 'Test: Markdown Syntax'
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**/*.md'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: 'Run Markdownlint'
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          config: '.markdownlint.yml'
+          globs: '**/*.md'

.gitignore

@@ -0,0 +1,5 @@
+# Local development
+venv
+
+# Generated/Cached files
+.cache

.markdownlint.yml

@@ -0,0 +1,7 @@
+# See: https://github.com/DavidAnson/vscode-markdownlint#configure
+
+line-length: false
+no-hard-tabs:
+  spaces_per_tab: 2
+no-multiple-blanks:
+ maximum: 2

.python-version

@@ -0,0 +1 @@
+3.x

.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+  "recommendations": [
+    "arahata.linter-actionlint",
+    "ban.spellright",
+    "dotiful.dotfiles-syntax-highlighting",
+    "editorconfig.editorconfig",
+    "fnando.linter",
+    "github.vscode-github-actions",
+    "redhat.vscode-yaml",
+    "yzhang.markdown-all-in-one"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "markdownlint.lintWorkspaceGlobs": [
+    "**/*.md",
+    "!**/node_modules",
+    "!**/.git",
+    "!**/venv"
+  ],
+  "spellright.language": [
+    "en"
+  ],
+  "spellright.documentTypes": [
+    "markdown",
+    "latex",
+    "plaintext"
+  ]
+}

.vscode/spellright.dict

@@ -0,0 +1,18 @@
+Espo
+helpdesk
+Intersolve
+octicons
+Safaricom
+toc
+VodaCash
+markdownlint
+markdownlint-disable-next-line
+lg
+fontawesome
+csv
+.csv
+koboform
+programme
+fsp
+FSP
+md

Dockerfile

@@ -0,0 +1,5 @@
+FROM squidfunk/mkdocs-material
+
+ADD requirements.txt .
+
+RUN pip install -r requirements.txt

README.md

@@ -0,0 +1,51 @@
+# Data Service Catalogue
+
+> [!TIP]
+> Read the manual: <https://rodekruis.github.io/data-service-catalogue/>
+
+## Development
+
+### Getting Started
+
+#### With Python
+
+- Install a [Python virtual environment](https://realpython.com/python-virtual-environments-a-primer/) (On Linux/macOS):
+
+  ```sh
+  python3 -m venv venv
+  source venv/bin/activate
+  ```
+
+- Install dependencies
+
+  ```sh
+  pip install -r requirements.txt
+  ```
+
+- Build the documentation
+
+  ```sh
+  mkdocs serve
+  ```
+
+- Preview at: <http://localhost:8000>
+
+#### With Docker
+
+- Install Docker: <https://docs.docker.com/get-docker/>
+
+- Open a terminal at this folder to build a Docker-container:
+
+  ```sh
+  docker build --tag data-service-catalogue .
+  ```
+
+- Run the Docker-container:
+
+  ```sh
+  docker run --rm -it -p 8000:8000 -v ${PWD}:/docs data-service-catalogue
+  ```
+
+### Tools in use
+
+- Material for MkDocs: <https://squidfunk.github.io/mkdocs-material/>