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.

Sign up for GitHub

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

Jump to bottom

Enhancement/noun verb syntax #300

Merged
merged 17 commits into from
Jul 14, 2020
Merged

Enhancement/noun verb syntax #300

merged 17 commits into from
Jul 14, 2020

Conversation

iwilltry42
Copy link
Member

@iwilltry42 iwilltry42 commented Jul 13, 2020 •
edited
Loading

This is a draft PR to decide on the migration from the current VERB NOUN (e.g. k3d create cluster) syntax to a new NOUN VERB (e.g. k3d cluster create) syntax.
There are some pro's and con's for each of them (pros for the one are usually cons for the other option):

  • VERB NOUN
    • Pro: the syntax that current k3d users are used to and also what we've showcased so far for v3.0.0 (blog posts, meetup recording)
    • Pro: "natural"/"speaking" syntax
    • Pro: closest to what kubectl and kind do (and some other tools in the Kubernetes ecosystem
  • NOUN VERB
    • Pro: cleaner CLI (hierarchy)
    • Pro: makes it easier to add new nouns (i.e. k3d managed objects)
    • Pro: similar to many other cloud-native CLIs (e.g. gcloud, awscli, azure cli, ...)
    • Pro: easier development experience (k3d internal)

👍 for NOUN VERB
👎 for VERB NOUN

@iwilltry42 iwilltry42 added enhancement New feature or request v3 labels Jul 13, 2020
@iwilltry42 iwilltry42 self-assigned this Jul 13, 2020
@crunchtime-ali
Copy link

@iwilltry42 You should clarify in the PR message that voting with thumbs up is voting for the NOUN VERB syntax, voting with thumbs down is for VERB NOUN.

Personally I am for NOUN VERB because when using the computer I start picking a category of nouns before the action (verb). After years of living in the CLI my thought process has adapted to the non-natural way you control a computer.
While it's not a big issue I never quite liked the way kubecli handles it.

@iwilltry42 iwilltry42 added this to the v3.0 - FROM scratch milestone Jul 14, 2020
@iwilltry42 iwilltry42 marked this pull request as ready for review July 14, 2020 13:07
@iwilltry42
Copy link
Member Author

Voting
NOUN VERB: 13
VERB NOUN: 6
-> Accepted the changes of this PR

@iwilltry42 iwilltry42 merged commit 26cd8bb into master Jul 14, 2020
@iwilltry42 iwilltry42 deleted the enhancement/noun-verb-syntax branch July 14, 2020 13:48
rancherio-gh-m pushed a commit that referenced this pull request Jul 14, 2020
@iwilltry42
commit 26cd8bb
dd842fc 
Merge: d7199d7 c83ac0a
Author: Thorsten Klein <[email protected]>
Date:   Tue Jul 14 15:48:36 2020 +0200

    Merge pull request #300 from rancher/enhancement/noun-verb-syntax

    [Enhancement] NEW noun verb syntax
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@iwilltry42 iwilltry42

Labels
enhancement New feature or request
Projects
None yet
Milestone
v3.0 - FROM scratch
Development

Successfully merging this pull request may close these issues.
2 participants
@iwilltry42 @crunchtime-ali