Skip to content

Commit 04c71c6

Browse files
authored
docs: Add Web to tool name in docs (#521)
1 parent 9a26693 commit 04c71c6

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/design.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## How does it work?
22

3-
AWS Lambda Adapter supports AWS Lambda function triggered by Amazon API Gateway Rest API, Http API(v2 event format), and Application Load Balancer.
4-
Lambda Adapter converts incoming events to http requests and send to web application, and convert the http response back to lambda event response.
3+
AWS Lambda Web Adapter supports AWS Lambda functions triggered by Amazon API Gateway Rest API, Http API (v2 event format), and Application Load Balancer.
4+
Lambda Web Adapter converts incoming events to http requests and sends to web application, and converts the http response back to lambda event response.
55

6-
Lambda Adapter is a Lambda Extension (since 0.2.0). When the docker image is running inside AWS Lambda Service, Lambda will automatic start the Adapter and
7-
the runtime process. When running outside of Lambda, Lambda Adapter does not run at all. This allows developers to package their web application
6+
Lambda Web Adapter is a Lambda Extension (since 0.2.0). When the docker image is running inside AWS Lambda Service, Lambda will automatic start the Adapter and
7+
the runtime process. When running outside of Lambda, Lambda Web Adapter does not run at all. This allows developers to package their web application
88
as a container image and run it on AWS Lambda, AWS Fargate and Amazon EC2 without changing code.
99

10-
After Lambda Adapter launch the application, it will perform readiness check on http://localhost:8080/ every 10ms.
10+
After Lambda Web Adapter launches the application, it will perform readiness check on http://localhost:8080/ every 10ms.
1111
It will start lambda runtime client after receiving 200 response from the application and forward requests to http://localhost:8080.
1212

1313
![lambda-runtime](images/lambda-adapter-runtime.png)

docs/development.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## How to build it?
22

3-
AWS Lambda Adapter is written in Rust and based on [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime).
3+
AWS Lambda Web Adapter is written in Rust and based on [AWS Lambda Rust Runtime](https://github.com/awslabs/aws-lambda-rust-runtime).
44
AWS Lambda executes functions in x86_64 Amazon Linux Environment. We need to compile the adapter to that environment.
55

66
### Clone the repo
@@ -13,7 +13,7 @@ $ cd aws-lambda-adapter
1313
```
1414

1515
### Compiling with Docker
16-
On x86_64 Windows, Linux and macOS, you can run one command to compile Lambda Adapter with docker.
16+
On x86_64 Windows, Linux and macOS, you can run one command to compile Lambda Web Adapter with docker.
1717
The Dockerfile is [here](../Dockerfile). [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) should have been installed and configured.
1818

1919
```shell
@@ -24,7 +24,7 @@ Once the build completes, it creates two docker images:
2424
- "aws-lambda-adapter:latest-x86_64" for x86_64.
2525
- "aws-lambda-adapter:latest-aarch64" for arm64.
2626

27-
AWS Lambda Adapter binary is packaged as '/opt/bootstrap' inside each docker image. "aws-lambda-adapter:latest" is tagged to the same image as "aws-lambda-adapter:latest-x86_64".
27+
AWS Lambda Web Adapter binary is packaged as '/opt/bootstrap' inside each docker image. "aws-lambda-adapter:latest" is tagged to the same image as "aws-lambda-adapter:latest-x86_64".
2828

2929
### Compiling on macOS
3030

@@ -56,15 +56,15 @@ linker = "x86_64-unknown-linux-musl-gcc"
5656
linker = "aarch64-unknown-linux-musl-gcc"'> .cargo/config
5757
```
5858

59-
Now we can cross compile AWS Lambda Adapter.
59+
Now we can cross compile AWS Lambda Web Adapter.
6060

6161
```shell
6262
$ CC=x86_64-unknown-linux-musl-gcc cargo build --release --target=x86_64-unknown-linux-musl --features vendored
6363
$ CC=aarch64-unknown-linux-musl-gcc cargo build --release --target=aarch64-unknown-linux-musl --features vendored
6464
```
6565

66-
Lambda Adapter binary for x86_64 will be placed at `target/x86_64-unknown-linux-musl/release/bootstrap`.
67-
Lambda Adapter binary for arm64 will be placed at `target/aarch64-unknown-linux-musl/release/bootstrap`.
66+
Lambda Web Adapter binary for x86_64 will be placed at `target/x86_64-unknown-linux-musl/release/bootstrap`.
67+
Lambda Web Adapter binary for arm64 will be placed at `target/aarch64-unknown-linux-musl/release/bootstrap`.
6868

6969
Finally, run the following command to package lambda adapter into two container images for x86_64 and aarch64.
7070

@@ -86,4 +86,4 @@ When these commands complete successfully, you will have the following container
8686
Please test with the following [commands](https://github.com/awslabs/aws-lambda-web-adapter/blob/ff2dc8bddd968e74d7dc2ec56a249c56e5a3c5a7/.github/workflows/pipeline.yaml#L46-L49) before submitting a pull request:
8787
1. `cargo fmt -- --check`
8888
1. `cargo clippy -- -Dwarnings`
89-
1. `cargo nextest run`
89+
1. `cargo nextest run`

0 commit comments

Comments
 (0)