Update dev docs to include doc testing (#2930)

* Update dev docs to include doc testing * Moved doc testing to contribute_docs
canonical · Feb 7, 2024 · b209e7e · b209e7e
1 parent dfcb668
commit b209e7e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/dev-docs/documentation/contribute_docs.md b/dev-docs/documentation/contribute_docs.md
@@ -61,6 +61,18 @@ This will build *and serve* the documentation at http://127.0.0.1:8000 -- this
 gives you a live preview of any changes you make (and save) to the
 documentation without needing to continually rebuild.
 
+## Doc testing
+
+Before running the `make` command, make sure to download the Python venv module by running the following command:
+```sh
+apt install python3-venv
+```
+When working with any `docs` branch and making updates, you can run the documentation tests using the Makefile. 
+The `make` command lists all targets to test. You can run individual targets using the command:
+```bash
+make target
+```
+
 ## Docs structure and organisation
 
 We follow the [principles of Diataxis](https://diataxis.fr/) in our

diff --git a/dev-docs/howtoguides/testing.md b/dev-docs/howtoguides/testing.md
@@ -245,4 +245,4 @@ following environment variable to launch your specific Image Id instead of build
 a daily ubuntu-advantage-tools image.
 ```sh
 UACLIENT_BEHAVE_REUSE_IMAGE=your-custom-image-id tox -e behave-gcppro-20.04
-```
+```