Skip to content

Commit

Permalink
DOCS-32803 CLI command reference Docs: Provide links from confluent f…
Browse files Browse the repository at this point in the history
…link shell to the Quick Start examples (#3031)

Signed-off-by: Victoria Bialas <vicky@confluent.io>
  • Loading branch information
londoncalling authored Feb 28, 2025
1 parent 1941443 commit 9310223
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
6 changes: 6 additions & 0 deletions internal/flink/command_shell.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
pcmd "github.com/confluentinc/cli/v4/pkg/cmd"
"github.com/confluentinc/cli/v4/pkg/config"
"github.com/confluentinc/cli/v4/pkg/errors"
"github.com/confluentinc/cli/v4/pkg/examples"
"github.com/confluentinc/cli/v4/pkg/featureflags"
client "github.com/confluentinc/cli/v4/pkg/flink/app"
"github.com/confluentinc/cli/v4/pkg/flink/types"
Expand All @@ -24,6 +25,11 @@ func (c *command) newShellCommand(prerunner pcmd.PreRunner) *cobra.Command {
Use: "shell",
Short: "Start Flink interactive SQL client.",
Annotations: map[string]string{pcmd.RunRequirement: pcmd.RequireNonAPIKeyCloudLogin},
Example: examples.BuildExampleString(
examples.Example{
Text: "For a Quick Start with examples in context, see https://docs.confluent.io/cloud/current/flink/get-started/quick-start-shell.html.",
},
),
RunE: func(cmd *cobra.Command, args []string) error {
return c.startFlinkSqlClient(prerunner, cmd)
},
Expand Down
3 changes: 3 additions & 0 deletions test/fixtures/output/flink/shell-help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Start Flink interactive SQL client.
Usage:
confluent flink shell [flags]

Examples:
For a Quick Start with examples in context, see https://docs.confluent.io/cloud/current/flink/get-started/quick-start-shell.html.

Flags:
--compute-pool string Flink compute pool ID.
--service-account string Service account ID.
Expand Down

0 comments on commit 9310223

Please sign in to comment.