From 42b3a1ebd2b9e13a04b7bbd12f733c79627f0af0 Mon Sep 17 00:00:00 2001 From: Manuel Alejandro de Brito Fontes Date: Wed, 15 Apr 2020 13:06:22 -0400 Subject: [PATCH] Use official mkdocs image and github action --- .github/actions/mkdocs/Dockerfile | 2 +- Makefile | 7 +------ images/README.md | 1 - images/mkdocs/Dockerfile | 25 ------------------------- mkdocs.yml | 10 ++++++---- requirements-docs.txt | 4 ---- 6 files changed, 8 insertions(+), 41 deletions(-) delete mode 100644 images/mkdocs/Dockerfile delete mode 100644 requirements-docs.txt diff --git a/.github/actions/mkdocs/Dockerfile b/.github/actions/mkdocs/Dockerfile index c438e81b7..843eaf5ca 100644 --- 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 index a94f0a72d..f05400c6d 100644 --- 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 index df4adb0f9..bf4ed920e 100644 --- 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 deleted file mode 100644 index caab02da1..000000000 --- a/images/mkdocs/Dockerfile +++ /dev/null @@ -1,25 +0,0 @@ -# Copyright 2018 The Kubernetes Authors. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -FROM squidfunk/mkdocs-material:4.6.3 - -RUN apk add --no-cache curl \ - && curl -sSL https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/requirements-docs.txt -o requirements.txt \ - && pip install -U -r requirements.txt - -WORKDIR /docs - -EXPOSE 3000 - -ENTRYPOINT ["mkdocs", "serve", "--dev-addr=0.0.0.0:3000", "--livereload"] diff --git a/mkdocs.yml b/mkdocs.yml index c267a3ca9..5429075e6 100644 --- 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 deleted file mode 100644 index 55f8de7e6..000000000 --- a/requirements-docs.txt +++ /dev/null @@ -1,4 +0,0 @@ -mkdocs-material==4.6.3 -mkdocs==1.1 -pymdown-extensions==6.3 -pygments~=2.5.2