Use official mkdocs image and github action

garrettheel · Apr 15, 2020 · 42b3a1e · 42b3a1e
1 parent f025c31
commit 42b3a1e
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 41 deletions.
diff --git a/.github/actions/mkdocs/Dockerfile b/.github/actions/mkdocs/Dockerfile
@@ -1,4 +1,4 @@
-FROM squidfunk/mkdocs-material:4.6.3
+FROM squidfunk/mkdocs-material:5.1.0
 
 COPY action.sh /action.sh
 

diff --git a/Makefile b/Makefile
@@ -247,12 +247,7 @@ dev-env-stop: ## Deletes local Kubernetes cluster created by kind.
 
 .PHONY: live-docs
 live-docs: ## Build and launch a local copy of the documentation website in http://localhost:3000
-	@docker buildx build \
-		--pull \
-		--load \
-		--progress plain \
-		-t ingress-nginx/mkdocs images/mkdocs
-	@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/mkdocs
+	@docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:5.1.0
 
 .PHONY: misspell
 misspell: check-go-version ## Check for spelling errors.

diff --git a/images/README.md b/images/README.md
@@ -8,7 +8,6 @@ e2e-prow | Image to launch Prow jobs
 fastcgi-helloserver | FastCGI application for e2e tests
 grpc-fortune-teller | grpc server application for the nginx-ingress grpc example
 httpbin | A simple HTTP Request & Response Service for e2e tests
-mkdocs | Image to build the static documentation
 nginx | NGINX base image using [alpine linux](https://www.alpinelinux.org)
 
 :bangbang: Only the nginx image is meant to be published. The others are used as examples for some feature of the ingress controller or to run e2e tests.
diff --git a/images/mkdocs/Dockerfile b/images/mkdocs/Dockerfile
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -17,17 +17,19 @@ markdown_extensions:
       permalink: " ¶"
 theme:
   name: material
-  feature:
-    tabs: true
-  logo:
-    icon: "public" # globe icon
+  features:
+    - tabs
+    - instant
+
   palette:
     primary: "teal"
     accent: "green"
+
   include_sidebar: true
 
 plugins:
   - search
+  - awesome-pages
 
 extra_css: [extra.css]
 

diff --git a/requirements-docs.txt b/requirements-docs.txt