Merge pull request #1845 from rkratky/FR-5662_docs-checks

Add docs checks to GH workflows
canonical · Oct 24, 2023 · 41114a0 · 41114a0
2 parents 4f1b2cc + d28b09b
commit 41114a0
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 3 deletions.
diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml
@@ -0,0 +1,22 @@
+name: Main Documentation Checks
+
+on:
+  pull_request:
+    paths:
+      - 'doc/**'
+  push:
+    paths:
+      - 'doc/**'
+  workflow_dispatch:
+    paths:
+      - 'doc/**'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true  
+
+jobs:
+  documentation-checks:
+    uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
+    with:
+      working-directory: 'doc'
diff --git a/doc/.wordlist.txt b/doc/.wordlist.txt
@@ -25,6 +25,7 @@ VM
 YAML
 addons
 balancer
+boolean
 dropdown
 favicon
 installable

diff --git a/doc/Makefile b/doc/Makefile
@@ -55,7 +55,7 @@ linkcheck:
 	. $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck  "$(SOURCEDIR)" "$(BUILDDIR)"
 
 woke:
-	type woke >/dev/null 2>&1 || { sudo snap install woke; exit 1; }
+	type woke >/dev/null 2>&1 || { sudo snap install woke || exit 1; }
 	woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml
 
 .PHONY: help Makefile

diff --git a/doc/index.rst b/doc/index.rst
@@ -1,6 +1,6 @@
 .. _index:
 
-Ubuntu Installation documentation
+Ubuntu installation documentation
 #################################
 
 -----

diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst
@@ -667,7 +667,7 @@ admin-name
 ~~~~~~~~~~
 
 A domain account name with privilege to perform the join operation. That
-account's password will be requested during runtime.
+account's password will be requested during run time.
 
 domain-name
 ~~~~~~~~~~~