Skip to content

Commit 24d97f7

Browse files
committed
site: move user_guide
1 parent 4e2bdba commit 24d97f7

2 files changed

Lines changed: 21 additions & 18 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@ name a few. [This list](site/content/projects_using_cobra.md) contains a more ex
2020
* [Flags](#flags)
2121
- [Installing](#installing)
2222
- [Usage](#usage)
23-
* [Using the Cobra Generator](user_guide.md#using-the-cobra-generator)
24-
* [Using the Cobra Library](user_guide.md#using-the-cobra-library)
25-
* [Working with Flags](user_guide.md#working-with-flags)
26-
* [Positional and Custom Arguments](user_guide.md#positional-and-custom-arguments)
27-
* [Example](user_guide.md#example)
28-
* [Help Command](user_guide.md#help-command)
29-
* [Usage Message](user_guide.md#usage-message)
30-
* [PreRun and PostRun Hooks](user_guide.md#prerun-and-postrun-hooks)
31-
* [Suggestions when "unknown command" happens](user_guide.md#suggestions-when-unknown-command-happens)
32-
* [Generating documentation for your command](user_guide.md#generating-documentation-for-your-command)
33-
* [Generating shell completions](user_guide.md#generating-shell-completions)
23+
* [Using the Cobra Generator](site/content/user_guide.md#using-the-cobra-generator)
24+
* [Using the Cobra Library](site/content/user_guide.md#using-the-cobra-library)
25+
* [Working with Flags](site/content/user_guide.md#working-with-flags)
26+
* [Positional and Custom Arguments](site/content/user_guide.md#positional-and-custom-arguments)
27+
* [Example](site/content/user_guide.md#example)
28+
* [Help Command](site/content/user_guide.md#help-command)
29+
* [Usage Message](site/content/user_guide.md#usage-message)
30+
* [PreRun and PostRun Hooks](site/content/user_guide.md#prerun-and-postrun-hooks)
31+
* [Suggestions when "unknown command" happens](site/content/user_guide.md#suggestions-when-unknown-command-happens)
32+
* [Generating documentation for your command](site/content/user_guide.md#generating-documentation-for-your-command)
33+
* [Generating shell completions](site/content/user_guide.md#generating-shell-completions)
3434
- [Contributing](CONTRIBUTING.md)
3535
- [License](#license)
3636

@@ -119,8 +119,8 @@ import "github.com/spf13/cobra"
119119

120120
# Usage
121121

122-
See [User Guide](user_guide.md).
122+
See [User Guide](site/content/user_guide.md).
123123

124124
# License
125125

126-
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
126+
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)

user_guide.md renamed to site/content/user_guide.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ func main() {
2929

3030
## Using the Cobra Generator
3131

32-
Cobra provides its own program that will create your application and add any
33-
commands you want. It's the easiest way to incorporate Cobra into your application.
32+
Cobra provides its own program that will create your application and add any commands you want.
33+
It's the easiest way to incorporate Cobra into your application.
3434

35-
[Here](https://github.com/spf13/cobra/blob/master/cobra/README.md) you can find more information about it.
35+
[Here](CLI.md) you can find more information about it.
3636

3737
## Using the Cobra Library
3838

@@ -631,8 +631,11 @@ Run 'kubectl help' for usage.
631631

632632
## Generating documentation for your command
633633

634-
Cobra can generate documentation based on subcommands, flags, etc. Read more about it in the [docs generation documentation](doc/README.md).
634+
Cobra can generate documentation based on subcommands, flags, etc.
635+
Read more about it in the [docs generation documentation](docgen/_index.md).
635636

636637
## Generating shell completions
637638

638-
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).
639+
Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell.
640+
If you add more information to your commands, these completions can be amazingly powerful and flexible.
641+
Read more about it in [Shell Completions](completions/_index.md).

0 commit comments

Comments
 (0)