few more tweaks to READMEs

skierkowski · skierkowski · commit fd843cc34be7 · 2024-05-29T12:43:35.000-07:00
diff --git a/aws-node-express-api/README.md b/aws-node-express-api/README.md
@@ -15,7 +15,7 @@ authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 
 This template demonstrates how to develop and deploy a simple Node Express API service running on AWS Lambda using the Serverless Framework.
 
-This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
+This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to the [serverless-http README](https://github.com/dougmoscrop/serverless-http).
 
 ## Usage
 
@@ -40,7 +40,7 @@ Deploying "aws-node-express-api" to stage "dev" (us-east-1)
 
 ✔ Service deployed to stack aws-node-express-api-dev (96s)
 
-endpoint: ANY - https://al7bkh7f57.execute-api.us-east-1.amazonaws.com
+endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
 functions:
   api: aws-node-express-api-dev-api (2.3 kB)
 ```
@@ -61,18 +61,6 @@ Which should result in the following response:
 { "message": "Hello from root!" }
 ```
 
-Calling the `/hello` path with:
-
-```
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/hello
-```
-
-Should result in the following response:
-
-```json
-{ "message": "Hello from path!" }
-```
-
 ### Local development
 
 The easiest way to develop and test your function is to use the `dev` command:
@@ -83,14 +71,6 @@ serverless dev
 
 This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-In another terminal you can invoke your function by using the following command:
-
-```
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/hello
-```
+Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy.
 
-Which should result in response similar to the following:
-
-```json
-{ "message": "Hello from path!" }
-```
+When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.
diff --git a/aws-node-express-dynamodb-api/README.md b/aws-node-express-dynamodb-api/README.md
@@ -2,7 +2,7 @@
 title: 'Serverless Framework Node Express API service backed by DynamoDB on AWS'
 description: 'This template demonstrates how to develop and deploy a simple Node Express API service backed by DynamoDB running on AWS Lambda using the Serverless Framework.'
 layout: Doc
-framework: v2
+framework: v4
 platform: AWS
 language: nodeJS
 priority: 1
@@ -15,7 +15,7 @@ authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 
 This template demonstrates how to develop and deploy a simple Node Express API service, backed by DynamoDB table, running on AWS Lambda using the Serverless Framework.
 
-This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to corresponding [GitHub repository](https://github.com/dougmoscrop/serverless-http).
+This template configures a single function, `api`, which is responsible for handling all incoming requests using the `httpApi` event. To learn more about `httpApi` event configuration options, please refer to [httpApi event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). As the event is configured in a way to accept all incoming requests, the Express.js framework is responsible for routing and handling requests internally. This implementation uses the `serverless-http` package to transform the incoming event request payloads to payloads compatible with Express.js. To learn more about `serverless-http`, please refer to the [serverless-http README](https://github.com/dougmoscrop/serverless-http).
 
 Additionally, it also handles provisioning of a DynamoDB database that is used for storing data about users. The Express.js application exposes two endpoints, `POST /users` and `GET /user/:userId`, which create and retrieve a user record.
 
@@ -42,7 +42,7 @@ Deploying "aws-node-express-dynamodb-api" to stage "dev" (us-east-1)
 
 ✔ Service deployed to stack aws-node-express-dynamodb-api-dev (109s)
 
-endpoint: ANY - https://jhssgx6g93.execute-api.us-east-1.amazonaws.com
+endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
 functions:
   api: aws-node-express-dynamodb-api-dev-api (3.8 MB)
 ```
@@ -85,14 +85,6 @@ serverless dev
 
 This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-In another terminal you can invoke your function by using the following command:
+Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy.
 
-```
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/users/someUserId
-```
-
-Which should result in response similar to the following:
-
-```json
-{ "userId": "someUserId", "name": "John" }
-```
+When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.
diff --git a/aws-node-http-api/README.md b/aws-node-http-api/README.md
@@ -33,7 +33,7 @@ Deploying "serverless-http-api" to stage "dev" (us-east-1)
 
 ✔ Service deployed to stack serverless-http-api-dev (91s)
 
-endpoint: GET - https://xiz94rsg9g.execute-api.us-east-1.amazonaws.com/
+endpoint: GET - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/
 functions:
   hello: serverless-http-api-dev-hello (1.6 kB)
 ```
@@ -64,14 +64,6 @@ serverless dev
 
 This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-In another terminal you can invoke your function by using the following command:
+Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy.
 
-```
-curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/hello
-```
-
-Which should result in response similar to the following:
-
-```json
-{ "message": "Go Serverless v4! Your function executed successfully!" }
-```
+When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.
diff --git a/aws-node-scheduled-cron/README.md b/aws-node-scheduled-cron/README.md
@@ -51,8 +51,6 @@ serverless dev
 
 This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-This function will be called every minute by the scheduler; however, you can also manually invoke the function using this command:
+Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy.
 
-```
-serverless invoke --function rateHandler
-```
+When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.
diff --git a/aws-node/README.md b/aws-node/README.md
@@ -63,17 +63,6 @@ serverless dev
 
 This will start a local emulator of AWS Lambda and tunnel your requests to and from AWS Lambda, allowing you to interact with your function as if it were running in the cloud.
 
-In another terminal you can invoke your function by using the following command:
+Now you can invoke the function as before, but this time the function will be executed locally. Now you can develop your function locally, invoke it, and see the results immediately without having to re-deploy.
 
-```
-serverless invoke --function hello
-```
-
-Which should result in response similar to the following:
-
-```json
-{
-  "statusCode": 200,
-  "body": "{\"message\":\"Go Serverless v4.0! Your function executed successfully!\"}"
-}
-```
+When you are done developing, don't forget to run `serverless deploy` to deploy the function to the cloud.
diff --git a/aws-python-flask-api/README.md b/aws-python-flask-api/README.md
@@ -15,9 +15,7 @@ authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 
 This template demonstrates how to develop and deploy a simple Python Flask API service running on AWS Lambda using the Serverless Framework.
 
-## Anatomy of the template
-
-This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to configured `http` events. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). As the events are configured in a way to accept all incoming requests, `Flask` framework is responsible for routing and handling requests internally. The implementation takes advantage of `serverless-wsgi`, which allows you to wrap WSGI applications such as Flask apps. To learn more about `serverless-wsgi`, please refer to corresponding [GitHub repository](https://github.com/logandk/serverless-wsgi). Additionally, the template relies on `serverless-python-requirements` plugin for packaging dependencies from `requirements.txt` file. For more details about `serverless-python-requirements` configuration, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).
+This template configures a single function, `api`, which is responsible for handling all incoming requests thanks to configured `http` events. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). As the events are configured in a way to accept all incoming requests, `Flask` framework is responsible for routing and handling requests internall y. The implementation takes advantage of `serverless-wsgi`, which allows you to wrap WSGI applications such as Flask apps. To learn more about `serverless-wsgi`, please refer to corresponding [GitHub repository](https://github.com/logandk/serverless-wsgi). Additionally, the template relies on `serverless-python-requirements` plugin for packaging dependencies from `requirements.txt` file. For more details about `serverless-python-requirements` configuration, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).
 
 ## Usage
 
