doc/mkdocs: create the mkdocs config file (#24)

* doc/mkdocs: create the mkdocs config file

* docs/mkdocs: PR review. update home and mkdocs version

* docs/dev: add mkdocs usage instructions

docs/README.md

@@ -0,0 +1,6 @@
+# OpenShift Provider Certification Tool
+
+OpenShift Provider Certification Tool is used to evaluate an OpenShift installation on a provider or hardware is in conformance.
+
+- [User Guide](./user.md)
+- [Development Guide](./dev.md)

docs/TODO.md

@@ -0,0 +1 @@
+> TODO

docs/dev.md

@@ -87,3 +87,21 @@ vi /tmp/openshift-kube-conformance.yaml
 ```
 openshift-provider-cert run --plugin /tmp/openshift-kube-conformance.yaml --plugin /tmp/openshift-conformance-validated.yaml
 ```
+
+### Project Documentation
+
+The documentation is available in the directory `docs/`. You can render it as HTML using `mkdocs` locally - it's not yet published the HTML version.
+
+To run locally you should be using `python >= 3.8`, and install the `mkdocs` running:
+
+```
+pip install hack/docs-requirements.txt
+```
+
+Then, under the root of the project, run:
+
+```
+mkdocs serve
+```
+
+Then you will be able to access the docs locally on the address: http://127.0.0.1:8000/

hack/docs-requirements.txt

@@ -0,0 +1 @@
+mkdocs==1.4

mkdocs.yml

@@ -0,0 +1,17 @@
+site_name: OpenShift Provider Certification Guide
+repo_url: https://github.com/redhat-openshift-ecosystem/provider-certification-tool
+edit_uri: edit/main/docs/
+docs_dir: ./docs
+
+theme:
+  name: readthedocs
+  highlightjs: true
+  hljs_languages:
+    - yaml
+nav:
+  - "User Guide":
+      - "User Guide": "user.md"
+  - "Support Guide":
+      - "Support Guide": TODO.md
+  - "Developer Guide":
+      - "Development Guide": dev.md