remove docs and docs command

Signed-off-by: Michael Shen <[email protected]>

Author: mjlshen

.dockerignore

@@ -1,4 +1,3 @@
-docs/
 README.md
 LICENSE
 bin/

.goreleaser.yml

@@ -41,7 +41,6 @@ changelog:
   sort: asc
   filters:
     exclude:
-      - '^docs:'
       - '^test:'
 
 release:

Makefile

@@ -11,7 +11,7 @@ SHELL := /bin/bash
 
 all: format mod build test lint
 
-format: vet mod fmt mockgen ci-build docs
+format: vet mod fmt mockgen ci-build
 
 fmt:
 	@echo "gofmt"
@@ -51,11 +51,6 @@ mod:
 	go mod tidy
 	@git diff --exit-code -- go.mod
 
-.PHONY: docs
-docs:
-	./dist/osdctl_$(shell  uname | tr [:upper:] [:lower:])_amd64_v1/osdctl docs ./docs/command
-	@git diff --exit-code -- ./docs/command/
-
 mockgen: ensure-mockgen
 	go generate ${BUILDFLAGS} ./...
 	@git diff --exit-code -- ./pkg/provider/aws/mock

README.md

@@ -68,16 +68,12 @@ make test
 
 A config file is created at ~/.config/osdctl if it does not already exist when running any command.
 The config file is yaml formatted.
-As as example:
+As an example:
 ```
 key1: value1
 key2: value2
 ```
 
-## Usage
-
-For the detailed usage of each command, please refer to [here](./docs/command).
-
 ### AWS Account CR reset
 
 `reset` command resets the Account CR status and cleans up related secrets.

cmd/cmd.go

@@ -94,9 +94,6 @@ func NewCmdRoot(streams genericclioptions.IOStreams) *cobra.Command {
 	rootCmd.AddCommand(sts.NewCmdSts(streams, kubeFlags, kubeClient))
 	rootCmd.AddCommand(promote.NewCmdPromote(kubeFlags, globalOpts))
 
-	// add docs command
-	rootCmd.AddCommand(newCmdDocs(streams))
-
 	// add completion command
 	rootCmd.AddCommand(newCmdCompletion(streams))
 
@@ -139,7 +136,7 @@ func canCommandSkipVersionCheck(commandName string) bool {
 
 // Returns allowlist of commands that can skip version check
 func getSkipVersionCommands() []string {
-	return []string{"docs", "upgrade", "version"}
+	return []string{"upgrade", "version"}
 }
 
 func versionCheck() {