Skip to content

#2579 RPK updates for changes to RP Connect commands#598

Merged
asimms41 merged 4 commits into
mainfrom
fix-2579_RPK_updates_for_RP_Connect
Jul 26, 2024
Merged

#2579 RPK updates for changes to RP Connect commands#598
asimms41 merged 4 commits into
mainfrom
fix-2579_RPK_updates_for_RP_Connect

Conversation

@asimms41
Copy link
Copy Markdown
Contributor

@asimms41 asimms41 commented Jul 11, 2024

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/2579
Review deadline: 12 July

Page previews

rpk connect
rpk connect echo
rpk connect lint
rpk connect streams

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link
Copy Markdown

netlify Bot commented Jul 11, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 53420e2
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/66a22481a9ba5e000830ed33
😎 Deploy Preview https://deploy-preview-598--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@asimms41 asimms41 requested a review from Jeffail July 11, 2024 09:02
[,bash]
----
rpk connect -c ./root_config.yaml streams`
rpk connect -c ./root_config.yaml streams
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
rpk connect -c ./root_config.yaml streams
rpk connect streams -o ./root_config.yaml

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated.

@asimms41 asimms41 requested a review from Jeffail July 25, 2024 09:47

```bash
rpk connect -c target.yaml lint
rpk connect lint -c target.yaml
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
rpk connect lint -c target.yaml
rpk connect lint target.yaml

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated.

|===
|*Value* |*Type* |*Description*

|--config, -c |- | Path to a configuration file.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This flag is removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated.

@asimms41 asimms41 requested a review from Jeffail July 25, 2024 10:11
@asimms41 asimms41 marked this pull request as ready for review July 26, 2024 09:18
@asimms41 asimms41 requested a review from a team as a code owner July 26, 2024 09:18
Copy link
Copy Markdown
Contributor

@JakeSCahill JakeSCahill left a comment

Choose a reason for hiding this comment

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

These docs are autogenerated. Have these changes been made in the rpk source code?

@asimms41
Copy link
Copy Markdown
Contributor Author

asimms41 commented Jul 26, 2024

These docs are autogenerated. Have these changes been made in the rpk source code?

@JakeSCahill JakeSCahill self-requested a review July 26, 2024 10:03
@asimms41 asimms41 merged commit 12df4ee into main Jul 26, 2024
Feediver1 added a commit that referenced this pull request May 22, 2026
mfernest is no longer at the company; @Feediver1 (Joyce) is taking over
to land this PR. Two outstanding items from the prior review pass:

1. Add --resources, -r to rpk-connect-streams.adoc flag table. Ben
   Barkhouse's original Slack report (cited in DOC-1970) called out
   this missing flag specifically. Sibling pages rpk-connect-lint.adoc
   and rpk-connect-run.adoc both already document --resources, -r;
   the flag is supported on streams mode too. Inserted in alphabetical
   order between --prefix-stream-endpoints and --help, -h, with the
   imperative-voice wording that matches the rest of the streams flag
   table. This closes Ben's first reported gap (the -o flag, his
   second concern, was already fixed in PR #598).

2. Restore the word 'first' to the rpk-connect-agent-run.adoc
   description, per @kbatuigas's suggestion in the original review.
   The 'first ... then' pair makes the sequence (read resource
   definitions, then run the agent) explicit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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