diff --git a/.gitignore b/.gitignore index 59838458271..54b63518f16 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ /docs/*.[158] /docs/*.[158].gz /docs/remote +/docs/build/ *.o *.orig /pause/pause.o @@ -25,3 +26,4 @@ release.txt podman-remote*.zip podman*.tar.gz .idea* +.vscode* diff --git a/Makefile b/Makefile index 4f709cf2c4f..7584d20dd24 100644 --- a/Makefile +++ b/Makefile @@ -168,13 +168,11 @@ podman-remote: .gopathok $(PODMAN_VARLINK_DEPENDENCIES) ## Build with podman on $(GO_BUILD) $(BUILDFLAGS) -gcflags '$(GCFLAGS)' -asmflags '$(ASMFLAGS)' -ldflags '$(LDFLAGS_PODMAN)' -tags "$(BUILDTAGS) remoteclient" -o bin/$@ $(PROJECT)/cmd/podman .PHONY: podman.msi -podman.msi: podman-remote podman-remote-windows docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp - rm -rf bin/windows - mkdir -p bin/windows - docs/podman-remote.sh windows bin/windows docs - find bin/windows -print \ - |wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix bin/windows/ >bin/windows/pages.wsx - wixl -D VERSION=$(RELEASE_NUMBER) -D ManSourceDir=bin/windows -o podman-v$(RELEASE_NUMBER).msi contrib/msi/podman.wxs bin/windows/pages.wsx +podman.msi: podman-remote podman-remote-windows install-podman-remote-docs ## Will always rebuild exe as there is no podman-remote-windows.exe target to verify timestamp + $(eval DOCFILE := docs/build/remote/windows) + find $(DOCFILE) -print \ + |wixl-heat --var var.ManSourceDir --component-group ManFiles --directory-ref INSTALLDIR --prefix $(DOCFILE)/ >$(DOCFILE)/pages.wsx + wixl -D VERSION=$(RELEASE_NUMBER) -D ManSourceDir=$(DOCFILE) -o podman-v$(RELEASE_NUMBER).msi contrib/msi/podman.wxs $(DOCFILE)/pages.wsx podman-remote-%: .gopathok $(PODMAN_VARLINK_DEPENDENCIES) ## Build podman for a specific GOOS $(eval BINSFX := $(shell test "$*" != "windows" || echo ".exe")) @@ -197,7 +195,6 @@ clean: ## Clean artifacts $(wildcard podman*.tar.gz) \ bin \ build \ - docs/remote \ test/checkseccomp/checkseccomp \ test/goecho/goecho \ test/testdata/redis-image \ @@ -311,24 +308,28 @@ install.catatonit: test-binaries: test/checkseccomp/checkseccomp test/goecho/goecho install.catatonit -MANPAGES_MD ?= $(wildcard docs/source/man/*.md pkg/*/docs/*.md) +MANPAGES_MD ?= $(wildcard docs/source/markdown/*.md pkg/*/docs/*.md) MANPAGES ?= $(MANPAGES_MD:%.md=%) MANPAGES_DEST ?= $(subst source,build,$(MANPAGES)) $(MANPAGES): %: %.md .gopathok - @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source,build,$@) + @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $(subst source/markdown,build/man,$@) docdir: mkdir -p docs/build/man docs: docdir $(MANPAGES) ## Generate documentation -install-podman-remote-docs: podman-remote docs - rm -rf docs/remote - docs/podman-remote.sh darwin docs/remote docs +install-podman-remote-docs: podman-remote docs $(MANPAGES) + rm -rf docs/build/remote + mkdir -p docs/build/remote + ln -sf $(shell pwd)/docs/source/markdown/links docs/build/man/ + docs/remote-docs.sh darwin docs/build/remote/darwin docs/build/man + docs/remote-docs.sh linux docs/build/remote/linux docs/build/man + docs/remote-docs.sh windows docs/build/remote/windows docs/source/markdown man-page-check: - ./hack/man-page-checker + hack/man-page-checker # When publishing releases include critical build-time details .PHONY: release.txt @@ -362,13 +363,7 @@ podman-remote-v$(RELEASE_NUMBER)-%.zip: # release.txt location and content depended upon by automated tooling cp release.txt "$(TMPDIR)/" cp ./bin/podman-remote-$*$(BINSFX) "$(TMPDIR)/$(SUBDIR)/podman$(BINSFX)" - cp -r ./docs/remote "$(TMPDIR)/$(SUBDIR)/docs/" - $(eval DOCFILE := $(TMPDIR)/$(SUBDIR)/docs/podman.1) - cp docs/podman-remote.1 "$(DOCFILE)" - sed -i 's/podman\\*-remote/podman/g' "$(DOCFILE)" - sed -i 's/Podman\\*-remote/Podman\ for\ $*/g' "$(DOCFILE)" - sed -i 's/podman\.conf/podman\-remote\.conf/g' "$(DOCFILE)" - sed -i 's/A\ remote\ CLI\ for\ Podman\:\ //g' "$(DOCFILE)" + cp -r ./docs/build/remote/$* "$(TMPDIR)/$(SUBDIR)/docs/" cd "$(TMPDIR)" && \ zip --recurse-paths "$(CURDIR)/$@" "./release.txt" "./" -rm -rf "$(TMPDIR)" diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 00000000000..4514afa77aa --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,21 @@ +# Build the Docs + +## Directory Structure + +| | Directory | +| ------------------------------------ | --------------------------- | +| Markdown source for man pages | docs/source/markdown/ | +| man pages aliases as .so files | docs/source/markdown/links/ | +| restructured text for readthedocs.io | docs/rst/ | +| target for output | docs/build | +| man pages | docs/build/man | +| remote linux man pages | docs/build/remote/linux | +| remote darwin man pages | docs/build/remote/darwin | +| remote windows html pages | docs/build/remote/windows | + +## Support files + +| | | +| ------------------------------------ | --------------------------- | +| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | +| docs/links-to-html.lua | pandoc filter to do aliases for html files | \ No newline at end of file diff --git a/docs/podman-remote.sh b/docs/remote-docs.sh similarity index 57% rename from docs/podman-remote.sh rename to docs/remote-docs.sh index d8ce4a359b5..1440b09267d 100755 --- a/docs/podman-remote.sh +++ b/docs/remote-docs.sh @@ -1,17 +1,17 @@ #!/bin/bash -e # Assemble remote man pages for darwin or windows from markdown files -PLATFORM=$1 ## windows or darwin -TARGET=$2 ## where to output files +PLATFORM=$1 ## linux, windows or darwin +TARGET=${2} ## where to output files SOURCES=${@:3} ## directories to find markdown files PODMAN=${PODMAN:-bin/podman-remote} ## location overridden for testing function usage() { echo >&2 "$0 PLATFORM TARGET SOURCES..." - echo >&2 "PLATFORM: Is either darwin or windows." - echo >&2 "TARGET: Is the directory where files will be staged." - echo >&2 "SOURCES: Are the directories to source markdown files." + echo >&2 "PLATFORM: Is either linux, darwin or windows." + echo >&2 "TARGET: Is the directory where files will be staged. eg, docs/build/remote/linux" + echo >&2 "SOURCES: Are the directories of source files. eg, docs/markdown" } function fail() { @@ -21,19 +21,17 @@ function fail() { } case $PLATFORM in -'darwin') - EXT=1 - PUBLISHER=darwin_fn +darwin|linux) + PUBLISHER=man_fn ;; -'windows') - EXT=1.md - PUBLISHER=windows_fn +windows) + PUBLISHER=html_fn ;; -'-help') +-help) usage exit 0 ;; -*) fail '"darwin" and "windows" are currently the only supported platforms.' ;; +*) fail '"linux", "darwin" and "windows" are the only supported platforms.' ;; esac if [[ -z $TARGET ]]; then @@ -48,19 +46,20 @@ if [[ ! -x $PODMAN ]]; then fail "$PODMAN does not exist" fi -## darwin_fn copies the markdown page or link to flattened directory -function darwin_fn() { - local markdown=$1 - local file=$(basename $markdown) - local dir=$(dirname $markdown) - if [[ -f $dir/../../links/$file ]]; then - markdown=$dir/../../links/$file +## man_fn copies the man page or link to flattened directory +function man_fn() { + local page=$1 + local file=$(basename $page) + local dir=$(dirname $page) + + if [[ ! -f $page ]]; then + page=$dir/links/${file%.*}.1 fi - install $markdown $TARGET + install $page $TARGET/${file%%.*}.1 } -## windows_fn converts the markdown page or link to HTML -function windows_fn() { +## html_fn converts the markdown page or link to HTML +function html_fn() { local markdown=$1 local file=$(basename $markdown) local dir=$(dirname $markdown) @@ -69,21 +68,26 @@ function windows_fn() { local link=$(sed -e 's?.so man1/\(.*\)?\1?' <$dir/links/${file%.md}) markdown=$dir/$link.md fi - pandoc --ascii --lua-filter=$dir/links-to-html.lua -o $TARGET/${file%.$EXT}.html $markdown + pandoc --ascii --lua-filter=docs/links-to-html.lua -o $TARGET/${file%%.*}.html $markdown } ## pub_pages finds and publishes the remote manual pages function pub_pages() { local source=$1 local publisher=$2 - for f in $(ls $source/podman-remote*$EXT); do + for f in $(ls $source/podman-remote*); do $publisher $f done + # rename podman-remote.ext to podman.ext and copy + local remote=$(echo $TARGET/podman-remote.*) + local ext=${remote##*.} + cp -f $remote $TARGET/podman.$ext + for c in "container" "image" "pod" "volume" ""; do local cmd=${c:+-$c} for s in $($PODMAN $c --help | sed -n '/^Available Commands:/,/^Flags:/p' | sed -e '1d;$d' -e '/^$/d' | awk '{print $1}'); do - $publisher $source/podman$cmd-$s.$EXT + $publisher $(echo $source/podman$cmd-$s.*) done done } diff --git a/docs/links/podman-container-attach.1 b/docs/source/markdown/links/podman-container-attach.1 similarity index 100% rename from docs/links/podman-container-attach.1 rename to docs/source/markdown/links/podman-container-attach.1 diff --git a/docs/links/podman-container-commit.1 b/docs/source/markdown/links/podman-container-commit.1 similarity index 100% rename from docs/links/podman-container-commit.1 rename to docs/source/markdown/links/podman-container-commit.1 diff --git a/docs/links/podman-container-cp.1 b/docs/source/markdown/links/podman-container-cp.1 similarity index 100% rename from docs/links/podman-container-cp.1 rename to docs/source/markdown/links/podman-container-cp.1 diff --git a/docs/links/podman-container-create.1 b/docs/source/markdown/links/podman-container-create.1 similarity index 100% rename from docs/links/podman-container-create.1 rename to docs/source/markdown/links/podman-container-create.1 diff --git a/docs/links/podman-container-diff.1 b/docs/source/markdown/links/podman-container-diff.1 similarity index 100% rename from docs/links/podman-container-diff.1 rename to docs/source/markdown/links/podman-container-diff.1 diff --git a/docs/links/podman-container-exec.1 b/docs/source/markdown/links/podman-container-exec.1 similarity index 100% rename from docs/links/podman-container-exec.1 rename to docs/source/markdown/links/podman-container-exec.1 diff --git a/docs/links/podman-container-export.1 b/docs/source/markdown/links/podman-container-export.1 similarity index 100% rename from docs/links/podman-container-export.1 rename to docs/source/markdown/links/podman-container-export.1 diff --git a/docs/links/podman-container-init.1 b/docs/source/markdown/links/podman-container-init.1 similarity index 100% rename from docs/links/podman-container-init.1 rename to docs/source/markdown/links/podman-container-init.1 diff --git a/docs/links/podman-container-inspect.1 b/docs/source/markdown/links/podman-container-inspect.1 similarity index 100% rename from docs/links/podman-container-inspect.1 rename to docs/source/markdown/links/podman-container-inspect.1 diff --git a/docs/links/podman-container-kill.1 b/docs/source/markdown/links/podman-container-kill.1 similarity index 100% rename from docs/links/podman-container-kill.1 rename to docs/source/markdown/links/podman-container-kill.1 diff --git a/docs/links/podman-container-list.1 b/docs/source/markdown/links/podman-container-list.1 similarity index 100% rename from docs/links/podman-container-list.1 rename to docs/source/markdown/links/podman-container-list.1 diff --git a/docs/links/podman-container-logs.1 b/docs/source/markdown/links/podman-container-logs.1 similarity index 100% rename from docs/links/podman-container-logs.1 rename to docs/source/markdown/links/podman-container-logs.1 diff --git a/docs/links/podman-container-ls.1 b/docs/source/markdown/links/podman-container-ls.1 similarity index 100% rename from docs/links/podman-container-ls.1 rename to docs/source/markdown/links/podman-container-ls.1 diff --git a/docs/links/podman-container-mount.1 b/docs/source/markdown/links/podman-container-mount.1 similarity index 100% rename from docs/links/podman-container-mount.1 rename to docs/source/markdown/links/podman-container-mount.1 diff --git a/docs/links/podman-container-pause.1 b/docs/source/markdown/links/podman-container-pause.1 similarity index 100% rename from docs/links/podman-container-pause.1 rename to docs/source/markdown/links/podman-container-pause.1 diff --git a/docs/links/podman-container-port.1 b/docs/source/markdown/links/podman-container-port.1 similarity index 100% rename from docs/links/podman-container-port.1 rename to docs/source/markdown/links/podman-container-port.1 diff --git a/docs/links/podman-container-ps.1 b/docs/source/markdown/links/podman-container-ps.1 similarity index 100% rename from docs/links/podman-container-ps.1 rename to docs/source/markdown/links/podman-container-ps.1 diff --git a/docs/links/podman-container-restart.1 b/docs/source/markdown/links/podman-container-restart.1 similarity index 100% rename from docs/links/podman-container-restart.1 rename to docs/source/markdown/links/podman-container-restart.1 diff --git a/docs/links/podman-container-rm.1 b/docs/source/markdown/links/podman-container-rm.1 similarity index 100% rename from docs/links/podman-container-rm.1 rename to docs/source/markdown/links/podman-container-rm.1 diff --git a/docs/links/podman-container-run.1 b/docs/source/markdown/links/podman-container-run.1 similarity index 100% rename from docs/links/podman-container-run.1 rename to docs/source/markdown/links/podman-container-run.1 diff --git a/docs/links/podman-container-start.1 b/docs/source/markdown/links/podman-container-start.1 similarity index 100% rename from docs/links/podman-container-start.1 rename to docs/source/markdown/links/podman-container-start.1 diff --git a/docs/links/podman-container-stats.1 b/docs/source/markdown/links/podman-container-stats.1 similarity index 100% rename from docs/links/podman-container-stats.1 rename to docs/source/markdown/links/podman-container-stats.1 diff --git a/docs/links/podman-container-stop.1 b/docs/source/markdown/links/podman-container-stop.1 similarity index 100% rename from docs/links/podman-container-stop.1 rename to docs/source/markdown/links/podman-container-stop.1 diff --git a/docs/links/podman-container-top.1 b/docs/source/markdown/links/podman-container-top.1 similarity index 100% rename from docs/links/podman-container-top.1 rename to docs/source/markdown/links/podman-container-top.1 diff --git a/docs/links/podman-container-umount.1 b/docs/source/markdown/links/podman-container-umount.1 similarity index 100% rename from docs/links/podman-container-umount.1 rename to docs/source/markdown/links/podman-container-umount.1 diff --git a/docs/links/podman-container-unmount.1 b/docs/source/markdown/links/podman-container-unmount.1 similarity index 100% rename from docs/links/podman-container-unmount.1 rename to docs/source/markdown/links/podman-container-unmount.1 diff --git a/docs/links/podman-container-unpause.1 b/docs/source/markdown/links/podman-container-unpause.1 similarity index 100% rename from docs/links/podman-container-unpause.1 rename to docs/source/markdown/links/podman-container-unpause.1 diff --git a/docs/links/podman-container-wait.1 b/docs/source/markdown/links/podman-container-wait.1 similarity index 100% rename from docs/links/podman-container-wait.1 rename to docs/source/markdown/links/podman-container-wait.1 diff --git a/docs/links/podman-help.1 b/docs/source/markdown/links/podman-help.1 similarity index 100% rename from docs/links/podman-help.1 rename to docs/source/markdown/links/podman-help.1 diff --git a/docs/links/podman-image-build.1 b/docs/source/markdown/links/podman-image-build.1 similarity index 100% rename from docs/links/podman-image-build.1 rename to docs/source/markdown/links/podman-image-build.1 diff --git a/docs/links/podman-image-history.1 b/docs/source/markdown/links/podman-image-history.1 similarity index 100% rename from docs/links/podman-image-history.1 rename to docs/source/markdown/links/podman-image-history.1 diff --git a/docs/links/podman-image-import.1 b/docs/source/markdown/links/podman-image-import.1 similarity index 100% rename from docs/links/podman-image-import.1 rename to docs/source/markdown/links/podman-image-import.1 diff --git a/docs/links/podman-image-inspect.1 b/docs/source/markdown/links/podman-image-inspect.1 similarity index 100% rename from docs/links/podman-image-inspect.1 rename to docs/source/markdown/links/podman-image-inspect.1 diff --git a/docs/links/podman-image-list.1 b/docs/source/markdown/links/podman-image-list.1 similarity index 100% rename from docs/links/podman-image-list.1 rename to docs/source/markdown/links/podman-image-list.1 diff --git a/docs/links/podman-image-load.1 b/docs/source/markdown/links/podman-image-load.1 similarity index 100% rename from docs/links/podman-image-load.1 rename to docs/source/markdown/links/podman-image-load.1 diff --git a/docs/links/podman-image-ls.1 b/docs/source/markdown/links/podman-image-ls.1 similarity index 100% rename from docs/links/podman-image-ls.1 rename to docs/source/markdown/links/podman-image-ls.1 diff --git a/docs/links/podman-image-pull.1 b/docs/source/markdown/links/podman-image-pull.1 similarity index 100% rename from docs/links/podman-image-pull.1 rename to docs/source/markdown/links/podman-image-pull.1 diff --git a/docs/links/podman-image-push.1 b/docs/source/markdown/links/podman-image-push.1 similarity index 100% rename from docs/links/podman-image-push.1 rename to docs/source/markdown/links/podman-image-push.1 diff --git a/docs/links/podman-image-rm.1 b/docs/source/markdown/links/podman-image-rm.1 similarity index 100% rename from docs/links/podman-image-rm.1 rename to docs/source/markdown/links/podman-image-rm.1 diff --git a/docs/links/podman-image-save.1 b/docs/source/markdown/links/podman-image-save.1 similarity index 100% rename from docs/links/podman-image-save.1 rename to docs/source/markdown/links/podman-image-save.1 diff --git a/docs/links/podman-image-tag.1 b/docs/source/markdown/links/podman-image-tag.1 similarity index 100% rename from docs/links/podman-image-tag.1 rename to docs/source/markdown/links/podman-image-tag.1 diff --git a/docs/links/podman-list.1 b/docs/source/markdown/links/podman-list.1 similarity index 100% rename from docs/links/podman-list.1 rename to docs/source/markdown/links/podman-list.1 diff --git a/docs/links/podman-ls.1 b/docs/source/markdown/links/podman-ls.1 similarity index 100% rename from docs/links/podman-ls.1 rename to docs/source/markdown/links/podman-ls.1 diff --git a/docs/links/podman-system-info.1 b/docs/source/markdown/links/podman-system-info.1 similarity index 100% rename from docs/links/podman-system-info.1 rename to docs/source/markdown/links/podman-system-info.1 diff --git a/docs/links/podman-unmount.1 b/docs/source/markdown/links/podman-unmount.1 similarity index 100% rename from docs/links/podman-unmount.1 rename to docs/source/markdown/links/podman-unmount.1 diff --git a/docs/source/man/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md similarity index 100% rename from docs/source/man/podman-attach.1.md rename to docs/source/markdown/podman-attach.1.md diff --git a/docs/source/man/podman-build.1.md b/docs/source/markdown/podman-build.1.md similarity index 100% rename from docs/source/man/podman-build.1.md rename to docs/source/markdown/podman-build.1.md diff --git a/docs/source/man/podman-commit.1.md b/docs/source/markdown/podman-commit.1.md similarity index 100% rename from docs/source/man/podman-commit.1.md rename to docs/source/markdown/podman-commit.1.md diff --git a/docs/source/man/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md similarity index 100% rename from docs/source/man/podman-container-checkpoint.1.md rename to docs/source/markdown/podman-container-checkpoint.1.md diff --git a/docs/source/man/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md similarity index 100% rename from docs/source/man/podman-container-cleanup.1.md rename to docs/source/markdown/podman-container-cleanup.1.md diff --git a/docs/source/man/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md similarity index 100% rename from docs/source/man/podman-container-exists.1.md rename to docs/source/markdown/podman-container-exists.1.md diff --git a/docs/source/man/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md similarity index 100% rename from docs/source/man/podman-container-prune.1.md rename to docs/source/markdown/podman-container-prune.1.md diff --git a/docs/source/man/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md similarity index 100% rename from docs/source/man/podman-container-restore.1.md rename to docs/source/markdown/podman-container-restore.1.md diff --git a/docs/source/man/podman-container-runlabel.1.md b/docs/source/markdown/podman-container-runlabel.1.md similarity index 100% rename from docs/source/man/podman-container-runlabel.1.md rename to docs/source/markdown/podman-container-runlabel.1.md diff --git a/docs/source/man/podman-container.1.md b/docs/source/markdown/podman-container.1.md similarity index 100% rename from docs/source/man/podman-container.1.md rename to docs/source/markdown/podman-container.1.md diff --git a/docs/source/man/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md similarity index 100% rename from docs/source/man/podman-cp.1.md rename to docs/source/markdown/podman-cp.1.md diff --git a/docs/source/man/podman-create.1.md b/docs/source/markdown/podman-create.1.md similarity index 100% rename from docs/source/man/podman-create.1.md rename to docs/source/markdown/podman-create.1.md diff --git a/docs/source/man/podman-diff.1.md b/docs/source/markdown/podman-diff.1.md similarity index 100% rename from docs/source/man/podman-diff.1.md rename to docs/source/markdown/podman-diff.1.md diff --git a/docs/source/man/podman-events.1.md b/docs/source/markdown/podman-events.1.md similarity index 100% rename from docs/source/man/podman-events.1.md rename to docs/source/markdown/podman-events.1.md diff --git a/docs/source/man/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md similarity index 100% rename from docs/source/man/podman-exec.1.md rename to docs/source/markdown/podman-exec.1.md diff --git a/docs/source/man/podman-export.1.md b/docs/source/markdown/podman-export.1.md similarity index 100% rename from docs/source/man/podman-export.1.md rename to docs/source/markdown/podman-export.1.md diff --git a/docs/source/man/podman-generate-kube.1.md b/docs/source/markdown/podman-generate-kube.1.md similarity index 100% rename from docs/source/man/podman-generate-kube.1.md rename to docs/source/markdown/podman-generate-kube.1.md diff --git a/docs/source/man/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md similarity index 100% rename from docs/source/man/podman-generate-systemd.1.md rename to docs/source/markdown/podman-generate-systemd.1.md diff --git a/docs/source/man/podman-generate.1.md b/docs/source/markdown/podman-generate.1.md similarity index 100% rename from docs/source/man/podman-generate.1.md rename to docs/source/markdown/podman-generate.1.md diff --git a/docs/source/man/podman-healthcheck-run.1.md b/docs/source/markdown/podman-healthcheck-run.1.md similarity index 100% rename from docs/source/man/podman-healthcheck-run.1.md rename to docs/source/markdown/podman-healthcheck-run.1.md diff --git a/docs/source/man/podman-healthcheck.1.md b/docs/source/markdown/podman-healthcheck.1.md similarity index 100% rename from docs/source/man/podman-healthcheck.1.md rename to docs/source/markdown/podman-healthcheck.1.md diff --git a/docs/source/man/podman-history.1.md b/docs/source/markdown/podman-history.1.md similarity index 100% rename from docs/source/man/podman-history.1.md rename to docs/source/markdown/podman-history.1.md diff --git a/docs/source/man/podman-image-exists.1.md b/docs/source/markdown/podman-image-exists.1.md similarity index 100% rename from docs/source/man/podman-image-exists.1.md rename to docs/source/markdown/podman-image-exists.1.md diff --git a/docs/source/man/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md similarity index 100% rename from docs/source/man/podman-image-prune.1.md rename to docs/source/markdown/podman-image-prune.1.md diff --git a/docs/source/man/podman-image-sign.1.md b/docs/source/markdown/podman-image-sign.1.md similarity index 100% rename from docs/source/man/podman-image-sign.1.md rename to docs/source/markdown/podman-image-sign.1.md diff --git a/docs/source/man/podman-image-tree.1.md b/docs/source/markdown/podman-image-tree.1.md similarity index 100% rename from docs/source/man/podman-image-tree.1.md rename to docs/source/markdown/podman-image-tree.1.md diff --git a/docs/source/man/podman-image-trust.1.md b/docs/source/markdown/podman-image-trust.1.md similarity index 100% rename from docs/source/man/podman-image-trust.1.md rename to docs/source/markdown/podman-image-trust.1.md diff --git a/docs/source/man/podman-image.1.md b/docs/source/markdown/podman-image.1.md similarity index 100% rename from docs/source/man/podman-image.1.md rename to docs/source/markdown/podman-image.1.md diff --git a/docs/source/man/podman-images.1.md b/docs/source/markdown/podman-images.1.md similarity index 100% rename from docs/source/man/podman-images.1.md rename to docs/source/markdown/podman-images.1.md diff --git a/docs/source/man/podman-import.1.md b/docs/source/markdown/podman-import.1.md similarity index 100% rename from docs/source/man/podman-import.1.md rename to docs/source/markdown/podman-import.1.md diff --git a/docs/source/man/podman-info.1.md b/docs/source/markdown/podman-info.1.md similarity index 100% rename from docs/source/man/podman-info.1.md rename to docs/source/markdown/podman-info.1.md diff --git a/docs/source/man/podman-init.1.md b/docs/source/markdown/podman-init.1.md similarity index 100% rename from docs/source/man/podman-init.1.md rename to docs/source/markdown/podman-init.1.md diff --git a/docs/source/man/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md similarity index 100% rename from docs/source/man/podman-inspect.1.md rename to docs/source/markdown/podman-inspect.1.md diff --git a/docs/source/man/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md similarity index 100% rename from docs/source/man/podman-kill.1.md rename to docs/source/markdown/podman-kill.1.md diff --git a/docs/source/man/podman-load.1.md b/docs/source/markdown/podman-load.1.md similarity index 100% rename from docs/source/man/podman-load.1.md rename to docs/source/markdown/podman-load.1.md diff --git a/docs/source/man/podman-login.1.md b/docs/source/markdown/podman-login.1.md similarity index 100% rename from docs/source/man/podman-login.1.md rename to docs/source/markdown/podman-login.1.md diff --git a/docs/source/man/podman-logout.1.md b/docs/source/markdown/podman-logout.1.md similarity index 100% rename from docs/source/man/podman-logout.1.md rename to docs/source/markdown/podman-logout.1.md diff --git a/docs/source/man/podman-logs.1.md b/docs/source/markdown/podman-logs.1.md similarity index 100% rename from docs/source/man/podman-logs.1.md rename to docs/source/markdown/podman-logs.1.md diff --git a/docs/source/man/podman-mount.1.md b/docs/source/markdown/podman-mount.1.md similarity index 100% rename from docs/source/man/podman-mount.1.md rename to docs/source/markdown/podman-mount.1.md diff --git a/docs/source/man/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md similarity index 100% rename from docs/source/man/podman-network-create.1.md rename to docs/source/markdown/podman-network-create.1.md diff --git a/docs/source/man/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md similarity index 100% rename from docs/source/man/podman-network-inspect.1.md rename to docs/source/markdown/podman-network-inspect.1.md diff --git a/docs/source/man/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md similarity index 100% rename from docs/source/man/podman-network-ls.1.md rename to docs/source/markdown/podman-network-ls.1.md diff --git a/docs/source/man/podman-network-rm.1.md b/docs/source/markdown/podman-network-rm.1.md similarity index 100% rename from docs/source/man/podman-network-rm.1.md rename to docs/source/markdown/podman-network-rm.1.md diff --git a/docs/source/man/podman-network.1.md b/docs/source/markdown/podman-network.1.md similarity index 100% rename from docs/source/man/podman-network.1.md rename to docs/source/markdown/podman-network.1.md diff --git a/docs/source/man/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md similarity index 100% rename from docs/source/man/podman-pause.1.md rename to docs/source/markdown/podman-pause.1.md diff --git a/docs/source/man/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md similarity index 100% rename from docs/source/man/podman-play-kube.1.md rename to docs/source/markdown/podman-play-kube.1.md diff --git a/docs/source/man/podman-play.1.md b/docs/source/markdown/podman-play.1.md similarity index 100% rename from docs/source/man/podman-play.1.md rename to docs/source/markdown/podman-play.1.md diff --git a/docs/source/man/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md similarity index 100% rename from docs/source/man/podman-pod-create.1.md rename to docs/source/markdown/podman-pod-create.1.md diff --git a/docs/source/man/podman-pod-exists.1.md b/docs/source/markdown/podman-pod-exists.1.md similarity index 100% rename from docs/source/man/podman-pod-exists.1.md rename to docs/source/markdown/podman-pod-exists.1.md diff --git a/docs/source/man/podman-pod-inspect.1.md b/docs/source/markdown/podman-pod-inspect.1.md similarity index 100% rename from docs/source/man/podman-pod-inspect.1.md rename to docs/source/markdown/podman-pod-inspect.1.md diff --git a/docs/source/man/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md similarity index 100% rename from docs/source/man/podman-pod-kill.1.md rename to docs/source/markdown/podman-pod-kill.1.md diff --git a/docs/source/man/podman-pod-pause.1.md b/docs/source/markdown/podman-pod-pause.1.md similarity index 100% rename from docs/source/man/podman-pod-pause.1.md rename to docs/source/markdown/podman-pod-pause.1.md diff --git a/docs/source/man/podman-pod-prune.1.md b/docs/source/markdown/podman-pod-prune.1.md similarity index 100% rename from docs/source/man/podman-pod-prune.1.md rename to docs/source/markdown/podman-pod-prune.1.md diff --git a/docs/source/man/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md similarity index 100% rename from docs/source/man/podman-pod-ps.1.md rename to docs/source/markdown/podman-pod-ps.1.md diff --git a/docs/source/man/podman-pod-restart.1.md b/docs/source/markdown/podman-pod-restart.1.md similarity index 100% rename from docs/source/man/podman-pod-restart.1.md rename to docs/source/markdown/podman-pod-restart.1.md diff --git a/docs/source/man/podman-pod-rm.1.md b/docs/source/markdown/podman-pod-rm.1.md similarity index 100% rename from docs/source/man/podman-pod-rm.1.md rename to docs/source/markdown/podman-pod-rm.1.md diff --git a/docs/source/man/podman-pod-start.1.md b/docs/source/markdown/podman-pod-start.1.md similarity index 100% rename from docs/source/man/podman-pod-start.1.md rename to docs/source/markdown/podman-pod-start.1.md diff --git a/docs/source/man/podman-pod-stats.1.md b/docs/source/markdown/podman-pod-stats.1.md similarity index 100% rename from docs/source/man/podman-pod-stats.1.md rename to docs/source/markdown/podman-pod-stats.1.md diff --git a/docs/source/man/podman-pod-stop.1.md b/docs/source/markdown/podman-pod-stop.1.md similarity index 100% rename from docs/source/man/podman-pod-stop.1.md rename to docs/source/markdown/podman-pod-stop.1.md diff --git a/docs/source/man/podman-pod-top.1.md b/docs/source/markdown/podman-pod-top.1.md similarity index 100% rename from docs/source/man/podman-pod-top.1.md rename to docs/source/markdown/podman-pod-top.1.md diff --git a/docs/source/man/podman-pod-unpause.1.md b/docs/source/markdown/podman-pod-unpause.1.md similarity index 100% rename from docs/source/man/podman-pod-unpause.1.md rename to docs/source/markdown/podman-pod-unpause.1.md diff --git a/docs/source/man/podman-pod.1.md b/docs/source/markdown/podman-pod.1.md similarity index 100% rename from docs/source/man/podman-pod.1.md rename to docs/source/markdown/podman-pod.1.md diff --git a/docs/source/man/podman-port.1.md b/docs/source/markdown/podman-port.1.md similarity index 100% rename from docs/source/man/podman-port.1.md rename to docs/source/markdown/podman-port.1.md diff --git a/docs/source/man/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md similarity index 100% rename from docs/source/man/podman-ps.1.md rename to docs/source/markdown/podman-ps.1.md diff --git a/docs/source/man/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md similarity index 100% rename from docs/source/man/podman-pull.1.md rename to docs/source/markdown/podman-pull.1.md diff --git a/docs/source/man/podman-push.1.md b/docs/source/markdown/podman-push.1.md similarity index 100% rename from docs/source/man/podman-push.1.md rename to docs/source/markdown/podman-push.1.md diff --git a/docs/source/man/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md similarity index 100% rename from docs/source/man/podman-remote.1.md rename to docs/source/markdown/podman-remote.1.md diff --git a/docs/source/man/podman-restart.1.md b/docs/source/markdown/podman-restart.1.md similarity index 100% rename from docs/source/man/podman-restart.1.md rename to docs/source/markdown/podman-restart.1.md diff --git a/docs/source/man/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md similarity index 100% rename from docs/source/man/podman-rm.1.md rename to docs/source/markdown/podman-rm.1.md diff --git a/docs/source/man/podman-rmi.1.md b/docs/source/markdown/podman-rmi.1.md similarity index 100% rename from docs/source/man/podman-rmi.1.md rename to docs/source/markdown/podman-rmi.1.md diff --git a/docs/source/man/podman-run.1.md b/docs/source/markdown/podman-run.1.md similarity index 100% rename from docs/source/man/podman-run.1.md rename to docs/source/markdown/podman-run.1.md diff --git a/docs/source/man/podman-save.1.md b/docs/source/markdown/podman-save.1.md similarity index 100% rename from docs/source/man/podman-save.1.md rename to docs/source/markdown/podman-save.1.md diff --git a/docs/source/man/podman-search.1.md b/docs/source/markdown/podman-search.1.md similarity index 100% rename from docs/source/man/podman-search.1.md rename to docs/source/markdown/podman-search.1.md diff --git a/docs/source/man/podman-start.1.md b/docs/source/markdown/podman-start.1.md similarity index 100% rename from docs/source/man/podman-start.1.md rename to docs/source/markdown/podman-start.1.md diff --git a/docs/source/man/podman-stats.1.md b/docs/source/markdown/podman-stats.1.md similarity index 100% rename from docs/source/man/podman-stats.1.md rename to docs/source/markdown/podman-stats.1.md diff --git a/docs/source/man/podman-stop.1.md b/docs/source/markdown/podman-stop.1.md similarity index 100% rename from docs/source/man/podman-stop.1.md rename to docs/source/markdown/podman-stop.1.md diff --git a/docs/source/man/podman-system-df.1.md b/docs/source/markdown/podman-system-df.1.md similarity index 100% rename from docs/source/man/podman-system-df.1.md rename to docs/source/markdown/podman-system-df.1.md diff --git a/docs/source/man/podman-system-migrate.1.md b/docs/source/markdown/podman-system-migrate.1.md similarity index 100% rename from docs/source/man/podman-system-migrate.1.md rename to docs/source/markdown/podman-system-migrate.1.md diff --git a/docs/source/man/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md similarity index 100% rename from docs/source/man/podman-system-prune.1.md rename to docs/source/markdown/podman-system-prune.1.md diff --git a/docs/source/man/podman-system-renumber.1.md b/docs/source/markdown/podman-system-renumber.1.md similarity index 100% rename from docs/source/man/podman-system-renumber.1.md rename to docs/source/markdown/podman-system-renumber.1.md diff --git a/docs/source/man/podman-system.1.md b/docs/source/markdown/podman-system.1.md similarity index 100% rename from docs/source/man/podman-system.1.md rename to docs/source/markdown/podman-system.1.md diff --git a/docs/source/man/podman-tag.1.md b/docs/source/markdown/podman-tag.1.md similarity index 100% rename from docs/source/man/podman-tag.1.md rename to docs/source/markdown/podman-tag.1.md diff --git a/docs/source/man/podman-top.1.md b/docs/source/markdown/podman-top.1.md similarity index 100% rename from docs/source/man/podman-top.1.md rename to docs/source/markdown/podman-top.1.md diff --git a/docs/source/man/podman-umount.1.md b/docs/source/markdown/podman-umount.1.md similarity index 100% rename from docs/source/man/podman-umount.1.md rename to docs/source/markdown/podman-umount.1.md diff --git a/docs/source/man/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md similarity index 100% rename from docs/source/man/podman-unpause.1.md rename to docs/source/markdown/podman-unpause.1.md diff --git a/docs/source/man/podman-unshare.1.md b/docs/source/markdown/podman-unshare.1.md similarity index 100% rename from docs/source/man/podman-unshare.1.md rename to docs/source/markdown/podman-unshare.1.md diff --git a/docs/source/man/podman-varlink.1.md b/docs/source/markdown/podman-varlink.1.md similarity index 100% rename from docs/source/man/podman-varlink.1.md rename to docs/source/markdown/podman-varlink.1.md diff --git a/docs/source/man/podman-version.1.md b/docs/source/markdown/podman-version.1.md similarity index 100% rename from docs/source/man/podman-version.1.md rename to docs/source/markdown/podman-version.1.md diff --git a/docs/source/man/podman-volume-create.1.md b/docs/source/markdown/podman-volume-create.1.md similarity index 100% rename from docs/source/man/podman-volume-create.1.md rename to docs/source/markdown/podman-volume-create.1.md diff --git a/docs/source/man/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md similarity index 100% rename from docs/source/man/podman-volume-inspect.1.md rename to docs/source/markdown/podman-volume-inspect.1.md diff --git a/docs/source/man/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md similarity index 100% rename from docs/source/man/podman-volume-ls.1.md rename to docs/source/markdown/podman-volume-ls.1.md diff --git a/docs/source/man/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md similarity index 100% rename from docs/source/man/podman-volume-prune.1.md rename to docs/source/markdown/podman-volume-prune.1.md diff --git a/docs/source/man/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md similarity index 100% rename from docs/source/man/podman-volume-rm.1.md rename to docs/source/markdown/podman-volume-rm.1.md diff --git a/docs/source/man/podman-volume.1.md b/docs/source/markdown/podman-volume.1.md similarity index 100% rename from docs/source/man/podman-volume.1.md rename to docs/source/markdown/podman-volume.1.md diff --git a/docs/source/man/podman-wait.1.md b/docs/source/markdown/podman-wait.1.md similarity index 100% rename from docs/source/man/podman-wait.1.md rename to docs/source/markdown/podman-wait.1.md diff --git a/docs/source/man/podman.1.md b/docs/source/markdown/podman.1.md similarity index 100% rename from docs/source/man/podman.1.md rename to docs/source/markdown/podman.1.md