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

GH#1102: Fix spelling errors #1103

Closed
wants to merge 45 commits into from
Closed

GH#1102: Fix spelling errors #1103

wants to merge 45 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Nov 16, 2023

Product Version(s):
Calico (3.24, 3.24.2, 3.25, 3.26), Calico Enterprise (3.15, 3.16, 3.17, 3.18), and Calico Cloud (3.14.0, 3.16.0, 3.16.1, 3.17)

Issue:
#1102

Link to docs preview:

SME review:

  • An SME has approved this change.

DOCS review:

  • A member of the docs team has approved this change.

Additional information:

A couple of recently merged commits fixed spelling items that I ran across but didn't maintain table alignment. I personally don't care about alignment, but I had attempted to retain proper alignment and have thus retained the alignment corrections in this PR -- I've tagged those changes with distinct commit messages of whitespace: -- I'm more than happy to drop them.

Merge checklist:

  • Deploy preview inspected wherever changes were made
  • Build completed successfully
  • Test have passed

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref jsoref requested a review from a team as a code owner November 16, 2023 07:19
@jsoref
Copy link
Contributor Author

jsoref commented Nov 16, 2023

@tigera/docs

Copy link

netlify bot commented Nov 16, 2023

Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit 75895d3
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/655639a7b6cc7b0008a4fd92
😎 Deploy Preview https://deploy-preview-1103--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 72 (🟢 up 15 from production)
Accessibility: 93 (no change from production)
Best Practices: 92 (no change from production)
SEO: 79 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 16, 2023

👷 Deploy Preview succeeded!

Name Link
🔨 Latest commit 75895d3
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/655639a7ff65d4000846d76d

@@ -19,7 +19,7 @@
- In BPF dataplane mode, Felix now handles single-block IPAM pools. Previously single-block pools resulted in a collision when programming the dataplane routes. [felix #2245](https://github.com/projectcalico/felix/pull/2245) (@fasaxc)
- None required [felix #2233](https://github.com/projectcalico/felix/pull/2233) (@tomastigera)
- None required [felix #2232](https://github.com/projectcalico/felix/pull/2232) (@tomastigera)
- [Openstack] Allow DHCP from the workload, on kernels where rp_filter doesn't already [felix #2231](https://github.com/projectcalico/felix/pull/2231) (@neiljerram)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This correction is based on the author of projectcalico/felix#2231 -- both this incorrect spelling and the correct spelling appeared in the output I was reviewing, and a quick spot check determined this was the incorrect spelling.

- Fix kube-controllers attempting to clean up non-existent node resources [kube-controllers #461](https://github.com/projectcalico/kube-controllers/pull/461) (@fcuello-fudo)
- Fix kube-controllers attempting to clean up nonexistent node resources [kube-controllers #461](https://github.com/projectcalico/kube-controllers/pull/461) (@fcuello-fudo)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm more than happy to drop such changes, they're just among the defaults I use (this is all manual -- I used to feed things to a Google Sheets document, but haven't for the past couple of weeks...).

| 5 | intrusion-detection | TRUE | FALSE | FALSE | 9m49s |
| 5 | intrusion-detection | TRUE | FALSE | FALSE | 9m49s |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

here's an example of a whitespace correction -- note that I'm well aware that the whitespace isn't relevant, but overall this repository seems to take great care to properly align content (there were a very small handful of cases I ran into from when I initially started that weren't in sync, but with the couple of commits between when I started and when I synced, there were suddenly quite a few).

**MacOS**
**macOS**
Copy link
Contributor Author

Choose a reason for hiding this comment

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

brand

You can include the CLI scanner in your CI/CD pipelines (for example, Jenkins, Github actions). Ensure the following:
You can include the CLI scanner in your CI/CD pipelines (for example, Jenkins, GitHub actions). Ensure the following:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

grammatically, this should really include a or, but...

Because global network policies use **kind: GlobalNetworkPolicy**, they are grouped seperately from **kind: NetworkPolicy**. For example, global network policies will not be returned from `kubectl get networkpolicy.p`, and are rather returned from `kubectl get globalnetworkpolicy`.
Because global network policies use **kind: GlobalNetworkPolicy**, they are grouped separately from **kind: NetworkPolicy**. For example, global network policies will not be returned from `kubectl get networkpolicy.p`, and are rather returned from `kubectl get globalnetworkpolicy`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm actually somewhat surprised cspell didn't do anything for this...

@ctauchen
Copy link
Collaborator

Thanks @jsoref. We'll need some time to comb through this, but will be back to you after a while.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@ctauchen
Copy link
Collaborator

@jsoref I'm sorry we let this one go stale. We've since brought in another tool, Vale, and have started picking away at these and other inconsistencies.

If you care to address any of those that remain in revised PR, please feel free. For now I'll close this issue.

@ctauchen ctauchen closed this Mar 20, 2024
@jsoref jsoref mentioned this pull request Mar 21, 2024
5 tasks
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.

2 participants