mirror of
https://github.com/prometheus-operator/prometheus-operator.git
synced 2025-04-16 09:16:38 +00:00
docs: Run embedmd on both Docs and kube-prometheus README.md
This commit is contained in:
parent
e432d8241d
commit
42f173b82e
3 changed files with 6 additions and 2 deletions
2
Makefile
2
Makefile
|
@ -66,7 +66,7 @@ po-docgen:
|
||||||
@go install github.com/coreos/prometheus-operator/cmd/po-docgen
|
@go install github.com/coreos/prometheus-operator/cmd/po-docgen
|
||||||
|
|
||||||
docs: embedmd po-docgen
|
docs: embedmd po-docgen
|
||||||
$(GOPATH)/bin/embedmd -w `find Documentation -name "*.md"`
|
$(GOPATH)/bin/embedmd -w `find Documentation contrib/kube-prometheus/README.md -name "*.md"`
|
||||||
$(GOPATH)/bin/po-docgen api pkg/client/monitoring/v1/types.go > Documentation/api.md
|
$(GOPATH)/bin/po-docgen api pkg/client/monitoring/v1/types.go > Documentation/api.md
|
||||||
$(GOPATH)/bin/po-docgen compatibility > Documentation/compatibility.md
|
$(GOPATH)/bin/po-docgen compatibility > Documentation/compatibility.md
|
||||||
|
|
||||||
|
|
|
@ -83,9 +83,11 @@ To compile the above and get each manifest in a separate file on disk use the fo
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -e
|
set -e
|
||||||
set -x
|
set -x
|
||||||
|
# only exit with zero if all commands of the pipeline exit successfully
|
||||||
|
set -o pipefail
|
||||||
|
|
||||||
# optional, but we would like to generate yaml, not json
|
# optional, but we would like to generate yaml, not json
|
||||||
jsonnet -J vendor -m manifests example.jsonnet | xargs -I{} sh -c 'cat $1 | gojsontoyaml > $1.yaml; rm $1' -- {}
|
jsonnet -J vendor -m manifests example.jsonnet | xargs -I{} sh -c 'cat $1 | gojsontoyaml > $1.yaml; rm -f $1' -- {}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -e
|
set -e
|
||||||
set -x
|
set -x
|
||||||
|
# only exit with zero if all commands of the pipeline exit successfully
|
||||||
|
set -o pipefail
|
||||||
|
|
||||||
# optional, but we would like to generate yaml, not json
|
# optional, but we would like to generate yaml, not json
|
||||||
jsonnet -J vendor -m manifests example.jsonnet | xargs -I{} sh -c 'cat $1 | gojsontoyaml > $1.yaml; rm -f $1' -- {}
|
jsonnet -J vendor -m manifests example.jsonnet | xargs -I{} sh -c 'cat $1 | gojsontoyaml > $1.yaml; rm -f $1' -- {}
|
||||||
|
|
Loading…
Add table
Reference in a new issue