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

doc: Indicate possible states when updating a pipeline or a connector #199

Merged
merged 1 commit into from
Oct 4, 2021

Conversation

raulb
Copy link
Member

@raulb raulb commented Oct 4, 2021

Description of change

Working on https://meroxa.zendesk.com/agent/tickets/121 I realized we don't indicate well the different possible states when updating a pipeline. For connectors update we showed them as part of usage although it also included [FLAGS] right after it so it wasn't entirely right. This pull-request makes that a bit clearer.

Type of change

  • New feature
  • Bug fix
  • Refactor
  • Documentation

Demo

Before this pull-request

Usage:
  meroxa pipelines update NAME [flags]

Examples:

meroxa pipeline update old-name --name new-name
meroxa pipeline update pipeline-name --state pause
meroxa pipeline update pipeline-name --metadata '{"key":"value"}'

Flags:
...
      --state string      new pipeline state

After this pull-request

Usage:
  meroxa pipelines update NAME [flags]

Examples:

meroxa pipeline update old-name --name new-name
meroxa pipeline update pipeline-name --state pause
meroxa pipeline update pipeline-name --metadata '{"key":"value"}'
meroxa pipeline update pipeline-name --state restart

Flags:
...
      --state string      new pipeline state (pause | resume | restart)

Additional references

I wonder if those states comma separated would make more sense.

Documentation updated

https://github.com/meroxa/meroxa-docs/pull/46

@raulb raulb self-assigned this Oct 4, 2021
Copy link
Member

@lovromazgon lovromazgon left a comment

Choose a reason for hiding this comment

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

LGTM

@raulb raulb merged commit 2e32f0e into master Oct 4, 2021
@raulb raulb deleted the update-docs-pipeline-update branch October 4, 2021 13:59
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.

2 participants