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.

Sign up for GitHub

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

Jump to bottom

update cli-docs-gen tools to remove old reference doc files #11155

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −239
Draft

update cli-docs-gen tools to remove old reference doc files #11155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Expand Up @@ -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)"/*

Expand Down
22 changes: 0 additions & 22 deletions docs/reference/compose_alpha.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions docs/reference/compose_alpha_dry-run.md
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions docs/reference/compose_alpha_scale.md
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions docs/reference/docker_compose_alpha_dry-run.yaml
View file
Open in desktop

This file was deleted.

35 changes: 0 additions & 35 deletions docs/reference/docker_compose_alpha_scale.yaml
View file
Open in desktop

This file was deleted.

140 changes: 0 additions & 140 deletions docs/reference/docker_compose_convert.yaml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/yaml/main/generate.go
View file
Open in desktop
Expand Up @@ -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) {
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions go.mod
View file
Open in desktop
Expand Up @@ -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
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Expand Up @@ -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=
Expand Down Expand Up @@ -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=
Expand Down