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: internationalize & replace jargon in vpn-latency-explained.md #762

Closed
wants to merge 1 commit into from

Conversation

getsnoopy
Copy link

PR type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other... Please describe:

PR checklist

Please check if your PR fulfils the following requirements:

  • I have read the CONTRIBUTING.md doc
  • The Git workflow follows our guidelines: CONTRIBUTING.md#git
  • I have added necessary documentation (if appropriate)

Copy link
Contributor

@rapenne-s rapenne-s left a comment

Choose a reason for hiding this comment

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

thanks for your PR, we want to keep the word impact and US words, please update the PR accordingly to the review so we could merge it.

@@ -15,7 +15,7 @@ Network speed is measured with multiple parameters: **bandwidth**, **throughput*

# Network speed explained

Before diving into the explanations about speed performance impact of a VPN, it is important to understand what lies under network performance, more commonly called "Internet speed".
Before diving into the explanations about speed performance cost of a VPN, it is important to understand what lies under network performance, more commonly called "Internet speed".
Copy link
Contributor

Choose a reason for hiding this comment

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

we want to keep impact here

@@ -25,20 +25,20 @@ It characterizes how a user feels the responsiveness when doing something over t

Why is there any latency in the first place? Computers are fast and get faster every year after all. Most of the latency occurring is due to the distance [a network packet](https://www.techtarget.com/searchnetworking/definition/packet) has to travel.

In fact, our fastest communication transport medium is the optical fiber. It can only carry data at two third of light speed, as the light beam inside the fiber is bouncing with a specific angle instead of going in a straight line. Light travels at approximately 300 000 kilometers per second, this is fast, but not enough to avoid latency.
In fact, our fastest communication transport medium is the optical fibre. It can only carry data at two third of light speed, as the light beam inside the fibre is bouncing with a specific angle instead of going in a straight line. Light travels at approximately 300 000 kilometres per second, this is fast, but not enough to avoid latency.
Copy link
Contributor

Choose a reason for hiding this comment

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

it seems a US spelling to UK spelling change right? We want to stick with the US words and keep consistent with this choice.


With these numbers in mind and some math, we can conclude networks can transport data at best at 200 000 kilometers / 124274 miles per second. Using a better time unit for latency, like milliseconds, the previous speed can be converted to 200 kilometers or 124 miles per millisecond.
With these numbers in mind and some maths, we can conclude networks can transport data at best at 200 000 kilometres / 124 274 miles per second. Using a better time unit for latency, like milliseconds, the previous speed can be converted to 200 kilometres or 124 miles per millisecond.
Copy link
Contributor

Choose a reason for hiding this comment

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

ok with the changes except for kilometers -> kilometres

@@ -55,7 +55,7 @@ In practice, the latency is slightly increased by each equipment on the network

## Bandwidth

Another important speed metric for a network is its **bandwidth**, which is the maximum speed a network can sustain for a given period of time. Bandwidth is usually expressed in megabits per second (Mbps), but as optical fiber and 5G are getting more widespread, it is getting common to express it in gigabits per second (Gbps).
Another important speed metric for a network is its **bandwidth**, which is the maximum speed a network can sustain for a given period of time. Bandwidth is usually expressed in megabits per second (Mbit/s), but as optical fibre and 5G are getting more widespread, it is getting common to express it in gigabits per second (Gbit/s).
Copy link
Contributor

Choose a reason for hiding this comment

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

Mbps and Gbps are more common when ISP or service providers are communicating with clients, it should stay like this

@@ -67,7 +67,7 @@ The bandwidth is what your ISP advertises as "speed", but in practice, it is the

Finally, the last metric measuring and quantifying a network speed is the **throughput**. It is the actual amount of data going through the network for a given period of time. The throughput is usually measured in kilobytes per second (kB/s) or megabytes per second (MB/s).

As a reminder, megabits are noted Mb while megabytes are noted MB. As 1 byte = 8 bits, there is a difference of a factor of 8 between the two.
As a reminder, megabits are noted Mbit while megabytes are noted MB. As 1 byte = 8 bits, there is a difference of a factor of 8 between the two.
Copy link
Contributor

Choose a reason for hiding this comment

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

I disagree


Exceptionally, there are known cases like the French ISP **Free** who was known for its poor peering ([source in French](https://www.ariase.com/box/actualite/lenteur-bridage-youtube-free-ufc-que-choisir)) with the network operator who serves YouTube since they could not find a trade agreement for years. This ISP was also affected for almost two years by another major peering issue that cut it from most of IPv6 traffic ([source in French](https://www.mail-archive.com/[email protected]/msg59066.html)).

# The impact of a VPN on Internet speed
# The effect of a VPN on Internet speed
Copy link
Contributor

Choose a reason for hiding this comment

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

impact stays

@getsnoopy
Copy link
Author

@rapenne-s Impact means "crash force", which makes no sense in the documentation. It has a proscribed, jargon sense of "strong/violent/marked effect", which—ignoring the fact that it's proscribed and jargon—still doesn't make sense in the documentation. For example, the first phrase would read "speed performance strong/violent/marked effect", which is a leading statement, since one doesn't know that VPNs have such a strong effect on speed performance.

Secondly, the change from "kilometers" to kilometres is not a "US to UK spelling" change; kilometres is the official, international spelling of the word in English as outlined in the SI (modern metric system). You can see this on the BIPM's official website.

Finally, as for the words that actually have been changed from the US standard to the UK ones, the rest of your website/documentation follows British spelling (as it should, since you're based in France and are targeting a global audience).

@jurajhilje jurajhilje closed this Oct 16, 2024
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.

3 participants