docs,website: add doc for kg

This commit adds a doc for `kg`, the Kilo agent that runs on every node
in the mesh. This includes: the doc itself, files needed for the
website, and tooling to generate the document using `embedmd`.

Signed-off-by: Lucas Servén Marín <lserven@gmail.com>
This commit is contained in:
Lucas Servén Marín
2020-09-23 10:54:19 +02:00
parent 5e970d8b42
commit 0cc1a2ff8c
6 changed files with 71 additions and 1 deletions

View File

@@ -31,6 +31,7 @@ INFORMER_GEN_BINARY := bin/informer-gen
LISTER_GEN_BINARY := bin/lister-gen
OPENAPI_GEN_BINARY := bin/openapi-gen
GOLINT_BINARY := bin/golint
EMBEDMD_BINARY := bin/embedmd
BUILD_IMAGE ?= golang:1.14.2-alpine
BASE_IMAGE ?= alpine:3.12
@@ -200,6 +201,13 @@ header: .header
exit 1; \
fi
tmp/help.txt: bin/$(ARCH)/kg
mkdir -p tmp
bin/$(ARCH)/kg --help 2>&1 | head -n -1 > $@
docs/kg.md: $(EMBEDMD_BINARY) tmp/help.txt
$(EMBEDMD_BINARY) -w $@
website/docs/README.md: README.md
rm -rf website/static/img/graphs
find docs -type f -name '*.md' | xargs -I{} sh -c 'cat $(@D)/$$(basename {} .md) > website/{}'
@@ -311,3 +319,6 @@ $(OPENAPI_GEN_BINARY):
$(GOLINT_BINARY):
go build -mod=vendor -o $@ golang.org/x/lint/golint
$(EMBEDMD_BINARY):
go build -mod=vendor -o $@ github.com/campoy/embedmd