Merge pull request #15 from crichez/repo/antsibull-docs-init

Build and lint the docsite on new pull-requests

.github/workflows/lint-docs.yaml

@@ -0,0 +1,35 @@
+name: build-docs
+on:
+  workflow_dispatch:
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-docs:
+    permissions:
+      contents: read
+    uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
+    with:
+      init-lenient: false
+      init-fail-on-error: true
+
+  lint-docs:
+    name: Lint Docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install antsibull-docs
+        run: pip install antsibull-docs
+      - name: Lint Docs
+        run: |
+          antsibull-docs lint-collection-docs \
+          --plugin-docs \
+          --validate-collection-refs=all \
+          --disallow-unknown-collection-refs .

.gitignore

@@ -1 +1,2 @@
-.vscode
+.vscode
+changelogs/.plugin-cache.yaml

roles/uki_config/meta/argument_specs.yaml

@@ -65,3 +65,8 @@ argument_specs:
       uki_config_kernel_install_config_root:
         type: path
         default: /etc/kernel
+        description: |
+          The path where configuration files are stored.
+
+          This should usually be `/etc/kernel` (the default), but you may wish
+          to use `/usr/lib/kernel` instead.