Merge pull request #167 from ayberk/mkdocs

Migrate to mkdocs

.github/workflows/publish_docs.yml

@@ -0,0 +1,20 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v1
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/book/README.md

@@ -5,3 +5,4 @@
 This is the official documentation for the Kubernetes AWS cloud provider.
 
 WARNING: this docs site is actively under development.
+

docs/book/getting_started.md

@@ -1,14 +1,13 @@
 # Getting Started
 
-## AWS Cloud Controller Manager
-
-Before you start, make sure you go through the [prerequisites](../prerequisites.md).
+Before you start, make sure you go through the [prerequisites](prerequisites.md).
 
 In order to launch a cluster running the aws-cloud-controller-manager, you can run the appropriate container image release from this repository on an existing cluster, or you can use a deployment tool that has support for deploying it, like kops.
 
 ## Running on an Existing Cluster
 
 Follow these steps when upgrading an existing cluster by launching the aws-cloud-controller-manager as a pod:
+
 1. Temporarily stop the kube-controller-managers from running.
 1. Add the `--cloud-provider=external` to the kube-controller-manager config.
 1. Add the `--cloud-provider=external` to the kube-apiserver config.

docs/book/SUMMARY.md → docs/book/index.md

@@ -1,6 +1,9 @@
-# Summary
+# Home
+
+This is the official documentation for the Kubernetes AWS cloud provider.
+
+WARNING: this docs site is actively under development.
 
-* [Introduction](README.md)
 * Cloud Controller Manager
     * [Prerequisites](prerequisites.md)
     * [Getting Started](getting_started.md)

mkdocs.yml

@@ -0,0 +1,11 @@
+site_name: Kubernetes AWS Cloud Provider
+docs_dir: ./docs/book
+site_description: Documentation for AWS Cloud Provider for Kubernetes
+repo_name: kubernetes/cloud-provider-aws/
+repo_url: https://github.com/kubernetes/cloud-provider-aws/
+theme: material
+nav:
+  - index.md
+  - prerequisites.md
+  - getting_started.md
+  - development.md