additional minor tweaks on readme

skierkowski · skierkowski · commit 376500dcaf14 · 2024-05-29T15:44:05.000-07:00
diff --git a/aws-node-express-api/README.md b/aws-node-express-api/README.md
@@ -35,7 +35,7 @@ serverless deploy
 
 After running deploy, you should see output similar to:
 
-```bash
+```
 Deploying "aws-node-express-api" to stage "dev" (us-east-1)
 
 ✔ Service deployed to stack aws-node-express-api-dev (96s)
@@ -51,7 +51,7 @@ _Note_: In current form, after deployment, your API is public and can be invoked
 
 After successful deployment, you can call the created application via HTTP:
 
-```bash
+```
 curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
 ```
 
diff --git a/aws-node-http-api/README.md b/aws-node-http-api/README.md
@@ -23,7 +23,7 @@ This template does not include any kind of persistence (database). For more adva
 In order to deploy the example, you need to run the following command:
 
 ```
-$ serverless deploy
+serverless deploy
 ```
 
 After running deploy, you should see output similar to:
diff --git a/aws-node-scheduled-cron/README.md b/aws-node-scheduled-cron/README.md
@@ -13,7 +13,7 @@ authorAvatar: 'https://avatars3.githubusercontent.com/u/5679763?v=4&s=140'
 
 # Serverless Framework Node Scheduled Cron on AWS
 
-This template demonstrates how to develop and deploy a simple cron-like service running on AWS Lambda using the traditional Serverless Framework.
+This template demonstrates how to develop and deploy a simple cron-like service running on AWS Lambda using the Serverless Framework.
 
 This examples defines a single function, `rateHandler` which is triggered by an event of `schedule` type at a rate of 1 per minute. For detailed information about `schedule` event, please refer to corresponding section of Serverless [docs](https://serverless.com/framework/docs/providers/aws/events/schedule/).
 
@@ -24,7 +24,7 @@ This examples defines a single function, `rateHandler` which is triggered by an
 In order to deploy the example, you need to run the following command:
 
 ```
-$ serverless deploy
+serverless deploy
 ```
 
 After running deploy, you should see output similar to:
diff --git a/aws-node/README.md b/aws-node/README.md
@@ -13,7 +13,7 @@ authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 
 # Serverless Framework AWS NodeJS Example
 
-This template demonstrates how to deploy a simple NodeJS function running on AWS Lambda using the Serverless Framework. The deployed function does not include any event definitions or any kind of persistence (database). For more advanced configurations check out the [examples repo](https://github.com/serverless/examples/) which includes integrations with SQS, DynamoDB or examples of functions that are triggered in `cron`-like manner. For details about configuration of specific events, please refer to our [documentation](https://www.serverless.com/framework/docs/providers/aws/events/).
+This template demonstrates how to deploy a simple NodeJS function running on AWS Lambda using the Serverless Framework. The deployed function does not include any event definitions or any kind of persistence (database). For more advanced configurations check out the [examples repo](https://github.com/serverless/examples/) which include use cases like API endpoints, workers triggered by SQS, persistence with DynamoDB, and scheduled tasks. For details about configuration of specific events, please refer to our [documentation](https://www.serverless.com/framework/docs/providers/aws/events/).
 
 ## Usage
 
@@ -22,7 +22,7 @@ This template demonstrates how to deploy a simple NodeJS function running on AWS
 In order to deploy the example, you need to run the following command:
 
 ```
