From 424fb2cf57daf845e4ec8447875a442a9d3fcae1 Mon Sep 17 00:00:00 2001 From: umarcor Date: Wed, 30 Jun 2021 18:51:39 +0200 Subject: [PATCH] site: move user_guide --- README.md | 4 ++-- user_guide.md => site/content/user_guide.md | 13 ++++++++----- 2 files changed, 10 insertions(+), 7 deletions(-) rename user_guide.md => site/content/user_guide.md (97%) diff --git a/README.md b/README.md index 9f4ff87c8..83daf10ca 100644 --- a/README.md +++ b/README.md @@ -104,8 +104,8 @@ go install github.com/spf13/cobra-cli@latest For complete details on using the Cobra-CLI generator, please read [The Cobra Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md) -For complete details on using the Cobra library, please read the [The Cobra User Guide](user_guide.md). +For complete details on using the Cobra library, please read the [The Cobra User Guide](site/content/user_guide.md). # License -Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt) +Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt) diff --git a/user_guide.md b/site/content/user_guide.md similarity index 97% rename from user_guide.md rename to site/content/user_guide.md index 4a3c2b0da..c7957a169 100644 --- a/user_guide.md +++ b/site/content/user_guide.md @@ -29,10 +29,10 @@ func main() { ## Using the Cobra Generator -Cobra-CLI is its own program that will create your application and add any -commands you want. It's the easiest way to incorporate Cobra into your application. +Cobra-CLI is its own program that will create your application and add any commands you want. +It's the easiest way to incorporate Cobra into your application. -For complete details on using the Cobra generator, please refer to [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md) +For complete details on using the Cobra generator, please read [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md). ## Using the Cobra Library @@ -631,8 +631,11 @@ Run 'kubectl help' for usage. ## Generating documentation for your command -Cobra can generate documentation based on subcommands, flags, etc. Read more about it in the [docs generation documentation](doc/README.md). +Cobra can generate documentation based on subcommands, flags, etc. +Read more about it in the [docs generation documentation](docgen/_index.md). ## Generating shell completions -Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell. If you add more information to your commands, these completions can be amazingly powerful and flexible. Read more about it in [Shell Completions](shell_completions.md). +Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell. +If you add more information to your commands, these completions can be amazingly powerful and flexible. +Read more about it in [Shell Completions](completions/_index.md).