feat: COS TLS integrations

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

@@ -5,6 +5,8 @@ on:
   push:
     branches: [ main ]
   pull_request:
+    paths:
+      - 'docs/**'   # Only run on changes to the docs directory
 
   workflow_dispatch:
     # Manual trigger

.github/workflows/markdown-style-checks.yml

@@ -4,9 +4,13 @@ on:
   push:
     branches:
     - main
+    paths:
+    - 'docs/**'   # Only run on changes to the docs directory
   pull_request:
     branches:
     - '*'
+    paths:
+    - 'docs/**'   # Only run on changes to the docs directory
 
 jobs:
   markdown-lint:

.gitignore

@@ -1,32 +1,3 @@
-
-# Starter pack rules start here
-
-# Environment
-/*env*/
-docs/.sphinx/venv/
-
-# Sphinx
-docs/.sphinx/warnings.txt
-docs/.sphinx/.wordlist.dic
-docs/.sphinx/.doctrees/
-docs/.sphinx/node_modules/
-
-# Vale
-docs/.sphinx/styles/*
-docs/.sphinx/vale.ini
-
-# Build outputs
-docs/_build
-
-# Node.js
-docs/package*.json
-
-# Unrelated cache and config files
-docs/.DS_Store
-docs/__pycache__
-docs/.idea/
-docs/.vscode/
-
 # Terraform
 **/.terraform/*
 *.tfstate

.readthedocs.yaml

@@ -11,8 +11,17 @@ build:
   tools:
     python: "3.11"
   jobs:
-    pre_install:
+    post_checkout:
     - 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
 sphinx:
@@ -27,4 +36,4 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-  - requirements: docs/.sphinx/requirements.txt
+  - requirements: docs/requirements.txt

README.md

@@ -26,7 +26,7 @@ and install sphinx dependencies:
 ```bash
 cd docs
 source .sphinx/venv/bin/activate
-pip install -r .sphinx/requirements.txt
+pip install -r requirements.txt
 ```
 
 Build and serve the docs locally:

SECURITY.md

@@ -1,5 +1,5 @@
 The easiest way to report a security issue is through a 
-[Github Private Security Report](https://github.com/canonical/observability-docs/security/advisories/new)
+[Github Private Security Report](https://github.com/canonical/observability-stack/security/advisories/new)
 with a description of the issue, the steps you took to create the issue, affected versions, and, if 
 known, mitigations for the issue.
 

docs/.gitignore

@@ -0,0 +1,26 @@
+# Environment
+*env*/
+.sphinx/venv/
+
+# Sphinx
+.sphinx/warnings.txt
+.sphinx/.wordlist.dic
+.sphinx/.doctrees/
+.sphinx/update/
+.sphinx/node_modules/
+
+# Vale
+.sphinx/styles/*
+.sphinx/vale.ini
+
+# Build outputs
+_build
+
+# Node.js
+package*.json
+
+# Unrelated cache and config files
+.DS_Store
+__pycache__
+.idea/
+.vscode/

docs/.sphinx/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: make-spelling
+        name: Run make spelling
+        entry: make -C docs spelling
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$
+
+      - id: make-linkcheck
+        name: Run make linkcheck
+        entry: make -C docs linkcheck
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$
+
+      - id: make-woke
+        name: Run make woke
+        entry: make -C docs woke
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$