Skip to content

Commit 16736ed

Browse files
Copilottheduke
andauthored
Fix spelling and grammar errors across documentation (ECO-101) (#158)
* Initial plan * Fix spelling and grammar issues in documentation Co-authored-by: theduke <[email protected]> * Fix more spelling and grammar issues (persistent, let's, article usage) Co-authored-by: theduke <[email protected]> * Fix e.g. formatting in FAQ Co-authored-by: theduke <[email protected]> * Fix remaining spelling issues (confusing, cannot) Co-authored-by: theduke <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: theduke <[email protected]>
1 parent e5c3930 commit 16736ed

File tree

11 files changed

+32
-32
lines changed

11 files changed

+32
-32
lines changed

pages/edge/architecture.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import ImageLoader from "@components/ImageLoader";
55
## Wasmer Edge - Built for the future
66

77
Wasmer Edge has been built from the ground up to host pure WebAssembly packages
8-
fully natively - nothing else like this exists today and is only possibly through
8+
fully natively - nothing else like this exists today and is only possible through
99
the close integration of the an Open Source runtime (in this case Wasmer), a WASM
1010
package manager and a distributed hosting infrastructure.
1111

@@ -91,7 +91,7 @@ and long term low cost operations:
9191
https://en.wikipedia.org/wiki/Shared-nothing_architecture
9292

9393
- Density of workloads running on edge nodes has been highly optimized for pure
94-
WebAssembly hosting allowing for a high degree **scale-up** through optmizations of the runtime.
94+
WebAssembly hosting allowing for a high degree **scale-up** through optimizations of the runtime.
9595

9696
- The distributed monolith approach of Wasmer Edge means all nodes are identical
9797
and can be replicated with little need for scaling supporting infrastructure that
@@ -174,10 +174,10 @@ and handle versioning of your apps.
174174
One of the core parts of Wasmer Edge is the runtime itself. By utilizing the
175175
Wasmer Runtime as the core virtualization platform of Wasmer Edge and the
176176
recently announced WASIX, the platform is now able to run real useful WASM
177-
programs and services directly on the edge. As the runtime itself developes
177+
programs and services directly on the edge. As the runtime itself develops
178178
over time this will continuously create new and exciting features for Wasmer Edge.
179179

180-
As an example it is now possible to code up a HTTP server or API totally
180+
As an example it is now possible to code up an HTTP server or API totally
181181
in WASM using standard libraries and deploy it on Wasmer Edge so that it
182182
can serve requests.
183183

@@ -210,13 +210,13 @@ mesh network that allow for sockets and networking from workloads. Over time,
210210
we will continue to unlock more core networking functionality.
211211

212212
Traffic is sent from browsers over websockets to enter the Wasmer Distributed
213-
Network while UDP encapsulated (and encrypted) packets are used to ship enternet
213+
Network while UDP encapsulated (and encrypted) packets are used to ship ethernet
214214
frames (OSI Layer 2) between participating nodes in a specific virtual network.
215215

216216
The design of the subsystems and topology is for many (hundreds of thousands) of
217217
unique virtual networks while all nodes can actively participate in a virtual network.
218218

219-
Browsers only need to establish a WebSocket connection to the closests Wasmer
219+
Browsers only need to establish a WebSocket connection to the closest Wasmer
220220
Edge Node in order to join a virtual network.
221221

222222
Great care was taken to implement design constraints that removed the requirements
@@ -237,7 +237,7 @@ import CoreDnet from "@assets/deploy/architecture/core-dnet.svg";
237237
- Supports **ARP** and **DHCP** snooping for port MAC learning
238238
- Supports both **IPv4** and **IPv6**
239239
- All tenant traffic is encrypted with unique (derived) tenant keys thus segmenting and sandboxing it from each other
240-
- Fully support for concurrent **socket polling**
240+
- Full support for concurrent **socket polling**
241241
- **Multithread** safe
242242
- Supports promiscuous **raw sockets**
243243
- Built in **DHCP** server
@@ -247,7 +247,7 @@ import CoreDnet from "@assets/deploy/architecture/core-dnet.svg";
247247

248248
#### 1. Fully stateless
249249

250-
Control planes add complexity and create single pointers of failure thus if one is able to
250+
Control planes add complexity and create single points of failure thus if one is able to
251251
deliver the same functionality without a control plane then it is a better design.
252252

253253
#### 2. Peer-to-Peer connection-less

pages/edge/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ Available values:
349349
* `single_concurrency`
350350

351351
Special scaling mode for apps that only support **a single request at a time**.
352-
You should enable this mode if your app can not handle multiple requests concurrently.
352+
You should enable this mode if your app cannot handle multiple requests concurrently.
353353

354354
Only a single request will be sent to each instance at a time.
355355
Edge will dynamically scale up additional instances of your app as required by the incoming request volume, and shut them down when they are no longer needed.

pages/edge/faq.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ There will soon be a way to restrict your apps to only run in specified regions,
1111
## What is threshold for 'spill over' when nodes are overloaded? Are allocations to edge nodes based on vCPU or request volume ?
1212

1313
The system will load balance dynamically based on server load - this is not something that you should assume any functional transparency about. Edge will dynamically determine how many instances of your app to start up in a given region/server.
14-
Note that we will add configuration for this, eg: you will be able to specify that you want at most X instances in a given region, or that each instance of your app should handle at most X concurrent requests, with new instances launched dynamically if that threshold is exceeded.
14+
Note that we will add configuration for this, e.g., you will be able to specify that you want at most X instances in a given region, or that each instance of your app should handle at most X concurrent requests, with new instances launched dynamically if that threshold is exceeded.
1515

1616
## How long is the 'short idle period' before server termination. If post-request server-side processing is required, how can we prevent a shutdown? Is this determined by CPU usage, a timeout post-last request, or perhaps an interceptor in the WASIX VM monitoring for specific IO syscalls, such as `accept4` ?
1717

18-
Currently this is a fixed value of a few minutes, but this can not be assumed, it may change at any time, and workloads can get evicted under contention.
19-
What we will add a graceful termination flow like on Linux: instances will receive a SIGTERM , and will have some time to clean up and finish remaining work, with hard termination only happening after a well-known grace period.
18+
Currently this is a fixed value of a few minutes, but this cannot be assumed, it may change at any time, and workloads can get evicted under contention.
19+
What we will add a graceful termination flow like on Linux: instances will receive a SIGTERM, and will have some time to clean up and finish remaining work, with hard termination only happening after a well-known grace period.
2020

2121
## Do we need utilities like pgBouncer ?
2222

2323
It would probably be advisable.
24-
It's possible for multiple versions of your app to run on multiple servers in the same region, and for a bunch of new instances to get spawned , so you might have quite bursty connection counts.
25-
If you need more control, one of the features that we hope to finish in this quarter (before end of year) is persistent instances, which will keep running , and won't be dynamically spawned or terminated.
24+
It's possible for multiple versions of your app to run on multiple servers in the same region, and for a bunch of new instances to get spawned, so you might have quite bursty connection counts.
25+
If you need more control, one of the features that we hope to finish in this quarter (before end of year) is persistent instances, which will keep running, and won't be dynamically spawned or terminated.
2626

2727
A note about database locality:
2828
We will have configuration that allows you to restrict your app to certain regions, so if you want to keep your instances close to the location of your database, that will be possible.

pages/edge/guides/laravel.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You should be able to visit http://localhost:8000 and see the home page.
3838

3939
### Setup a Wasmer Package
4040

41-
Now, lets make your app run with Wasmer. For that, you'll need to create a `wasmer.toml` file.
41+
Now, let's make your app run with Wasmer. For that, you'll need to create a `wasmer.toml` file.
4242
You can simply use this configuration:
4343

4444
```toml filename="wasmer.toml" copy

pages/edge/guides/volumes.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,28 @@ import ImageLoader from "@components/ImageLoader";
66
import dashboard from "@assets/app-dashboard.jpeg";
77

88

9-
# Using peristent storage in Wasmer Edge Apps
9+
# Using persistent storage in Wasmer Edge Apps
1010

11-
In this tutorial, you will learn how to setup peristent storage for your edge apps
11+
In this tutorial, you will learn how to setup persistent storage for your edge apps
1212

13-
Lets start with creating an edge application
13+
Let's start with creating an edge application
1414

1515
You can quickstart with an application from one of our templates
1616
```bash copy
1717
wasmer app create --template static-website
1818
```
1919

20-
Now, lets edit `app.yaml` to setup persistent volume
20+
Now, let's edit `app.yaml` to setup persistent volume
2121

2222
Add
2323
```yaml copy
2424
volumes:
2525
- name: data
2626
mount: /public/things_i_want_to_persist
2727
```
28-
to `app.yaml`. This will mount a peristent volume named `data` into `/public/persistent_volume` directory of your application
28+
to `app.yaml`. This will mount a persistent volume named `data` into `/public/persistent_volume` directory of your application
2929

30-
Now, lets re-deploy the app
30+
Now, let's re-deploy the app
3131

3232
```bash
3333
wasmer deploy
@@ -49,9 +49,9 @@ You can use any s3 client to retrieve and upload data to your bucket
4949
/>
5050

5151
## via s3 clients
52-
You can provide the credentials spesific to your app to any s3 client for accessing your volume. The credentials are available in your app's dashboard
52+
You can provide the credentials specific to your app to any s3 client for accessing your volume. The credentials are available in your app's dashboard
5353

54-
Also, wasmer cli has a convinent way to configure rclone. `wasmer app volume configure` will print rclone configuration for connecting your apps volume
54+
Also, wasmer cli has a convenient way to configure rclone. `wasmer app volume configure` will print rclone configuration for connecting your apps volume
5555

5656
## via wasmer.io
5757
In the storage section of your app's dashboard, you can see links to browse your volumes.
@@ -61,7 +61,7 @@ Note: You can only view, you can't upload files with the s3 frontend yet.
6161

6262
# Proving persistency
6363

64-
Now, lets upload "hello world" file to the volume. Get your volumes credentials and upload using an s3 client
64+
Now, let's upload "hello world" file to the volume. Get your volumes credentials and upload using an s3 client
6565
```bash
6666
echo "Hello World!" > index.html
6767
rclone copy ./index.html edge-volume:/data
@@ -70,6 +70,6 @@ rclone copy ./index.html edge-volume:/data
7070
The template app we used will show the file you uploaded at https://your_app_url.wasmer.app/things_i_want_to_persist/index.html
7171
You can also use the s3 client or the s3 frontend that we host for you to view your uploaded file
7272

73-
Now, lets force a container restart.
73+
Now, let's force a container restart.
7474
When updating your app with `wasmer deploy`, a new instance of your app will be created. So a new filesystem will be in use for your app and the volumes will be mounted
7575
After running `wasmer deploy`, you can see your `index.html` is still there. View from the app at url https://your_app_url.wasmer.app/things_i_want_to_persist/index.html, or from your s3 client, or from our hosted s3 frontend!

pages/edge/learn/deployment-modes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ please [let us know on this issue](https://github.com/wasmerio/wasmer-edge-suppo
2222

2323
WebServers are the most common type of applications.
2424

25-
Wasmer Edge support two modes for webservers: Proxy and WCGI, and each comes with it's own advantages and tradeoffs.
25+
Wasmer Edge supports two modes for webservers: Proxy and WCGI, and each comes with its own advantages and tradeoffs.
2626

2727
### Proxy
2828

@@ -51,7 +51,7 @@ To learn more about WASIX and how to build WASIX-enabled applications, see the
5151

5252
### WCGI
5353

54-
WCGI, short for WebassmblyCommonGatewayInterface, uses the tried and true
54+
WCGI, short for WebAssembly Common Gateway Interface, uses the tried and true
5555
[CGI](https://en.wikipedia.org/wiki/Common_Gateway_Interface) protocol to process
5656
HTTP requests.
5757

pages/edge/learn/volumes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The data will be purged, and your app will not have access to the volume anymore
6464

6565
<Callout type="warning">
6666
If you rename or remove a volume from the `app.yaml` configuration,
67-
all data will be deleted when you deploy, and can not be recovered.
67+
all data will be deleted when you deploy, and cannot be recovered.
6868

6969
Make sure this is what you want before deploying!
7070
</Callout>

pages/edge/vs/amazon-lambda.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ Wasmer Edge and Amazon Lambda differ in significant ways:
1818
- Wasmer Edge is built on **simpler and more scalable** technology than Lambda (which is built on top of Firecracker)
1919
- Wasmer Edge **doesn't require code changes in your application** to run, while you need to adapt your code to use the custom Lambda SDK to run.
2020
- Wasmer Edge **lets you reuse the same architecture to deploy your static assets and your dynamic websites**, while Amazon Lambda focuses only on the dynamic requests and recommends using S3 for your static assets.
21-
- Wasmer Edge can run UDP and other protocols while Amazon Lambda can not.
21+
- Wasmer Edge can run UDP and other protocols while Amazon Lambda cannot.
2222
- Amazon Lambda currently has more trigger options than Wasmer Edge

pages/graphql-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Let's see now a few things that we can do with it!
2727

2828
### Get a Package Version
2929

30-
We can do a POST to [https://registry.wasmer.io/graphql](https://registry.wasmer.io/graphql) with the the following as the `query` POST field:
30+
We can do a POST to [https://registry.wasmer.io/graphql](https://registry.wasmer.io/graphql) with the following as the `query` POST field:
3131

3232
```graphql
3333
{

pages/wasmer-pack/tutorial/02-strings-and-lists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ impl strings_and_lists::StringsAndLists for StringsAndLists {
7777
```
7878

7979
The implementation of these functions is fairly straightforward, so we don't
80-
need to go into too much detain about it other than pointing out
80+
need to go into too much detail about it other than pointing out
8181
`greet_many()`'s use of [_Slice Patterns_][slice-patterns].
8282

8383
### A Note on Ownership

0 commit comments

Comments
 (0)