-$ serverless deploy
+serverless deploy
 ```
 
 After running deploy, you should see output similar to:
diff --git a/aws-python-flask-api/README.md b/aws-python-flask-api/README.md
@@ -19,17 +19,6 @@ This template configures a single function, `api`, which is responsible for hand
 
 ## Usage
 
-### Prerequisites
-
-In order to package your dependencies locally with `serverless-python-requirements`, you need to have `Python3.8` installed locally. You can create and activate a dedicated virtual environment with the following command:
-
-```
-python3.8 -m venv ./venv
-source ./venv/bin/activate
-```
-
-Alternatively, you can also use `dockerizePip` configuration from `serverless-python-requirements`. For details on that, please refer to corresponding [GitHub repository](https://github.com/UnitedIncome/serverless-python-requirements).
-
 ### Deployment
 
 This example is made to work with the Serverless Framework dashboard, which includes advanced features such as CI/CD, monitoring, metrics, etc.
@@ -70,8 +59,8 @@ Packaging Python WSGI handler...
 ✔ Service deployed to stack aws-python-flask-api-dev (104s)
 
 endpoints:
-  ANY - https://ce9zsxqh6e.execute-api.us-east-1.amazonaws.com/dev/
-  ANY - https://ce9zsxqh6e.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
+  ANY - https://xxxxxxxxxe.execute-api.us-east-1.amazonaws.com/dev/
+  ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
 functions:
   api: aws-python-flask-api-dev-api (41 MB)
 
diff --git a/aws-python-flask-dynamodb-api/README.md b/aws-python-flask-dynamodb-api/README.md
@@ -58,13 +58,13 @@ Packaging Python WSGI handler...
 ✔ Service deployed to stack aws-python-flask-dynamodb-api-dev (123s)
 
 endpoints:
-  ANY - https://r9a04q5it7.execute-api.us-east-1.amazonaws.com/dev/
-  ANY - https://r9a04q5it7.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
+  ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/
+  ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev/{proxy+}
 functions:
   api: aws-python-flask-dynamodb-api-dev-api (41 MB)
 ```
 
-_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
+_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api).
 
 ### Invocation
 
diff --git a/aws-python-http-api/README.md b/aws-python-http-api/README.md
@@ -6,7 +6,7 @@ framework: v4
 platform: AWS
 language: python
 authorLink: 'https://github.com/serverless'
-authorName: 'Serverless, inc.'
+authorName: 'Serverless, Inc.'
 authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
 -->
 
@@ -21,7 +21,7 @@ This template does not include any kind of persistence (database). For more adva
 ### Deployment
 
 ```
-$ serverless deploy
+serverless deploy
 ```
 
 After deploying, you should see output similar to:
diff --git a/aws-python-http-api/serverless.yml b/aws-python-http-api/serverless.yml
@@ -4,6 +4,7 @@ frameworkVersion: '4'
 provider:
   name: aws
   runtime: python3.12
+
 functions:
   hello:
     handler: handler.hello
diff --git a/aws-python-scheduled-cron/README.md b/aws-python-scheduled-cron/README.md
@@ -58,15 +58,15 @@ serverless invoke local --function rateHandler
 
 After invocation, you should see output similar to:
 
-```bash
-INFO:handler:Your cron function aws-python-scheduled-cron-dev-rateHandler ran at 15:02:43.203145
+```
+INFO:handler:Your cron function ran at 15:02:43.203145
 ```
 
 ### Bundling dependencies
 
 In case you would like to include 3rd party dependencies, you will need to use a plugin called `serverless-python-requirements`. You can set it up by running the following command:
 
-```bash
+```
 serverless plugin install -n serverless-python-requirements
 ```
 
diff --git a/aws-python/README.md b/aws-python/README.md
@@ -22,7 +22,7 @@ This template demonstrates how to deploy a Python function running on AWS Lambda
 In order to deploy the example, you need to run the following command:
 
 ```
-$ serverless deploy
+serverless deploy
 ```
 
 After running deploy, you should see output similar to:
@@ -40,7 +40,7 @@ functions:
 
 After successful deployment, you can invoke the deployed function by using the following command:
 
-```bash
+```
 serverless invoke --function hello
 ```
 
@@ -57,24 +57,24 @@ Which should result in response similar to the following:
 
 You can invoke your function locally by using the following command:
 
-```bash
+```
 serverless invoke local --function hello
 ```
 
 Which should result in response similar to the following:
 
 ```
 {
-    "statusCode": 200,
-    "body": "{\"message\": \"Go Serverless v4.0! Your function executed successfully!\"}"
+  "statusCode": 200,
+  "body": "{\"message\": \"Go Serverless v4.0! Your function executed successfully!\"}"
 }
 ```
 
 ### Bundling dependencies
 
 In case you would like to include third-party dependencies, you will need to use a plugin called `serverless-python-requirements`. You can set it up by running the following command:
 
-```bash
+```
 serverless plugin install -n serverless-python-requirements
 ```
 
