Use official mkdocs image and github action
This commit is contained in:
parent
f025c31e7b
commit
42b3a1ebd2
6 changed files with 8 additions and 41 deletions
2
.github/actions/mkdocs/Dockerfile
vendored
2
.github/actions/mkdocs/Dockerfile
vendored
|
@ -1,4 +1,4 @@
|
||||||
FROM squidfunk/mkdocs-material:4.6.3
|
FROM squidfunk/mkdocs-material:5.1.0
|
||||||
|
|
||||||
COPY action.sh /action.sh
|
COPY action.sh /action.sh
|
||||||
|
|
||||||
|
|
7
Makefile
7
Makefile
|
@ -247,12 +247,7 @@ dev-env-stop: ## Deletes local Kubernetes cluster created by kind.
|
||||||
|
|
||||||
.PHONY: live-docs
|
.PHONY: live-docs
|
||||||
live-docs: ## Build and launch a local copy of the documentation website in http://localhost:3000
|
live-docs: ## Build and launch a local copy of the documentation website in http://localhost:3000
|
||||||
@docker buildx build \
|
@docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:5.1.0
|
||||||
--pull \
|
|
||||||
--load \
|
|
||||||
--progress plain \
|
|
||||||
-t ingress-nginx/mkdocs images/mkdocs
|
|
||||||
@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/mkdocs
|
|
||||||
|
|
||||||
.PHONY: misspell
|
.PHONY: misspell
|
||||||
misspell: check-go-version ## Check for spelling errors.
|
misspell: check-go-version ## Check for spelling errors.
|
||||||
|
|
|
@ -8,7 +8,6 @@ e2e-prow | Image to launch Prow jobs
|
||||||
fastcgi-helloserver | FastCGI application for e2e tests
|
fastcgi-helloserver | FastCGI application for e2e tests
|
||||||
grpc-fortune-teller | grpc server application for the nginx-ingress grpc example
|
grpc-fortune-teller | grpc server application for the nginx-ingress grpc example
|
||||||
httpbin | A simple HTTP Request & Response Service for e2e tests
|
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)
|
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.
|
: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.
|
||||||
|
|
|
@ -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"]
|
|
10
mkdocs.yml
10
mkdocs.yml
|
@ -17,17 +17,19 @@ markdown_extensions:
|
||||||
permalink: " ¶"
|
permalink: " ¶"
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
feature:
|
features:
|
||||||
tabs: true
|
- tabs
|
||||||
logo:
|
- instant
|
||||||
icon: "public" # globe icon
|
|
||||||
palette:
|
palette:
|
||||||
primary: "teal"
|
primary: "teal"
|
||||||
accent: "green"
|
accent: "green"
|
||||||
|
|
||||||
include_sidebar: true
|
include_sidebar: true
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- search
|
- search
|
||||||
|
- awesome-pages
|
||||||
|
|
||||||
extra_css: [extra.css]
|
extra_css: [extra.css]
|
||||||
|
|
||||||
|
|
|
@ -1,4 +0,0 @@
|
||||||
mkdocs-material==4.6.3
|
|
||||||
mkdocs==1.1
|
|
||||||
pymdown-extensions==6.3
|
|
||||||
pygments~=2.5.2
|
|
Loading…
Reference in a new issue