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

Add "deploy" abbrev for deployments to kubectl #24087

Merged
merged 1 commit into from
Jul 12, 2016
Merged

Add "deploy" abbrev for deployments to kubectl #24087

merged 1 commit into from
Jul 12, 2016

Conversation

Frostman
Copy link
Contributor

@Frostman Frostman commented Apr 10, 2016 •
edited by mikedanese
Loading

Most of the objects have the abbreviation (short form) in kubectl, for ex. rc == replicationcontroller. It'll be useful to have an abbrev for "deployments" as well and I'm proposing to use "dpl" for it.

P.S. It's my very first commit to k8s. I've signed CLA already. I've decided to create this pull request while waiting on more info in #24083.

This change is Reviewable

@k8s-bot
Copy link

k8s-bot commented Apr 10, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in hack/jenkins/job-configs/kubernetes-jenkins-pull/ instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-bot
Copy link

k8s-bot commented Apr 10, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in hack/jenkins/job-configs/kubernetes-jenkins-pull/ instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

1 similar comment
@k8s-bot
Copy link

k8s-bot commented Apr 10, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in hack/jenkins/job-configs/kubernetes-jenkins-pull/ instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-github-robot k8s-github-robot added kind/old-docs size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 10, 2016
@smarterclayton
Copy link
Contributor

I'm wondering whether I would ever "guess" dpl. Would "deploy" be more
understandable as an abbreviation?

On Sun, Apr 10, 2016 at 4:41 PM, k8s-merge-robot [email protected]
wrote:

Labelling this PR as size/XS

—
You are receiving this because you were assigned.
Reply to this email directly or view it on GitHub
#24087 (comment)

@Frostman
Copy link
Contributor Author

@smarterclayton hey, it's more about my associations :) I would really appreciate feedback on it and other options while it's anyway nice to have change.

"deployment" -> "deploy" seems to be not really abbr comparing what already in place:

  • services -> svc
  • replicationcontroller -> rc

I've used "dpl" because of I've seen such abbr for deployment in different places:

@smarterclayton
Copy link
Contributor

The "short" names are intended to reduce the length of the name for typing

  • I don't think the goal is to pack them in minimal characters, but to
    provide a convenient short cut. Like any naming problem, it's pretty hard
    to come up with rules that work for everyone. My rules of thumb here are:
  1. the abbreviation has to be unambiguous
  2. the abbreviation should be consistent with other abbreviations of its
    type
  3. the abbreviation should be reasonably unlikely to ever collide with
    another type
  4. an average user, upon seeing the abbreviation the first time, should not
    have to ask what the abbreviation is
  5. we should only create abbreviations if they are truly necessary (the
    shorter the word is, the less likely it should have an abbreviation) -
    "pods" should not have an abbreviation, "secrets" should not have an
    abbreviation.
  6. since shortcuts are an API (have to be backwards compatible for a long
    time), we usually should invest a decent amount of time on naming.

I'd be more inclined to "dp" than "dpl". "dep" is not appropriate (could
be confused with dependency). "d" is probably too short, but we could
consider it.

On Wed, Apr 13, 2016 at 6:55 AM, Sergey Lukjanov [email protected]
wrote:

@smarterclayton https://github.com/smarterclayton hey, it's more about
my associations :) I would really appreciate feedback on it and other
options while it's anyway nice to have change.

"deployment" -> "deploy" seems to be not really abbr comparing what
already in place:

  • services -> svc
  • replicationcontroller -> rc

I've used "dpl" because of I've seen such abbr for deployment in different
places:

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#24087 (comment)

@bgrant0607
Copy link
Member

cc @janetkuo

@bgrant0607
Copy link
Member

I would never guess "dpl".

@bgrant0607
Copy link
Member

Official abbreviations used by the military are "dep" and "deploy".

@smarterclayton
Copy link
Contributor

I like deploy (the same way I like config for configmap). It also happens
to work well with tab complete.

On Apr 19, 2016, at 12:05 AM, Brian Grant [email protected] wrote:

Official abbreviations used by the military are "dep" and "deploy".

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#24087 (comment)

@Frostman
Copy link
Contributor Author

I like the "deploy" option, will update patches soon. @bgrant0607 @smarterclayton thx for the feedback.

@Frostman Frostman changed the title Add "dpl" abbrev for deployments to kubectl Add "deploy" abbrev for deployments to kubectl Apr 26, 2016
@k8s-github-robot
Copy link

@smarterclayton
You must link to the test flake issue which caused you to request this manual re-test.
Re-test requests should be in the form of: k8s-bot test this issue: #<number>
Here is the list of open test flakes.

@Frostman
Copy link
Contributor Author

Frostman commented May 8, 2016

@smarterclayton seems like something was wrong in CI, not sure...

@0xmichalis
Copy link
Contributor

cc: @ironcladlou

@smarterclayton
Copy link
Contributor

You need to regenerate the docs, since you changed a CLI command.

@Frostman Frostman force-pushed the kubectl-abbr-dpl branch 2 times, most recently from 3370cfe to 4c65348 Compare May 23, 2016 09:10
@Frostman
Copy link
Contributor Author

@smarterclayton hi, I've pushed an updated commit with re-generated docs

@smarterclayton
Copy link
Contributor

@k8s-bot test this issue #IGNORE (pr builder got lost)

@0xmichalis
Copy link
Contributor

LGTM, let's get this in

@0xmichalis 0xmichalis added lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. labels May 23, 2016
@k8s-github-robot k8s-github-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels May 30, 2016
@smarterclayton
Copy link
Contributor

@k8s-bot test this issue #IGNORE (job hung)

@k8s-github-robot k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 10, 2016
@k8s-github-robot k8s-github-robot removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. kind/old-docs labels Jun 10, 2016
@k8s-bot
Copy link

k8s-bot commented Jun 14, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

3 similar comments
@k8s-bot
Copy link

k8s-bot commented Jun 15, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-bot
Copy link

k8s-bot commented Jun 23, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-bot
Copy link

k8s-bot commented Jun 24, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@janetkuo
Copy link
Member

ok to test

@janetkuo janetkuo added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Jun 24, 2016
@Frostman
Copy link
Contributor Author

Frostman commented Jul 8, 2016

Hi folks,

as 1.3 release, can we land it now? :) @smarterclayton @Kargakis

Thanks.

@0xmichalis 0xmichalis added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2016
@smarterclayton
Copy link
Contributor

@k8s-bot test this issue #28683

@k8s-github-robot k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 8, 2016
@k8s-github-robot k8s-github-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 12, 2016
@k8s-bot
Copy link

k8s-bot commented Jul 12, 2016

GCE e2e build/test passed for commit 3c0f047.

@dims
Copy link
Member

dims commented Jul 12, 2016

@smarterclayton @janetkuo : this looks ready 👍

@0xmichalis 0xmichalis added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 12, 2016
@k8s-github-robot
Copy link

@k8s-bot test this [submit-queue is verifying that this PR is safe to merge]

@k8s-bot
Copy link

k8s-bot commented Jul 12, 2016

GCE e2e build/test passed for commit 3c0f047.

@k8s-github-robot
Copy link

Automatic merge from submit-queue

@k8s-github-robot k8s-github-robot merged commit 4018101 into kubernetes:master Jul 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@smarterclayton smarterclayton

Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@Frostman @k8s-bot @smarterclayton @bgrant0607 @k8s-github-robot @0xmichalis @janetkuo @dims @googlebot