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

avoid 'should' in documentation #4162

Merged
merged 2 commits into from
Sep 9, 2021
Merged

avoid 'should' in documentation #4162

merged 2 commits into from
Sep 9, 2021

Conversation

sankalp-r
Copy link
Contributor

Fixes #4079

@netlify
Copy link

netlify bot commented Aug 26, 2021

✔️ Deploy Preview for knative ready!

🔨 Explore the source changes: 36ffccd

🔍 Inspect the deploy log: https://app.netlify.com/sites/knative/deploys/613631352d37a9000805a773

😎 Browse the preview: https://deploy-preview-4162--knative.netlify.app

@google-cla
Copy link

google-cla bot commented Aug 26, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no Indicates the PR's author has not signed the CLA. label Aug 26, 2021
@knative-prow-robot knative-prow-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 26, 2021
@knative-prow-robot
Copy link
Contributor

Welcome @sankalp-r! It looks like this is your first PR to knative/docs 🎉

@knative-prow-robot
Copy link
Contributor

Hi @sankalp-r. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@sankalp-r
Copy link
Contributor Author

@googlebot I signed it!

@google-cla google-cla bot added cla: yes Indicates the PR's author has signed the CLA. and removed cla: no Indicates the PR's author has not signed the CLA. labels Aug 26, 2021
@abrennan89
Copy link
Contributor

@sankalp-r @RichardJJG @snneji there's no correct term listed for this, should we provide something here? Maybe either "can" or "must" if an action is required?

@abrennan89
Copy link
Contributor

/ok-to-test

@knative-prow-robot knative-prow-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 27, 2021
@snneji
Copy link
Contributor

snneji commented Aug 27, 2021

@sankalp-r @RichardJJG @snneji there's no correct term listed for this, should we provide something here? Maybe either "can" or "must" if an action is required?

Both would work - "must" if an action is required or "can" if an action is optional.

Also, since the list is in alphabetical order, the item would need to move from being on the last row.

@RichardJJG
Copy link
Contributor

@sankalp-r @RichardJJG @snneji there's no correct term listed for this, should we provide something here? Maybe either "can" or "must" if an action is required?

I would leave the "Correct" cell empty (n/a) and explain in the "Notes" cell that, as far as possible, the sentence should be re-written to not use "should" or any synonym of "should".

@sankalp-r
Copy link
Contributor Author

@sankalp-r @RichardJJG @snneji there's no correct term listed for this, should we provide something here? Maybe either "can" or "must" if an action is required?

I agree with @RichardJJG .
As "Correct" cell is empty, keeping this at last row seems fine to me.

@abrennan89
Copy link
Contributor

abrennan89 commented Aug 31, 2021

There seem to be some tests failing on this PR. It looks like it might be a Git setup issue?

 Committer identity unknown

*** Please tell me who you are.

Run

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

fatal: empty ident name (for <runner@fv-az252-375.0oqgmj5p5touvf5anqlk4y4b0b.jx.internal.cloudapp.net>) not allowed
Error: Process completed with exit code 128.

https://github.com/knative/docs/pull/4162/checks?check_run_id=3476356521

There's also a more minor whitespace error: https://github.com/knative/docs/pull/4162/checks?check_run_id=3476356522

@knative-prow-robot knative-prow-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 31, 2021
@sankalp-r
Copy link
Contributor Author

There seem to be some tests failing on this PR. It looks like it might be a Git setup issue?

 Committer identity unknown

*** Please tell me who you are.

Run

  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

fatal: empty ident name (for <runner@fv-az252-375.0oqgmj5p5touvf5anqlk4y4b0b.jx.internal.cloudapp.net>) not allowed
Error: Process completed with exit code 128.

https://github.com/knative/docs/pull/4162/checks?check_run_id=3476356521

There's also a more minor whitespace error: https://github.com/knative/docs/pull/4162/checks?check_run_id=3476356522

Fixed the above mentioned issues.

Copy link
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

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

/lgtm

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Sep 9, 2021
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, sankalp-r

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

The pull request process is described here

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

@knative-prow-robot knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2021
@knative-prow-robot knative-prow-robot merged commit 375e925 into knative:mkdocs Sep 9, 2021
@sankalp-r sankalp-r deleted the style-guide-fix branch September 26, 2021 04:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Style Guide: add to word list avoiding "should"
5 participants