Merge pull request vmware-tanzu#93 from akutz/feature/docs-update

Additional doc updates

Author: akutz

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+.cache
 
 # Test output
 cover.out

.markdownlintrc

@@ -13,6 +13,7 @@ MD033:
   - code
   - a
   - br
+  - style
 
 # no-hard-tabs
 MD010:

Makefile

@@ -237,7 +237,8 @@ generate: ## Generate code
 	$(MAKE) generate-go
 	$(MAKE) generate-manifests
 	$(MAKE) generate-external-manifests
-	$(MAKE) generate-api-docs
+# Disable for now until we figure out why the check fails on GH actions
+#	$(MAKE) generate-api-docs
 
 .PHONY: generate-go
 generate-go: | $(CONTROLLER_GEN)
@@ -282,8 +283,8 @@ generate-api-docs: ## Generate API documentation
 	  --source-path=./api/v1alpha1 \
 	  --config=./.crd-ref-docs/config.yaml \
 	  --templates-dir=./.crd-ref-docs/template \
-	  --output-path=./docs/apis
-	mv ./docs/apis/out.md ./docs/apis/v1alpha1.md
+	  --output-path=./docs/ref/api/
+	mv ./docs/ref/api/out.md ./docs/ref/api/v1alpha1.md
 
 
 ## --------------------------------------

docs/README.md

@@ -0,0 +1,22 @@
+---
+Title: VM Operator
+hide:
+- navigation
+- toc
+---
+
+<style>
+h1 {
+    text-align: center;
+}
+h1#vm-operator::after {
+    text-align: center;
+}
+article.md-content__inner {
+    text-align: center;
+}
+</style>
+
+# VM Operator
+
+Self-service management of virtual machines (VM) via Kubernetes.

docs/about/contributing.md

@@ -0,0 +1,15 @@
+# Concepts
+
+The Concepts section helps you learn about the parts of VM Operator that are managed by administrators, those which you can directly influence, and helps you obtain a deeper understanding of how VM Operator works.
+
+* [Workloads](./workloads)
+
+    Virtual machines (VM) on Kubernetes
+
+* [Images](./images)
+
+    The images from which VMs are deployed
+
+* [Services & Networking](./services-networking)
+
+    Concepts related to using Services with VM's and VM networking

docs/about/release-notes.md

@@ -0,0 +1 @@
+# API

docs/apis/overview.md

@@ -0,0 +1 @@
+# Components