Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(build) split build documentation into sections #2104

Merged
merged 1 commit into from
Jun 7, 2021
Merged

chore(build) split build documentation into sections #2104

merged 1 commit into from
Jun 7, 2021

Conversation

jpeach
Copy link
Contributor

@jpeach jpeach commented Jun 6, 2021

Summary

Improve readability by automatically splitting the output
of make help into sections.

Signed-off-by: James Peach james.peach@konghq.com

Full changelog

N/A

Issues resolved

N/A

Documentation

N/A

Testing

$ make help
check                          Dev: Run code checks (go fmt, go vet, ...)
clean                          Dev: Clean
docs                           Dev: Generate all docs
fmt                            Dev: Run various format tools
generate                       Dev: Run code generators
golangci-lint                  Dev: Runs golangci-lint linter
helm-docs                      Dev: Runs helm-docs generator
help                           Display this help screen
images                         Dev: Rebuild release and tesst Docker images
imports                        Dev: Runs goimports in order to organize imports
integration                    Dev: Run integration tests
test                           Dev: Run tests for all modules
vet                            Dev: Run go vet

apply/example/minikube/mtls    Minikube: enable mTLS
apply/traffic-routing/docker-compose/mtls Docker Compose: enable mTLS
apply/traffic-routing/docker-compose/no-mtls Docker Compose: disable mTLS
apply/traffic-routing/docker-compose/web-to-backend-route Docker Compose: create "web-to-backend" route
apply/traffic-routing/minikube/mtls Minikube: enable mTLS
apply/traffic-routing/minikube/no-mtls Minikube: disable mTLS
apply/traffic-routing/minikube/web-to-backend-route Minikube: create "web-to-backend" route

build/example/docker-compose   Docker Compose: Build Docker images of the Control Plane
build/example/minikube         Minikube: Build Docker images inside Minikube
build/kuma-cp                  Dev: Build `Control Plane` binary
build/kumactl                  Dev: Build `kumactl` binary
build/kuma-dp                  Dev: Build `kuma-dp` binary
build/kuma-prometheus-sd       Dev: Build `kuma-prometheus-sd` binary
build/release                  Dev: Build all binaries
build/test-server              Dev: Build `test-server` binary

clean/build                    Dev: Remove build/ dir
clean/proto                    Dev: Remove auto-generated Protobuf files

config_dump/example/envoy      Dev: Dump effective configuration of example Envoy

curl/example/docker-compose    Docker Compose: Make sample requests to the example setup
curl/example/minikube          Minikube: Make sample requests to demo setup

delete/traffic-routing/docker-compose/web-to-backend-route Docker Compose: delete "web-to-backend" route
delete/traffic-routing/minikube/web-to-backend-route Minikube: delete "web-to-backend" route

deploy/example/docker-compose  Docker Compose: Run example setup
deploy/example/minikube        Minikube: Deploy example setup
deploy/example/minikube/metrics Minikube: Deploy metrics setup
deploy/kuma/minikube           Minikube: Deploy Kuma with no demo app
deploy/traffic-routing/minikube Minikube: Deploy example setup for TrafficRoute

dev/install/ginkgo             Bootstrap: Install Ginkgo (BDD testing framework)
dev/install/goimports          Bootstrap: Install goimports
dev/install/golangci-lint      Bootstrap: Install golangci-lint
dev/install/helm3              Bootstrap: Install Helm 3
dev/install/helm-docs          Bootstrap: Install helm-docs
dev/install/k3d                Bootstrap: Install K3D (K3s in Docker)
dev/install/kind               Bootstrap: Install KIND (Kubernetes in Docker)
dev/install/kubebuilder        Bootstrap: Install Kubebuilder (including etcd and kube-apiserver)
dev/install/kubectl            Bootstrap: Install kubectl
dev/install/kustomize          Bootstrap: Install Kustomize
dev/install/minikube           Bootstrap: Install Minikube
dev/install/protobuf-wellknown-types Bootstrap: Install Protobuf well-known types
dev/install/protoc             Bootstrap: Install Protoc (protobuf compiler)
dev/install/protoc-gen-go      Bootstrap: Install Protoc Go Plugin (protobuf Go generator)
dev/install/protoc-gen-validate Bootstrap: Install Protoc Gen Validate Plugin (protobuf validation code generator)
dev/tools                      Bootstrap: Install all development tools

docker/build/kuma-cp           Dev: Build `kuma-cp` Docker image using existing artifact
docker/build/kumactl           Dev: Build `kumactl` Docker image using existing artifact
docker/build/kuma-dp           Dev: Build `kuma-dp` Docker image using existing artifact
docker/build/kuma-init         Dev: Build `kuma-init` Docker image using existing artifact
docker/build/kuma-prometheus-sd Dev: Build `kuma-prometheus-sd` Docker image using existing artifact
docker/build/kuma-universal    Dev: Build `kuma-universal` Docker image using existing artifact
docker/build/release           Dev: Build all Docker images using existing artifacts from build
docker/purge                   Dev: Remove all Docker containers, images, networks and volumes

