Skip to content
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.

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

annotate required flags in docs #198

Merged
merged 1 commit into from
Oct 1, 2021
Merged

annotate required flags in docs #198

merged 1 commit into from
Oct 1, 2021

Conversation

lovromazgon
Copy link
Member

@lovromazgon lovromazgon commented Oct 1, 2021

Description of change

Inspired by @hariso comment I created this PR, which adds the string "(required)" to the docs of all required flags. It also removes the suffix "(default 10s)" from the timeout flag, since that's automatically added by cobra.

I did not update the docs yet as I want to first make sure we actually want to do this.
Documentation is changed: https://github.com/meroxa/meroxa-docs/pull/45

Type of change

  • New feature
  • Bug fix
  • Refactor
  • Documentation

How was this tested?

  • Unit Tests
  • Tested in staging

Demo

Before this pull-request

$ meroxa connector create --help
Use `connectors create` to create a connector from a source (--from) or to a destination (--to) within a pipeline (--pipeline)

Usage:
  meroxa connectors create [NAME] [flags]

Examples:

meroxa connectors create [NAME] --from pg2kafka --input accounts --pipeline my-pipeline
meroxa connectors create [NAME] --to pg2redshift --input orders --pipeline my-pipeline # --input will be the desired stream
meroxa connectors create [NAME] --to pg2redshift --input orders --pipeline my-pipeline


Flags:
      --from string       resource name to use as source
  -h, --help              help for create
      --input string      command delimited list of input streams
      --pipeline string   pipeline name to attach connector to
      --to string         resource name to use as destination

Global Flags:
      --config string      config file
      --debug              display any debugging information
      --json               output json
      --timeout duration   set the duration of the client timeout in seconds (default 10s) (default 10s)

After this pull-request

$ meroxa connectors create --help
Use `connectors create` to create a connector from a source (--from) or to a destination (--to) within a pipeline (--pipeline)

Usage:
  meroxa connectors create [NAME] [flags]

Examples:

meroxa connectors create [NAME] --from pg2kafka --input accounts --pipeline my-pipeline
meroxa connectors create [NAME] --to pg2redshift --input orders --pipeline my-pipeline # --input will be the desired stream
meroxa connectors create [NAME] --to pg2redshift --input orders --pipeline my-pipeline


Flags:
  -c, --config string     connector configuration
      --from string       resource name to use as source
  -h, --help              help for create
      --input string      command delimited list of input streams
      --pipeline string   pipeline name to attach connector to (required)
      --to string         resource name to use as destination

Global Flags:
      --cli-config-file string   meroxa configuration file
      --debug                    display any debugging information
      --json                     output json
      --timeout duration         set the duration of the client timeout in seconds (default 10s)

Copy link
Member

@raulb raulb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one 👌

@raulb raulb merged commit 40d95a7 into master Oct 1, 2021
@raulb raulb deleted the lovro/show-required-flags branch October 1, 2021 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants