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

docs: fix typos, grammar, style, etc in differentiation.md #1483

Merged
merged 1 commit into from
Oct 30, 2023

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Oct 30, 2023

Purpose of PR?:

Summary

Fix various typos & grammar, as well as moderately improve style in differentiation.md

Details

  • add a link to SELinux k8s docs

style improvements:

  • capitalize proper nouns consistently
    • DaemonSet, per k8s style guide
    • consistently use capital "AppArmor", capital "SELinux", and capital "Pod Security Context"
      • these were sometimes lower-cased or just inconsistently capitalized
  • consistently use "multi-cloud" (instead of "multicloud" or "multi cloud")
  • consistently have a newline before and after lists, per markdownlint
  • consistently have 1 sentence per line in prose
    • instead of some very long lines
  • remove duplicate post-attack mitigation link
  • use simpler and more direct language, per k8s style guide
    • shortens a few sentences, removes unnecessary phrases, makes it clearer and more concise
  • use present tense where possible, per k8s style guide
    • "it becomes" -> "it is"
  • avoid Latin phrases, per k8s style guide
    • heavily simplify the one sentence that used two Latin phrases almost immediately after each other

grammar fixes:

  • fix tense issues:
    • "capabilities [...] allows it" -> "[...] allow it"
    • "easy way for policy enforcement" -> "easy way to enforce policies" -- missing verb entirely
    • "allowed to executes" -> "allowed to execute"
  • fix various issues with articles and plurality:
    • consistently use "the host" -- there is only one host in context (a process only has one host)
    • consistently use "a process", "a pod", "a rule", etc -- it can be any process and is not a specific process
    • consistently use "LSMs" with no article
    • consistently don't use articles in "Attacker" line (as this is a brief hypothetical)
      • "its binary" -> "a binary" -- binary is necessarily possessed by the attacker
      • "the sensitive contents" -> "sensitive contents" -- we're not referring to a specific set of contents, just any set
  • no comma after "By the time" as the pause is later after the verb

typos:

  • "and changes" -> "any changes"
  • "can multiple" -> "can have multiple"
  • "it flaws" -> "its flaws"

Does this PR introduce a breaking change?

no

If the changes in this PR are manually verified, list down the scenarios covered::

n/a, pure docs change

Additional information for reviewer? :
Mention if this PR is part of any design or a continuation of previous PRs

Checklist:

  • [n/a] Bug fix. Fixes #
  • [n/a] New feature (non-breaking change which adds functionality)
  • [n/a] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • PR Title follows the convention of <type>(<scope>): <subject>
  • [n/a] Commit has unit tests
  • [n/a] Commit has integration tests

- add a link to SELinux k8s docs

- style improvements:
  - capitalize proper nouns consistently
    - DaemonSet, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects)
    - consistently use capital "AppArmor", capital "SELinux", and capital "Pod Security Context"
      - these were sometimes lower-cased or just inconsistently capitalized
  - consistently use "multi-cloud" (instead of "multicloud" or "multi cloud")
  - consistently have a newline before and after lists, per `markdownlint`
  - consistently have 1 sentence per line in prose
    - instead of some very long lines
  - remove duplicate post-attack mitigation link
    - links should also have context and not use "here", per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#links)
  - use simpler and more direct language, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
    - shortens a few sentences, removes unnecessary phrases, makes it clearer and more concise
  - use present tense where possible, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense)
    - "it becomes" -> "it is"
  - avoid Latin phrases, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-latin-phrases)
    - heavily simplify the one sentence that used two Latin phrases almost immediately after each other

- grammar fixes:
  - fix tense issues:
    - "capabilities [...] allows it" -> "[...] allow it"
    - "easy way for policy enforcement" -> "easy way to enforce policies" -- missing verb entirely
    - "allowed to executes" -> "allowed to execute"
  - fix various issues with articles and plurality:
    - consistently use "the host" -- there is only one host in context (a process only has one host)
    - consistently use "a process", "a pod", "a rule", etc -- it can be any process and is not a specific process
    - consistently use "LSMs" with no article
    - consistently don't use articles in "Attacker" line (as this is a brief hypothetical)
      - "its binary" -> "a binary" -- binary is necessarily possesed by the attacker
    - "the sensitive contents" -> "sensitive contents" -- we're not referring to a specific set of contents, just any set
  - no comma after "By the time" as the pause is later after the verb

- typos:
  - "and changes" -> "any changes"
  - "can multiple" -> "can have multiple"
  - "it flaws" -> "its flaws"

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@daemon1024 daemon1024 merged commit 68281d0 into kubearmor:main Oct 30, 2023
10 checks passed
@agilgur5 agilgur5 deleted the docs-differentiation-edits branch October 30, 2023 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants