feat: add new commands for completion and migration in pipectl#6751
feat: add new commands for completion and migration in pipectl#6751vedantlavale wants to merge 5 commits into
Conversation
Signed-off-by: vedantlavale <vedantlavale@gmail.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the pipectl CLI user guide docs to reflect current commands, removing references to the deprecated init workflow and documenting newer migrate and plugin functionality.
Changes:
- Updates “Available Commands” to remove
initand addcompletion,migrate, andplugin - Replaces the removed
pipectl initdocumentation withpipectl migratedocumentation (application-config + database) - Adds documentation for
pipectl plugin push
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/content/en/docs-v1.0.x/user-guide/command-line-tool.md | Updates the documented CLI help output to match current commands |
| docs/content/en/docs-dev/user-guide/command-line-tool.md | Updates command list and replaces init docs with migrate and plugin push documentation |
|
@khanhtc1202 , @rahulshendre , @Ayushmore1214 hey, could someone take a look at this when free? |
|
Hey @vedantlavale, sorry for the delay, we missed this earlier. Please have a look at this comment - here. Let's discuss more of the changes needed in the docs with the maintainers in the next community meeting before proceeding further. Since @A-d-i-t-y is also working in a similar area, it would be great if you both could coordinate on the related changes. |
Summary
Updates the pipectl CLI documentation in
docs-devanddocs-v1.0.xto match the current source code.Changes
pipectl initfrom the "Available Commands" help output (command was removed in Remove pipectl init command #5958)completion,migrate, andpluginto the "Available Commands" help outputpipectl initcommandpipectl migrate application-configpipectl migrate databasepipectl plugin pushWhy we need it
pipectl initwas removed from the codebase but is still documented as an available command. Users following the official documentation currently hit a dead end.At the same time,
pipectl migrate(the replacement workflow) andpipectl plugin pushalready exist in the source code but are undocumented, making them difficult for users and plugin authors to discover.Which issue(s) this PR fixes
Closes: #6750
Does this PR introduce a user-facing change?
How are users affected by this change
CLI documentation now accurately reflects the currently available commands. Users can discover and use
pipectl migrateandpipectl plugin pushthrough the official docs.Is this a breaking change?
No
How to migrate (if breaking change)
N/A