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

Copyedit (grammar, spelling, etc.) for clarity #568

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

quaid
Copy link

@quaid quaid commented Jul 25, 2022

  • Small grammar, spelling, and punctuation fixes
  • A few language shifts or additions to further clarity.
  • Refactored to have one-line per sentence for easier reading/reviewing of diffs.

Related Issues and Dependencies

N/A

This introduces a breaking change

  • Yes
  • No

This Pull Request implements

Small grammar, spelling, and language choice fixes as part of a copyedit.

Description

  • Small grammar, spelling, and punctuation fixes
  • A few language shifts or additions to further clarity.
  • Refactored to have one-line per sentence for easier reading/reviewing of diffs.

- Small grammar, spelling, and punctuation fixes
- A few language shifts or additions to further clarity.
- Refactored to have one-line per sentence for easier reading/reviewing of diffs.
@sesheta
Copy link
Contributor

sesheta commented Jul 25, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign durandom after the PR has been reviewed.
You can assign the PR to them by writing /assign @durandom in a comment when ready.

The full list of commands accepted by this bot can be found 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

@sesheta sesheta added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 25, 2022
@sesheta
Copy link
Contributor

sesheta commented Jul 25, 2022

Hi @quaid. Thanks for your PR.

I'm waiting for a aicoe-aiops 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.

@sesheta sesheta added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 25, 2022
@oindrillac
Copy link
Member

/ok-to-test

@sesheta sesheta added ok-to-test and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 25, 2022
Although you may see it spelled with and without spaces, looking at the ODH website it's pretty clear the proper way is "Open Data Hub".

This is important whenever it's a proper name, and more important if it's someone's trademarks. Also, consistency and accuracy help create reader comfort.
Copy link
Member

@oindrillac oindrillac left a comment

Choose a reason for hiding this comment

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

Thanks your PR @quaid! 😄
Suggested couple some other minor grammatical changes that I noticed.


You do not need to be familiar with these any of tools being used in this workshop, and you should have around an intermediate level of comfort with technology and learning new technical concepts.
You do not need to be familiar with the any of tools being used in this workshop, and you should have around an intermediate level of comfort with technology and learning new technical concepts.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You do not need to be familiar with the any of tools being used in this workshop, and you should have around an intermediate level of comfort with technology and learning new technical concepts.
You do not need to be familiar with any of the tools being used in this workshop, and you should have around an intermediate level of comfort with technology and learning new technical concepts.


3. **Familiarity with Python** - The AIOps tools has been built using the Python programming language. Familiarity with Python is preferred but not compulsory. One can still complete the workshop without prior Python knowledge.
3. **Familiarity with Python** - The AIOps tools has been built using the Python programming language.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
3. **Familiarity with Python** - The AIOps tools has been built using the Python programming language.
3. **Familiarity with Python** - The AIOps tools have been built using the Python programming language.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants