Generate YAML doc

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2021-08-25 19:09:42 +02:00
parent a8a3b1738e
commit b8a602821c
130 changed files with 10889 additions and 13503 deletions
--- a/vendor/github.com/docker/cli-docs-tool/README.md
+++ b/vendor/github.com/docker/cli-docs-tool/README.md
@@ -0,0 +1,118 @@
+[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/docker/cli-docs-tool)
+[![Test Status](https://img.shields.io/github/workflow/status/docker/cli-docs-tool/test?label=test&logo=github&style=flat-square)](https://github.com/docker/cli-docs-tool/actions?query=workflow%3Atest)
+[![Go Report Card](https://goreportcard.com/badge/github.com/docker/cli-docs-tool)](https://goreportcard.com/report/github.com/docker/cli-docs-tool)
+
+## About
+
+This is a library containing utilities to generate (reference) documentation
+for the [`docker` CLI](https://github.com/docker/cli) on [docs.docker.com](https://docs.docker.com/reference/).
+
+## Disclaimer
+
+This library is intended for use by Docker's CLIs, and is not intended to be a
+general-purpose utility. Various bits are hard-coded or make assumptions that
+are very specific to our use-case. Contributions are welcome, but we will not
+accept contributions to make this a general-purpose module.
+
+## Usage
+
+To generate the documentation it's recommended to do so using a Go submodule
+in your repository.
+
+We will use the example of `docker/buildx` and create a Go submodule in a
+`docs` folder (recommended):
+
+```console
+$ mkdir docs
+$ cd ./docs
+$ go mod init github.com/docker/buildx/docs
+$ go get github.com/docker/cli-docs-tool
+```
+
+Your `go.mod` should look like this:
+
+```text
+module github.com/docker/buildx/docs
+
+go 1.16
+
+require (
+	github.com/docker/cli-docs-tool v0.0.0
+)
+```
+
+Next, create a file named `docgen.go` inside that directory containing the
+following Go code:
+
+```go
+package main
+
+import (
+  "log"
+  "os"
+  "path/filepath"
+
+  "github.com/docker/buildx/commands"
+  "github.com/docker/cli/cli/command"
+  clidocstool "github.com/docker/cli-docs-tool"
+  "github.com/spf13/cobra"
+)
+
+const sourcePath = "docs/"
+
+func main() {
+  log.SetFlags(0)
+
+  dockerCLI, err := command.NewDockerCli()
+  if err != nil {
+    log.Printf("ERROR: %+v", err)
+  }
+
+  cmd := &cobra.Command{
+    Use:               "docker [OPTIONS] COMMAND [ARG...]",
+    Short:             "The base command for the Docker CLI.",
+    DisableAutoGenTag: true,
+  }
+
+  cmd.AddCommand(commands.NewRootCmd("buildx", true, dockerCLI))
+  clidocstool.DisableFlagsInUseLine(cmd)
+
+  cwd, _ := os.Getwd()
+  source := filepath.Join(cwd, sourcePath)
+
+  // Make sure "source" folder is created first
+  if err = os.MkdirAll(source, 0755); err != nil {
+    log.Printf("ERROR: %+v", err)
+  }
+  
+  // Generate Markdown and YAML documentation to "source" folder
+  if err = clidocstool.GenTree(cmd, source); err != nil {
+    log.Printf("ERROR: %+v", err)
+  }
+}
+```
+
+Here we create a new instance of Docker CLI with `command.NewDockerCli` and a
+subcommand `commands.NewRootCmd` for `buildx`.
+
+Finally, we generate Markdown and YAML documentation with `clidocstool.GenTree`.
+
+```console
+$ go run main.go
+INFO: Generating Markdown for "docker buildx bake"
+INFO: Generating Markdown for "docker buildx build"
+INFO: Generating Markdown for "docker buildx create"
+INFO: Generating Markdown for "docker buildx du"
+...
+INFO: Generating YAML for "docker buildx uninstall"
+INFO: Generating YAML for "docker buildx use"
+INFO: Generating YAML for "docker buildx version"
+INFO: Generating YAML for "docker buildx"
+```
+
+Generated docs will be available in the `./docs` folder of the project.
+
+## Contributing
+
+Want to contribute? Awesome! You can find information about contributing to
+this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)