Update starter pack (#418)

* Add new starter pack workflows

* rename README file

* Move Diataxis folders to docs dir

* Consolidate ignore lists

* Move gitignore to docs folder

* Add starter pack version of readthedocs.yaml

* Remove files not needed by starter pack

* Consolidate Makefile

* Consolidate conf.py files

* Move files to docs/ dir

* Remove unneeded files, add starter pack versions

* add new requirements file

* remove unneeded python module

* Remove problematic and unnecessary tests

* Fix incorrect path for doc checks

* disable automatic checks

* Add Makefile wrapper to run commands anywhere

* Remove page, not different from Starter Pack

* Override SP defaults to retain edit/view source links

* remove hardcoded link to bundle.js

* Fix cookie banner

* Fix feedback button so it points to template

* Move remaining js/css files

* Various fixes to broken configuration

Author: s-makin

.github/workflows/automatic-doc-checks.yml

@@ -1,14 +1,23 @@
-name: Main Documentation Checks
+name: Automatic doc checks
+
+#on:
+#  push:
+#    branches: [ main ]
+#  pull_request:
+#    paths:
+#      - 'docs/**'   # Only run on changes to the docs directory
+
+  workflow_dispatch:
+    # Manual trigger
 
-on:
-  - workflow_dispatch
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true  
+  cancel-in-progress: true
 
 jobs:
   documentation-checks:
     uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
     with:
-      working-directory: '.'
+      working-directory: 'docs'
+      fetch-depth: 0

.github/workflows/cla-check.yaml

@@ -1,8 +1,9 @@
----
+# This workflow checks if the contributor has signed the Canonical Contributor Licence Agreement (CLA)
+name: Canonical Contributor Licence Agreement check
 
-name: cla-check
-
-on: [pull_request_target]
+on:
+  pull_request:
+    branches: [main]
 
 jobs:
   cla-check:

.readthedocs.yaml

@@ -12,14 +12,21 @@ build:
     python: "3.11"
   jobs:
     post_checkout:
-      - python3 .sphinx/build_requirements.py
-  apt_packages:
-    - distro-info
+    - git fetch --unshallow || true
+    # Cancel building pull requests when there aren't changed in the docs directory.
+    # If there are no changes (git diff exits with 0) we force the command to return with 183.
+    # This is a special exit code on Read the Docs that will cancel the build immediately.
+    # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
+    - |
+      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
+      then
+        exit 183;
+      fi
 
-# Build documentation in the docs/ directory with Sphinx
+# Build documentation with Sphinx
 sphinx:
   builder: dirhtml
-  configuration: conf.py
+  configuration: docs/conf.py
   fail_on_warning: false
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
@@ -29,4 +36,4 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: .sphinx/requirements.txt
+   - requirements: docs/requirements.txt