knative-extensions / knative-extensions/kn-plugin-source-kamelet

Structure and extend help message

Open
#52 2 comments 0 reactions 0 assignees View on GitHub
documentation triage/accepted
Dominant language
Go
Stars
2
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Move some not so important message into an own section, like for kn:

```
kn is the command line interface for managing Knative Serving and Eventing resources

Find more information about Knative at: https://knative.dev

Serving Commands:
service Manage Knative services
revision Manage service revisions
route List and describe service routes
domain Manage domain mappings
container Manage service's containers (experimental)

Eventing Commands:
source Manage event sources
broker Manage message brokers
trigger Manage event triggers
channel Manage event channels
subscription Manage event subscriptions

Other Commands:
plugin Manage kn plugins
completion Output shell completion code
version Show the version of this client

Use "kn --help" for more information about a given command.
Use "kn options" for a list of global command-line options (applies to all commands).
```

Currently, the help message looks a bit unstructured.

Also, adding examples would be very helpful as the help message will probably be the only documentation for the plugin for some time.

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by locating the Go CLI entry point that defines the help message and compare its output with the structure shown in the issue. Done means the commands are grouped into sections and useful command examples are included in the help output.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.