From 8ca3f4a375ead55d001c8a0b5933d324aa1c0ddf Mon Sep 17 00:00:00 2001 From: Adphi Date: Tue, 6 Sep 2022 18:49:30 +0200 Subject: [PATCH] docs: update cli reference Signed-off-by: Adphi --- Makefile | 6 +++--- docs/{ => content}/reference/d2vm.md | 0 docs/{ => content}/reference/d2vm_build.md | 1 + docs/{ => content}/reference/d2vm_completion.md | 0 docs/{ => content}/reference/d2vm_completion_bash.md | 0 docs/{ => content}/reference/d2vm_completion_fish.md | 0 docs/{ => content}/reference/d2vm_completion_powershell.md | 0 docs/{ => content}/reference/d2vm_completion_zsh.md | 0 docs/{ => content}/reference/d2vm_convert.md | 1 + docs/{ => content}/reference/d2vm_run.md | 0 docs/{ => content}/reference/d2vm_run_hetzner.md | 0 docs/{ => content}/reference/d2vm_run_qemu.md | 0 docs/{ => content}/reference/d2vm_run_vbox.md | 0 docs/{ => content}/reference/d2vm_version.md | 0 14 files changed, 5 insertions(+), 3 deletions(-) rename docs/{ => content}/reference/d2vm.md (100%) rename docs/{ => content}/reference/d2vm_build.md (89%) rename docs/{ => content}/reference/d2vm_completion.md (100%) rename docs/{ => content}/reference/d2vm_completion_bash.md (100%) rename docs/{ => content}/reference/d2vm_completion_fish.md (100%) rename docs/{ => content}/reference/d2vm_completion_powershell.md (100%) rename docs/{ => content}/reference/d2vm_completion_zsh.md (100%) rename docs/{ => content}/reference/d2vm_convert.md (88%) rename docs/{ => content}/reference/d2vm_run.md (100%) rename docs/{ => content}/reference/d2vm_run_hetzner.md (100%) rename docs/{ => content}/reference/d2vm_run_qemu.md (100%) rename docs/{ => content}/reference/d2vm_run_vbox.md (100%) rename docs/{ => content}/reference/d2vm_version.md (100%) diff --git a/Makefile b/Makefile index e465764..6ce2eb8 100644 --- a/Makefile +++ b/Makefile @@ -28,7 +28,7 @@ GORELEASER_URL := https://github.com/goreleaser/goreleaser/releases/download/$(G BIN := $(PWD)/bin export PATH := $(BIN):$(PATH) -CLI_REFERENCE_PATH := docs/reference +CLI_REFERENCE_PATH := docs/content/reference bin: @mkdir -p $(BIN) @@ -67,7 +67,7 @@ tests: @go list ./...| xargs go test -exec sudo -count=1 -timeout 20m -v docs-up-to-date: - @$(MAKE) docs + @$(MAKE) cli-docs @git diff --quiet -- docs ':(exclude)docs/reference/d2vm_run_qemu.md' || (git --no-pager diff -- docs ':(exclude)docs/reference/d2vm_run_qemu.md'; echo "Please regenerate the documentation with 'make docs'"; exit 1) check-fmt: @@ -108,6 +108,6 @@ examples: build-dev @echo "Building examples/full/Dockerfile" @./d2vm build -o examples/build/full.qcow2 --build-arg=USER=adphi --build-arg=PASSWORD=adphi examples/full -docs: .build +cli-docs: .build @rm -rf $(CLI_REFERENCE_PATH) @./d2vm docs $(CLI_REFERENCE_PATH) diff --git a/docs/reference/d2vm.md b/docs/content/reference/d2vm.md similarity index 100% rename from docs/reference/d2vm.md rename to docs/content/reference/d2vm.md diff --git a/docs/reference/d2vm_build.md b/docs/content/reference/d2vm_build.md similarity index 89% rename from docs/reference/d2vm_build.md rename to docs/content/reference/d2vm_build.md index ce6fb61..a7f139f 100644 --- a/docs/reference/d2vm_build.md +++ b/docs/content/reference/d2vm_build.md @@ -17,6 +17,7 @@ d2vm build [context directory] [flags] --network-manager string Network manager to use for the image: none, netplan, ifupdown -o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2") -p, --password string Root user password (default "root") + --raw Just convert the container to virtual machine image without installing anything more -s, --size string The output image size (default "10G") ``` diff --git a/docs/reference/d2vm_completion.md b/docs/content/reference/d2vm_completion.md similarity index 100% rename from docs/reference/d2vm_completion.md rename to docs/content/reference/d2vm_completion.md diff --git a/docs/reference/d2vm_completion_bash.md b/docs/content/reference/d2vm_completion_bash.md similarity index 100% rename from docs/reference/d2vm_completion_bash.md rename to docs/content/reference/d2vm_completion_bash.md diff --git a/docs/reference/d2vm_completion_fish.md b/docs/content/reference/d2vm_completion_fish.md similarity index 100% rename from docs/reference/d2vm_completion_fish.md rename to docs/content/reference/d2vm_completion_fish.md diff --git a/docs/reference/d2vm_completion_powershell.md b/docs/content/reference/d2vm_completion_powershell.md similarity index 100% rename from docs/reference/d2vm_completion_powershell.md rename to docs/content/reference/d2vm_completion_powershell.md diff --git a/docs/reference/d2vm_completion_zsh.md b/docs/content/reference/d2vm_completion_zsh.md similarity index 100% rename from docs/reference/d2vm_completion_zsh.md rename to docs/content/reference/d2vm_completion_zsh.md diff --git a/docs/reference/d2vm_convert.md b/docs/content/reference/d2vm_convert.md similarity index 88% rename from docs/reference/d2vm_convert.md rename to docs/content/reference/d2vm_convert.md index 4a4ea56..46e4ebd 100644 --- a/docs/reference/d2vm_convert.md +++ b/docs/content/reference/d2vm_convert.md @@ -16,6 +16,7 @@ d2vm convert [docker image] [flags] -o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2") -p, --password string The Root user password (default "root") --pull Always pull docker image + --raw Just convert the container to virtual machine image without installing anything more -s, --size string The output image size (default "10G") ``` diff --git a/docs/reference/d2vm_run.md b/docs/content/reference/d2vm_run.md similarity index 100% rename from docs/reference/d2vm_run.md rename to docs/content/reference/d2vm_run.md diff --git a/docs/reference/d2vm_run_hetzner.md b/docs/content/reference/d2vm_run_hetzner.md similarity index 100% rename from docs/reference/d2vm_run_hetzner.md rename to docs/content/reference/d2vm_run_hetzner.md diff --git a/docs/reference/d2vm_run_qemu.md b/docs/content/reference/d2vm_run_qemu.md similarity index 100% rename from docs/reference/d2vm_run_qemu.md rename to docs/content/reference/d2vm_run_qemu.md diff --git a/docs/reference/d2vm_run_vbox.md b/docs/content/reference/d2vm_run_vbox.md similarity index 100% rename from docs/reference/d2vm_run_vbox.md rename to docs/content/reference/d2vm_run_vbox.md diff --git a/docs/reference/d2vm_version.md b/docs/content/reference/d2vm_version.md similarity index 100% rename from docs/reference/d2vm_version.md rename to docs/content/reference/d2vm_version.md