docs/kumactl                   Dev: Generate `kumactl` docs

fmt/go                         Dev: Run go fmt
fmt/proto                      Dev: Run clang-format on .proto files

image/kuma-cp                  Dev: Rebuild `kuma-cp` Docker image
image/kumactl                  Dev: Rebuild `kumactl` Docker image
image/kuma-dp                  Dev: Rebuild `kuma-dp` Docker image
image/kuma-init                Dev: Rebuild `kuma-init` Docker image
image/kuma-prometheus-sd       Dev: Rebuild `kuma-prometheus-sd` Docker image

images/release                 Dev: Rebuild release Docker images
images/test                    Dev: Rebuild test Docker images

load/example/docker-compose    Docker Compose: Load Docker images
load/example/minikube          Minikube: Load Docker images into Minikube

run/example/envoy              Dev: Run Envoy configured against local Control Plane
run/k8s                        Dev: Run Control Plane locally in Kubernetes mode
run/kuma-dp                    Dev: Run `kuma-dp` locally
run/universal/memory           Dev: Run Control Plane locally in universal mode with in-memory store
run/universal/postgres         Dev: Run Control Plane locally in universal mode with Postgres store
run/universal/postgres/ssl     Dev: Run Control Plane locally in universal mode with Postgres store and SSL enabled

start/postgres                 Boostrap: start Postgres for Control Plane with initial schema
start/postgres/ssl             Boostrap: start Postgres for Control Plane with initial schema and SSL enabled

stats/example/docker-compose   Docker Compose: Observe Envoy metrics from the example setup
stats/example/minikube         Minikube: Observe Envoy metrics from demo setup

stop/postgres                  Boostrap: stop Postgres
stop/postgres/ssl              Boostrap: stop Postgres with SSL enabled

test/kuma-cp                   Dev: Run `kuma-cp` tests only
test/kumactl                   Dev: Run `kumactl` tests only
test/kuma-dp                   Dev: Run `kuma-dp` tests only

undeploy/example/docker-compose Docker Compose: Remove example setup
undeploy/example/minikube      Minikube: Undeploy example setup
undeploy/traffic-routing/minikube Minikube: Undeploy example setup for TrafficRoute

verify/example/docker-compose  Docker Compose: Verify Envoy stats (after sample requests)
verify/example/minikube/mtls   Minikube: Verify Envoy mTLS stats (after sample requests)
verify/example/minikube        Minikube: Verify Envoy stats (after sample requests)
verify/traffic-routing/docker-compose/default-route Docker Compose: Make sample requests to example setup for TrafficRoute
verify/traffic-routing/docker-compose/web-to-backend-route Docker Compose: Make sample requests to example setup for TrafficRoute
verify/traffic-routing/minikube/default-route Minikube: Make sample requests to example setup for TrafficRoute
verify/traffic-routing/minikube/web-to-backend-route Minikube: Make sample requests to example setup for TrafficRoute

wait/example/docker-compose    Docker Compose: Wait for example setup to get ready
wait/example/minikube          Minikube: Wait for demo setup to get ready
wait/example/minikube/mtls     Minikube: Wait until incoming Listener and outgoing Cluster have been configured for mTLS
wait/traffic-routing/docker-compose Docker Compose: Wait for example setup for TrafficRoute to get ready
wait/traffic-routing/docker-compose/mtls Docker Compose: Wait until incoming Listener and outgoing Cluster have been configured for mTLS
wait/traffic-routing/docker-compose/no-mtls Docker Compose: Wait until mTLS has been disabled on incoming Listener and outgoing Cluster
wait/traffic-routing/docker-compose/no-web-to-backend-route Docker Compose: Wait until custom "web-to-backend" TrafficRoute is removed
wait/traffic-routing/docker-compose/web-to-backend-route Docker Compose: Wait until custom "web-to-backend" TrafficRoute is applied
wait/traffic-routing/minikube  Minikube: Wait for example setup for TrafficRoute to get ready
wait/traffic-routing/minikube/mtls Minikube: Wait until incoming Listener and outgoing Cluster have been configured for mTLS
wait/traffic-routing/minikube/no-mtls Minikube: Wait until mTLS has been disabled on incoming Listener and outgoing Cluster
wait/traffic-routing/minikube/no-web-to-backend-route Minikube: Wait until custom "web-to-backend" TrafficRoute is removed
wait/traffic-routing/minikube/web-to-backend-route Minikube: Wait until custom "web-to-backend" TrafficRoute is applied

Improve readability by automatically splitting the output
of `make help` into sections.

Signed-off-by: James Peach <james.peach@konghq.com>
@jpeach jpeach requested a review from a team as a code owner June 6, 2021 23:42
@jpeach jpeach merged commit 6f5b8a3 into kumahq:master Jun 7, 2021
@jpeach jpeach deleted the doc/makefile-help-sections branch June 7, 2021 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants