Fix docs typos #240

wazsone · 2023-01-09T13:58:01Z

Signed-off-by: Ruslan Bayandinov [email protected]

d-uzlov

Overall looks nice

d-uzlov · 2023-01-10T09:29:42Z

content/docs/concepts/architecture.md

@@ -15,9 +15,9 @@ A Network Service is a collection of Connectivity, Security, and Observability f

 Examples of Network Services would include:

- A simple distributed vL3 that allows the workloads to communicate via IP, optionally with DNS service for that vL3
+- A simply distributed vL3 that allows the workloads to communicate via IP, optionally with DNS service for that vL3


I think here the original text doesn't have a typo, so this change should be reverted.
Maybe a better wording would be something like this:

A simple distributed vL3 network that allows

d-uzlov · 2023-01-10T09:35:44Z

content/docs/concepts/enterprise_users.md

-that the HTTPS message itself gets to the other side and the HTTPS response gets back to the workload.  In the intervening process
-the ethernet headers, ip headers, and even the TCP connection may have been stripped away and replaced.  The payload being tranported
+Traditional Service Meshes predominantly focus on L7 payloads like HTTPS.  If a workload sends an HTTPS message, it only guarantees
+that the HTTPS message itself gets to the other side and the HTTPS response gets back to the workload.  In the intervening process,


Do we need this comma?
I'm no an expert in English grammar so I may be wrong but it feels like it shouldn't be here.

d-uzlov · 2023-01-10T09:38:02Z

content/docs/concepts/enterprise_users.md

@@ -102,7 +102,7 @@ having to expose the entire Runtime domain in which those workloads run:
 The recent [White House Executive Order on Cyber Security](https://www.whitehouse.gov/briefing-room/presidential-actions/2021/05/12/executive-order-on-improving-the-nations-cybersecurity/) says
 of Zero Trust:

-> In essence, a Zero Trust Architecture allows users full access but only to the bare minimum they need to perform their jobs.  If a device is compromised, zero trust can ensure that the damage is contained.
+> In essence, a Zero Trust Architecture allows users full access but only the bare minimum they need to perform their jobs.  If a device is compromised, zero trust can ensure that damage is contained.


I think the original meaning is to the bare minimum [of functionality], so this to was correct.

d-uzlov · 2023-01-10T09:39:08Z

content/docs/concepts/k8s.md

@@ -70,7 +70,7 @@ For each Network Service connected to a Pod, a new kernel interface will be inje
 assigned by the {{<color "#008A00" >}}Endpoint{{< /color >}} providing the Network Service, and optional routes
 indicating which IPs should be routed from the Pod to the Network Service.

-In order to avoid IP collisions, NSM prevents the use of IP addresses or routes from Prefixes in use in the cluster.
+To avoid IP collisions, NSM prevents the use of IP addresses or routes from Prefixes in use in the cluster.


It's the same meaning but I think the original wording sounds better.

glazychev-art · 2023-01-10T05:44:38Z

content/docs/concepts/architecture.md

@@ -225,7 +225,7 @@ For example, imagine that a {{<color "#0050EF" >}}Client{{< /color >}} is versio
 vulnerability.  There is a plan to remediate to foo version v1.2 with the fix.  The schedule for that is six weeks out.
 App foo needs to stay in deployment in the interim.

-An expensive IPS can provide protection from the vulnerability.  By keying off of labels provided by the {{<color "#0050EF" >}}Clients{{< /color >}} when
+An expensive IPS can protect from vulnerability.  By keying off of labels provided by the {{<color "#0050EF" >}}Clients{{< /color >}} when


I think it was correct

glazychev-art · 2023-01-10T05:46:21Z

content/docs/concepts/enterprise_users.md

@@ -34,16 +34,16 @@ In short: Connectivity Domains are Strongly Coupled to Runtime Domains.
 A central tenant of [Cloud Native](https://github.com/cncf/toc/blob/main/DEFINITION.md) is Loose Coupling.  In a Loosely Coupled system, the ability for each workload to receive service from alternative providers is preserved.

 What Runtime Domain a workload is running in is a [non-sequitur](https://en.wikipedia.org/wiki/Non_sequitur_(literary_device)) to its communications needs.  Workloads that are part of
-the same App need Connectivity between each other no matter where they are running.
+the same App need Connectivity with each other no matter where they are running.


I think it was correct

glazychev-art · 2023-01-10T05:49:59Z

content/docs/concepts/enterprise_users.md

-Traditional Service Meshes predominantly focus on L7 payloads like HTTPS.  If a workload send an HTTPS message, they only guarantee
-that the HTTPS message itself gets to the other side and the HTTPS response gets back to the workload.  In the intervening process
-the ethernet headers, ip headers, and even the TCP connection may have been stripped away and replaced.  The payload being tranported
+Traditional Service Meshes predominantly focus on L7 payloads like HTTPS.  If a workload sends an HTTPS message, it only guarantees


they only... - means Service Meshes

ThetaDR · 2023-01-10T10:27:57Z

content/docs/concepts/enterprise_users.md

@@ -54,7 +54,7 @@ It's not just a problem of cluster to cluster communication.  In the diagram bel

 ## The NSM Solution

-Network Service Mesh allows individual workloads, where ever they are running to connect securely to Network Service(s) that
+Network Service Mesh allows individual workloads, where ever they are run, to connect securely to Network Service(s) that


I think it should be like:
workloads, wherever they are run to

I'm not sure about run/running thing, but we either need to use commas on both sides of where ever they are running part, or on neither side.
And I think here we need it on both sides.

denis-tingaikin · 2023-01-29T15:17:28Z

@wazsone Could you please rebase this?

Signed-off-by: Ruslan Bayandinov <[email protected]>

denis-tingaikin

@edwarnicke Could you have a look?

d-uzlov reviewed Jan 10, 2023

View reviewed changes

glazychev-art reviewed Jan 10, 2023

View reviewed changes

ThetaDR reviewed Jan 10, 2023

View reviewed changes

wazsone force-pushed the bug/fix-docs-typos branch 3 times, most recently from be3bba0 to 512129b Compare January 30, 2023 04:20

fix docs typos

3497130

Signed-off-by: Ruslan Bayandinov <[email protected]>

wazsone force-pushed the bug/fix-docs-typos branch from 512129b to 3497130 Compare January 30, 2023 04:25

denis-tingaikin reviewed Jan 30, 2023

View reviewed changes

denis-tingaikin requested a review from edwarnicke January 30, 2023 07:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix docs typos #240

Fix docs typos #240

wazsone commented Jan 9, 2023

d-uzlov left a comment

d-uzlov Jan 10, 2023

d-uzlov Jan 10, 2023

d-uzlov Jan 10, 2023

d-uzlov Jan 10, 2023

glazychev-art Jan 10, 2023

glazychev-art Jan 10, 2023

glazychev-art Jan 10, 2023

ThetaDR Jan 10, 2023

d-uzlov Jan 10, 2023

denis-tingaikin commented Jan 29, 2023

denis-tingaikin left a comment

Fix docs typos #240

Are you sure you want to change the base?

Fix docs typos #240

Conversation

wazsone commented Jan 9, 2023

d-uzlov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denis-tingaikin commented Jan 29, 2023

denis-tingaikin left a comment

Choose a reason for hiding this comment