Skip to content

Replace $ symbol in all english docs files#12901

Closed
DanyC97 wants to merge 1 commit intokubernetes:masterfrom
DanyC97:guideline-kubectl-command
Closed

Replace $ symbol in all english docs files#12901
DanyC97 wants to merge 1 commit intokubernetes:masterfrom
DanyC97:guideline-kubectl-command

Conversation

@DanyC97
Copy link
Copy Markdown
Contributor

@DanyC97 DanyC97 commented Feb 28, 2019

Tidy up and align all the docs to same guideline

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 28, 2019
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Feb 28, 2019

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: steveperry-53

If they are not already assigned, you can assign the PR to them by writing /assign @steveperry-53 in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Feb 28, 2019
@DanyC97 DanyC97 force-pushed the guideline-kubectl-command branch from 9875931 to dd56387 Compare February 28, 2019 16:07
@k8s-ci-robot k8s-ci-robot requested review from aanm and balopat February 28, 2019 16:07
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 28, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 9875931

https://deploy-preview-12901--kubernetes-io-master-staging.netlify.com

@netlify
Copy link
Copy Markdown

netlify bot commented Feb 28, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit dd56387

https://deploy-preview-12901--kubernetes-io-master-staging.netlify.com

neolit123
neolit123 approved these changes Feb 28, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

thank you @DanyC97
i double checked the change and this seems good.

/lgtm
/assign @tengqm @jimangel

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 28, 2019
@DanyC97
Copy link
Copy Markdown
Contributor Author

DanyC97 commented Feb 28, 2019

/assign @zparnold

can you please help review it ?

@DanyC97
Copy link
Copy Markdown
Contributor Author

DanyC97 commented Feb 28, 2019

/unassign @zparnold

@DanyC97
Copy link
Copy Markdown
Contributor Author

DanyC97 commented Feb 28, 2019

@neolit123 thank you for being so quick in reviewing it

@jimangel
Copy link
Copy Markdown
Member

jimangel commented Feb 28, 2019

@DanyC97 @neolit123 any background on this change? I have no problem with it, but have always assumed that the "$ " or ">" indicated an actual command vs the command's output.

@neolit123
Copy link
Copy Markdown
Member

neolit123 commented Feb 28, 2019

@jimangel i haven't requested this change, but there are notes about usage of $ in the k/website guide: https://kubernetes.io/docs/contribute/style/style-guide/#code-snippet-formatting

@DanyC97
Copy link
Copy Markdown
Contributor Author

DanyC97 commented Feb 28, 2019

@jimangel the reason for this PR is because i'm trying to get consistency around the docs by following the guidelines.

Today there is a mix around some pages using $ or > or nothing and while is not a major UX benefit it still add values (in my opinion) to feel like the docs were wrote by same team/ people

you agree?

This was referenced Feb 28, 2019
Closed
Merged
@DanyC97
Copy link
Copy Markdown
Contributor Author

DanyC97 commented Mar 1, 2019

closing in favor of #12779

@DanyC97 DanyC97 closed this Mar 1, 2019
@DanyC97 DanyC97 deleted the guideline-kubectl-command branch March 7, 2019 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aanm aanm Awaiting requested review from aanm

@balopat balopat Awaiting requested review from balopat

1 more reviewer

@neolit123 neolit123 neolit123 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@neolit123 neolit123

@jimangel jimangel

@tengqm tengqm

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@DanyC97 @k8s-ci-robot @jimangel @neolit123 @tengqm @zparnold