feat(docs): Add make serve-docs, fix live reload (#2151)

Signed-off-by: Oliver Gondža <ogondza@gmail.com>

Author: olivergondza

Makefile

@@ -387,3 +387,7 @@ ginkgo: ## Download ginkgo locally if necessary.
 .PHONY: update-dependencies
 update-dependencies:
 	hack/update-dependencies-script/run.sh
+
+.PHONY: serve-docs
+serve-docs: ## Serve documentation locally using mkdocs in a container
+	$(CONTAINER_RUNTIME) run --rm -it -p 8000:8000 -v $(PWD):/argocd-operator -w /argocd-operator --name argocd-operator-mkdocs registry.access.redhat.com/ubi9/python-311:latest /bin/bash -c "pip install -r docs/requirements.txt && mkdocs serve -a 0.0.0.0:8000"

docs/developer-guide/development.md

@@ -1,4 +1,3 @@
-
 # Development
 
 ### Requirements
@@ -146,31 +145,8 @@ For configuring specific properties based on the use case, you can look at the e
 
 ### Build and Verify Argo CD Operator Docs
 
-**Note**: Please note that you need to have `Python3` Installed as a prerequisite.
-
-Create a Python Virtual Environment. This is not mandatory, you can continue without creating a Virtual Environment as well.
-
-```bash
-python3 -m venv doc
-```
-
-Get into the virtual environment, if you have created one using the above step.
-
-```bash
-source doc/bin/activate
-```
-
-Install the required Python libraries
-
-```bash
-pip3 install mkdocs
-pip3 install mkdocs-material
-```
-
-Start the `mkdocs` server locally to verify the UI changes.
-
 ```bash
-mkdocs serve
+make serve-docs
 ```
 
 ### Default Argo CD Version

docs/requirements.txt

@@ -7,4 +7,6 @@ markdown_include==0.8.1
 pygments==2.20.0
 jinja2==3.1.6
 markdown==3.10
-pymdown-extensions==10.17.1
+pymdown-extensions==10.17.1
+# Workaround for https://github.com/mkdocs/mkdocs/issues/4032
+click==8.2.1