diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml new file mode 100644 index 00000000..7a94df6e --- /dev/null +++ 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 index 4edd132f..828beee9 100644 --- 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 index 070b39da..adbfb8a2 100644 --- 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 index b33d0cf3..02d6b98a 100644 --- 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 index 65c99245..ed2fd4f7 100644 --- 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 ~~~~~~~~~~~