From 34084a72ea8c22a32ab7ad9a5f193d9f3f18a583 Mon Sep 17 00:00:00 2001 From: Thibault Charbonnier Date: Sun, 11 Apr 2021 11:47:05 -0700 Subject: [PATCH] docs(*) typos, grammar and formatting fixes --- CONTRIBUTING.md | 2 +- DEVELOPER.md | 6 +++--- README.md | 17 ++++++++--------- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b12a063bb..e2e727e67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ that are currently being worked on or should eventually receive attention: - Test the building process on as many platforms as possible (see [DEVELOPER.md](DEVELOPER.md)). - Add [Wasmer](https://github.com/wasmerio/wasmer) support to the CI tests - matrix (see Wasmtime's [action.yml](.github/actions/wasmtime/action.yml)) + matrix (see Wasmtime's [action.yml](.github/actions/wasmtime/action.yml)). - Support for building ngx_wasm_module as a shared object (i.e. "dynamic module"). - Finishing the [proxy-wasm](https://github.com/proxy-wasm/spec) HTTP specification. diff --git a/DEVELOPER.md b/DEVELOPER.md index 15cecda6c..b00a705d2 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -317,17 +317,17 @@ contain individual jobs, each for a specific testing mode: - Tests - unit (large) Unit tests refer to `t/*.t` test files, and each unit tests job is ran as many -times as the workflow's matrix specifies. Currently, the matrixes specifies that +times as the workflow's matrix specifies. Currently, the matrices specifies that jobs run: - For several Operating Systems (Ubuntu, macOS) -- For muliple compilers (GCC, Clang) +- For multiple compilers (GCC, Clang) - For several Nginx and WebAssembly runtimes versions (Note: for the moment, Wasmtime is the only supported runtime on the CI environment). - With and without the Nginx "HUP reload" mode (`SIGHUP`). - With and without the Nginx debug mode (`--with-debug`). -The `ci-large` workflow specifies larger matrixes that take longer to run, and +The `ci-large` workflow specifies larger matrices that take longer to run, and thus only do so during daily scheduled jobs. [Back to TOC](#table-of-contents) diff --git a/README.md b/README.md index 93712adca..3c1e0ee58 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ This module enables the embedding of [WebAssembly](https://webassembly.org/) runtimes inside of [Nginx](https://nginx.org/) and aims at offering several host -SDK abstractions for the purpose of extending, and/or introspecting the Nginx -web server/proxy runtime. +SDK abstractions for the purpose of extending and/or introspecting the Nginx web +server/proxy runtime. Currently, the module aims at supporting the [proxy-wasm](https://github.com/proxy-wasm/spec) host SDK and support Wasm @@ -19,16 +19,14 @@ filters identical to those running on events {} # nginx master process gets a default 'main' VM -# a new top-level configuration block receives all configuration for -# the main VM +# a new top-level configuration block receives all configuration for this main VM wasm { # [name] [path.{wasm,wat}] module my_filter /path/to/filter.wasm; module my_module /path/to/module.wasm; } -# each nginx worker process is able to instantiate wasm modules in its -# subsystems +# each nginx worker process is able to instantiate wasm modules in its subsystems http { server { listen 9000; @@ -63,7 +61,8 @@ Several runtimes are supported, and at least one of them must be installed: - [Wasmtime](https://docs.wasmtime.dev/c-api/) (see "Installing the C API"). - [Wasmer](https://github.com/wasmerio/wasmer) (see [Building from - source](https://docs.wasmer.io/ecosystem/wasmer/building-from-source), "Wasmer C API"). + source](https://docs.wasmer.io/ecosystem/wasmer/building-from-source), "Wasmer + C API"). These runtimes' shared libraries should reside somewhere your linker can find them. By default, ngx_wasm_module will also look for these libraries in @@ -122,8 +121,8 @@ $ nginx -V # should contain '--add-module=.../ngx_wasm_module' ``` > Make sure that the `nginx` binary in your `$PATH` is the one that you just - installed, or else specify the intended binary appropriately to the shell (e.g. - `$ /path/to/nginx ...`). + installed, or else specify the intended binary appropriately to the shell + (e.g. `$ /path/to/nginx ...`). ## Documentation