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

[chore] Update README.md #83

Merged
merged 1 commit into from
Jan 4, 2025
Merged

[chore] Update README.md #83

merged 1 commit into from
Jan 4, 2025

Conversation

theBeginner86
Copy link
Member

@theBeginner86 theBeginner86 commented Jan 1, 2025

Notes for Reviewers

Uses the correct name of Helm plugin binary

This PR fixes #

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Pranav Singh <[email protected]>
@theBeginner86
Copy link
Member Author

theBeginner86 commented Jan 1, 2025

Though the current name of plugin is too long.
Please consider confirming if it's to be called snapshot or kanvas-snapshot.

I'll update the readme and binary from next release onwards.

@leecalcote
Copy link
Member

leecalcote commented Jan 1, 2025

If the current CLI syntax is helm kanvas-snapshot, I agree that this is a bit longer than desirable. After some discussion with @aabidsofi19, I'm voting for helm kanvas snapshot, but could be convinced otherwise.

  1. My sense is that my primary argument for having helm kanvas snapshot is that this leaves us open to additional sub commands beyond the single simple snapshot verb.
  2. The other point of justification that I have is that inclusion of the "Kanvas" term helps with project recognition and drives clarity of command intent. I don't have the sense that this second point is particularly strong justification.

helm-s3 is a plugin with an example subcommands like helm s3 init. Using helm kanvas snapshot, to @aabidsofi19's point, leaves our plugin open to possible subcommand additions in the future, like helm kanvas auth...

@leecalcote leecalcote requested a review from aabidsofi19 January 1, 2025 18:02
@leecalcote leecalcote added the area/docs Improvements or additions to documentation label Jan 1, 2025
@theBeginner86 theBeginner86 merged commit 787c171 into master Jan 4, 2025
4 checks passed
@theBeginner86 theBeginner86 deleted the theBeginner86-patch-2 branch January 4, 2025 17:03
@theBeginner86
Copy link
Member Author

If the current CLI syntax is helm kanvas-snapshot, I agree that this is a bit longer than desirable. After some discussion with @aabidsofi19, I'm voting for helm kanvas snapshot, but could be convinced otherwise.

  1. My sense is that my primary argument for having helm kanvas snapshot is that this leaves us open to additional sub commands beyond the single simple snapshot verb.
  2. The other point of justification that I have is that inclusion of the "Kanvas" term helps with project recognition and drives clarity of command intent. I don't have the sense that this second point is particularly strong justification.

helm-s3 is a plugin with an example subcommands like helm s3 init. Using helm kanvas snapshot, to @aabidsofi19's point, leaves our plugin open to possible subcommand additions in the future, like helm kanvas auth...

Noted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants