From 91f61cfbd3ae9e03e170aa9b9e46ba78727878c9 Mon Sep 17 00:00:00 2001 From: Guillaume Lours <705411+glours@users.noreply.github.com> Date: Thu, 2 Nov 2023 19:11:09 +0100 Subject: [PATCH] update cli-docs-gen tools to remove old reference doc files Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> --- Makefile | 2 +- docs/reference/compose_alpha.md | 22 --- docs/reference/compose_alpha_dry-run.md | 8 - docs/reference/compose_alpha_scale.md | 15 -- .../docker_compose_alpha_dry-run.yaml | 14 -- .../reference/docker_compose_alpha_scale.yaml | 35 ----- docs/reference/docker_compose_convert.yaml | 140 ------------------ docs/yaml/main/generate.go | 4 +- go.mod | 2 + go.sum | 4 +- 10 files changed, 7 insertions(+), 239 deletions(-) delete mode 100644 docs/reference/compose_alpha.md delete mode 100644 docs/reference/compose_alpha_dry-run.md delete mode 100644 docs/reference/compose_alpha_scale.md delete mode 100644 docs/reference/docker_compose_alpha_dry-run.yaml delete mode 100644 docs/reference/docker_compose_alpha_scale.yaml delete mode 100644 docs/reference/docker_compose_convert.yaml diff --git a/Makefile b/Makefile index 0a68e65bc6..1a645f9877 100644 --- a/Makefile +++ b/Makefile @@ -116,7 +116,7 @@ lint: ## run linter(s) docs: ## generate documentation $(eval $@_TMP_OUT := $(shell mktemp -d -t compose-output.XXXXXXXXXX)) $(BUILDX_CMD) bake --set "*.output=type=local,dest=$($@_TMP_OUT)" docs-update - rm -rf ./docs/internal + rm -rf ./docs/reference/* cp -R "$(DRIVE_PREFIX)$($@_TMP_OUT)"/out/* ./docs/ rm -rf "$(DRIVE_PREFIX)$($@_TMP_OUT)"/* diff --git a/docs/reference/compose_alpha.md b/docs/reference/compose_alpha.md deleted file mode 100644 index 34485d7def..0000000000 --- a/docs/reference/compose_alpha.md +++ /dev/null @@ -1,22 +0,0 @@ -# docker compose alpha - - -Experimental commands - -### Subcommands - -| Name | Description | -|:----------------------------------|:-----------------------------------------------------------------------------------------------------| -| [`viz`](compose_alpha_viz.md) | EXPERIMENTAL - Generate a graphviz graph from your compose file | -| [`watch`](compose_alpha_watch.md) | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated | - - -### Options - -| Name | Type | Default | Description | -|:------------|:-----|:--------|:--------------------------------| -| `--dry-run` | | | Execute command in dry run mode | - - - - diff --git a/docs/reference/compose_alpha_dry-run.md b/docs/reference/compose_alpha_dry-run.md deleted file mode 100644 index 9e8350e2a0..0000000000 --- a/docs/reference/compose_alpha_dry-run.md +++ /dev/null @@ -1,8 +0,0 @@ -# docker compose alpha dry-run - - -Dry run command allows you to test a command without applying changes. - - - - diff --git a/docs/reference/compose_alpha_scale.md b/docs/reference/compose_alpha_scale.md deleted file mode 100644 index 15536b359c..0000000000 --- a/docs/reference/compose_alpha_scale.md +++ /dev/null @@ -1,15 +0,0 @@ -# docker compose alpha scale - - -Scale services. - -### Options - -| Name | Type | Default | Description | -|:------------|:-----|:--------|:--------------------------------| -| `--dry-run` | | | Execute command in dry run mode | -| `--no-deps` | | | Don't start linked services | - - - - diff --git a/docs/reference/docker_compose_alpha_dry-run.yaml b/docs/reference/docker_compose_alpha_dry-run.yaml deleted file mode 100644 index d489d39aeb..0000000000 --- a/docs/reference/docker_compose_alpha_dry-run.yaml +++ /dev/null @@ -1,14 +0,0 @@ -command: docker compose alpha dry-run -short: | - EXPERIMENTAL - Dry run command allow you to test a command without applying changes -long: | - EXPERIMENTAL - Dry run command allow you to test a command without applying changes -usage: docker compose alpha dry-run -- [COMMAND...] -pname: docker compose alpha -plink: docker_compose_alpha.yaml -deprecated: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/docs/reference/docker_compose_alpha_scale.yaml b/docs/reference/docker_compose_alpha_scale.yaml deleted file mode 100644 index cc381493fa..0000000000 --- a/docs/reference/docker_compose_alpha_scale.yaml +++ /dev/null @@ -1,35 +0,0 @@ -command: docker compose alpha scale -short: Scale services -long: Scale services -usage: docker compose alpha scale [SERVICE=REPLICAS...] -pname: docker compose alpha -plink: docker_compose_alpha.yaml -options: - - option: no-deps - value_type: bool - default_value: "false" - description: Don't start linked services. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -inherited_options: - - option: dry-run - value_type: bool - default_value: "false" - description: Execute command in dry run mode - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -hidden: false -experimental: false -experimentalcli: true -kubernetes: false -swarm: false - diff --git a/docs/reference/docker_compose_convert.yaml b/docs/reference/docker_compose_convert.yaml deleted file mode 100644 index d191322196..0000000000 --- a/docs/reference/docker_compose_convert.yaml +++ /dev/null @@ -1,140 +0,0 @@ -command: docker compose convert -aliases: docker compose convert, docker compose config -short: Converts the compose file to platform's canonical format -long: |- - `docker compose convert` renders the actual data model to be applied on the target platform. When used with the Docker engine, - it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into - the canonical format. - - To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config` -usage: docker compose convert [OPTIONS] [SERVICE...] -pname: docker compose -plink: docker_compose.yaml -options: - - option: format - value_type: string - default_value: yaml - description: 'Format the output. Values: [yaml | json]' - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: hash - value_type: string - description: Print the service config hash, one per line. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: images - value_type: bool - default_value: "false" - description: Print the image names, one per line. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: no-consistency - value_type: bool - default_value: "false" - description: | - Don't check model consistency - warning: may produce invalid Compose output - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: no-interpolate - value_type: bool - default_value: "false" - description: Don't interpolate environment variables. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: no-normalize - value_type: bool - default_value: "false" - description: Don't normalize compose model. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: output - shorthand: o - value_type: string - description: Save to file (default to stdout) - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: profiles - value_type: bool - default_value: "false" - description: Print the profile names, one per line. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only validate the configuration, don't print anything. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: resolve-image-digests - value_type: bool - default_value: "false" - description: Pin image tags to digests. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: services - value_type: bool - default_value: "false" - description: Print the service names, one per line. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false - - option: volumes - value_type: bool - default_value: "false" - description: Print the volume names, one per line. - deprecated: false - hidden: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/docs/yaml/main/generate.go b/docs/yaml/main/generate.go index 90ac25cf13..a969fb1ebb 100644 --- a/docs/yaml/main/generate.go +++ b/docs/yaml/main/generate.go @@ -48,7 +48,7 @@ func generateDocs(opts *options) error { if err != nil { return err } - return tool.GenAllTree() + return tool.GenAllTreeAndRemoveOldFiles() } func disableFlagsInUseLine(cmd *cobra.Command) { @@ -77,7 +77,7 @@ func main() { cwd, _ := os.Getwd() opts := &options{ source: filepath.Join(cwd, "docs", "reference"), - target: filepath.Join(cwd, "docs", "reference"), + target: filepath.Join(cwd, "docs", "tmp"), } fmt.Printf("Project root: %s\n", opts.source) fmt.Printf("Generating yaml files into %s\n", opts.target) diff --git a/go.mod b/go.mod index 067ff46dbf..fa26d9616b 100644 --- a/go.mod +++ b/go.mod @@ -178,3 +178,5 @@ require ( sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect sigs.k8s.io/yaml v1.3.0 // indirect ) + +replace github.com/docker/cli-docs-tool v0.6.0 => github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0 diff --git a/go.sum b/go.sum index c2122a6626..1cf0575366 100644 --- a/go.sum +++ b/go.sum @@ -177,8 +177,6 @@ github.com/docker/buildx v0.11.2 h1:R3p9F0gnI4FwvQ0p40UwdX1T4ugap4UWxY3TFHoP4Ws= github.com/docker/buildx v0.11.2/go.mod h1:CWAABt10iIuGpleypA3103mplDfcGu0A2AvT03xfpTc= github.com/docker/cli v24.0.6+incompatible h1:fF+XCQCgJjjQNIMjzaSmiKJSCcfcXb3TWTcc7GAneOY= github.com/docker/cli v24.0.6+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.6.0 h1:Z9x10SaZgFaB6jHgz3OWooynhSa40CsWkpe5hEnG/qA= -github.com/docker/cli-docs-tool v0.6.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= @@ -226,6 +224,8 @@ github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbS github.com/fvbommel/sortorder v1.0.2 h1:mV4o8B2hKboCdkJm+a7uX/SIpZob4JzUpc5GGnM45eo= github.com/fvbommel/sortorder v1.0.2/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0= github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0 h1:qvqOkwG1Er7Ev9x4ymZWh51Ab5LeQdqUEmPnzYhi/Gw= +github.com/glours/cli-docs-tool v0.6.1-0.20231102180605-fea6905ab3d0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=