Skip to content

Help guides link #2857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiborvass merged 4 commits into from
Dec 7, 2020
Merged

Help guides link #2857

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbd65f9
Display additional help message pointing to docs.docker.com guides.
gtardif Dec 1, 2020
2369d9d
Do not display help link if env var “DOCKER_HIDE_HELP_GUIDES” is set
gtardif Dec 1, 2020
0ec9e43
Additional help message is displayed in cyan
gtardif Dec 1, 2020
d7697f9
AdditionalHelpMessage set in command annotations, removed env var check
gtardif Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion cli/cobra.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ func setupCommonRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *p
cobra.AddTemplateFunc("invalidPluginReason", invalidPluginReason)
cobra.AddTemplateFunc("isPlugin", isPlugin)
cobra.AddTemplateFunc("isExperimental", isExperimental)
cobra.AddTemplateFunc("hasAdditionalHelp", hasAdditionalHelp)
cobra.AddTemplateFunc("additionalHelp", additionalHelp)
cobra.AddTemplateFunc("decoratedName", decoratedName)

rootCmd.SetUsageTemplate(usageTemplate)
Expand All @@ -47,6 +49,8 @@ func setupCommonRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *p
rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help")
rootCmd.PersistentFlags().Lookup("help").Hidden = true

rootCmd.Annotations = map[string]string{"additionalHelp": brightCyan("To get more help with docker, check out guides at https://docs.docker.com/go/guides/")}

return opts, flags, helpCommand
}

Expand Down Expand Up @@ -185,7 +189,6 @@ var helpCommand = &cobra.Command{
if cmd == nil || e != nil || len(args) > 0 {
return errors.Errorf("unknown help topic: %v", strings.Join(args, " "))
}

helpFunc := cmd.HelpFunc()
helpFunc(cmd, args)
return nil
Expand All @@ -205,6 +208,27 @@ func isExperimental(cmd *cobra.Command) bool {
return experimental
}

func additionalHelp(cmd *cobra.Command) string {
if additionalHelp, ok := cmd.Annotations["additionalHelp"]; ok {
return additionalHelp
}
return ""
}

func hasAdditionalHelp(cmd *cobra.Command) bool {
return additionalHelp(cmd) != ""
}

var brightCyan = color("\033[1;96m%s\033[0m")

func color(colorString string) func(...interface{}) string {
sprint := func(args ...interface{}) string {
return fmt.Sprintf(colorString,
fmt.Sprint(args...))
}
return sprint
}

func isPlugin(cmd *cobra.Command) bool {
return cmd.Annotations[pluginmanager.CommandAnnotationPlugin] == "true"
}
Expand Down Expand Up @@ -360,6 +384,9 @@ Invalid Plugins:

Run '{{.CommandPath}} COMMAND --help' for more information on a command.
{{- end}}
{{- if hasAdditionalHelp .}}
{{ additionalHelp . }}
{{- end}}
`

var helpTemplate = `
Expand Down