Skip to content

Commit 5b7d821

Browse files
committed
refactor: Adjust docs for v3 release
1 parent 08d8c5b commit 5b7d821

File tree

16 files changed

+99
-366
lines changed

16 files changed

+99
-366
lines changed

aws-node-express-api/README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Serverless Framework Node Express API on AWS'
33
description: 'This template demonstrates how to develop and deploy a simple Node Express API running on AWS Lambda using the traditional Serverless Framework.'
44
layout: Doc
5-
framework: v2
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
priority: 1
@@ -38,34 +38,13 @@ serverless deploy
3838
After running deploy, you should see output similar to:
3939

4040
```bash
41-
Serverless: Packaging service...
42-
Serverless: Excluding development dependencies...
43-
Serverless: Creating Stack...
44-
Serverless: Checking Stack create progress...
45-
........
46-
Serverless: Stack create finished...
47-
Serverless: Uploading CloudFormation file to S3...
48-
Serverless: Uploading artifacts...
49-
Serverless: Uploading service aws-node-express-api.zip file to S3 (711.23 KB)...
50-
Serverless: Validating template...
51-
Serverless: Updating Stack...
52-
Serverless: Checking Stack update progress...
53-
.................................
54-
Serverless: Stack update finished...
55-
Service Information
56-
service: aws-node-express-api
57-
stage: dev
58-
region: us-east-1
59-
stack: aws-node-express-api-dev
60-
resources: 12
61-
api keys:
62-
None
63-
endpoints:
64-
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
41+
Deploying aws-node-express-api-project to stage dev (us-east-1)
42+
43+
✔ Service deployed to stack aws-node-express-api-project-dev (196s)
44+
45+
endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
6546
functions:
66-
api: aws-node-express-api-dev-api
67-
layers:
68-
None
47+
api: aws-node-express-api-project-dev-api (766 kB)
6948
```
7049

7150
_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 [`httpApi` event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/).

aws-node-express-dynamodb-api/README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Serverless Framework Node Express API service backed by DynamoDB on AWS'
33
description: 'This template demonstrates how to develop and deploy a simple Node Express API service backed by DynamoDB running on AWS Lambda using the traditional Serverless Framework.'
44
layout: Doc
5-
framework: v2
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
priority: 1
@@ -39,34 +39,13 @@ serverless deploy
3939
After running deploy, you should see output similar to:
4040

4141
```bash
42-
Serverless: Packaging service...
43-
Serverless: Excluding development dependencies...
44-
Serverless: Creating Stack...
45-
Serverless: Checking Stack create progress...
46-
........
47-
Serverless: Stack create finished...
48-
Serverless: Uploading CloudFormation file to S3...
49-
Serverless: Uploading artifacts...
50-
Serverless: Uploading service aws-node-express-dynamodb-api.zip file to S3 (718.53 KB)...
51-
Serverless: Validating template...
52-
Serverless: Updating Stack...
53-
Serverless: Checking Stack update progress...
54-
....................................
55-
Serverless: Stack update finished...
56-
Service Information
57-
service: aws-node-express-dynamodb-api
58-
stage: dev
59-
region: us-east-1
60-
stack: aws-node-express-dynamodb-api-dev
61-
resources: 13
62-
api keys:
63-
None
64-
endpoints:
65-
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
42+
Deploying aws-node-express-dynamodb-api-project to stage dev (us-east-1)
43+
44+
✔ Service deployed to stack aws-node-express-dynamodb-api-project-dev (196s)
45+
46+
endpoint: ANY - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com
6647
functions:
67-
api: aws-node-express-dynamodb-api-dev-api
68-
layers:
69-
None
48+
api: aws-node-express-dynamodb-api-project-dev-api (766 kB)
7049
```
7150

7251
_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 [`httpApi` event docs](https://www.serverless.com/framework/docs/providers/aws/events/http-api/). Additionally, in current configuration, the DynamoDB table will be removed when running `serverless remove`. To retain the DynamoDB table even after removal of the stack, add `DeletionPolicy: Retain` to its resource definition.

aws-node-http-api/README.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'AWS Simple HTTP Endpoint example in NodeJS'
33
description: 'This template demonstrates how to make a simple HTTP API with Node.js running on AWS Lambda and API Gateway using the Serverless Framework.'
44
layout: Doc
5-
framework: v2
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
authorLink: 'https://github.com/serverless'
@@ -27,34 +27,13 @@ $ serverless deploy
2727
After deploying, you should see output similar to:
2828

2929
```bash
30-
Serverless: Packaging service...
31-
Serverless: Excluding development dependencies...
32-
Serverless: Creating Stack...
33-
Serverless: Checking Stack create progress...
34-
........
35-
Serverless: Stack create finished...
36-
Serverless: Uploading CloudFormation file to S3...
37-
Serverless: Uploading artifacts...
38-
Serverless: Uploading service aws-node-http-api.zip file to S3 (711.23 KB)...
39-
Serverless: Validating template...
40-
Serverless: Updating Stack...
41-
Serverless: Checking Stack update progress...
42-
.................................
43-
Serverless: Stack update finished...
44-
Service Information
45-
service: serverless-http-api
46-
stage: dev
47-
region: us-east-1
48-
stack: serverless-http-api-dev
49-
resources: 12
50-
api keys:
51-
None
52-
endpoints:
53-
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
30+
Deploying aws-node-http-api-project to stage dev (us-east-1)
31+
32+
✔ Service deployed to stack aws-node-http-api-project-dev (152s)
33+
34+
endpoint: GET - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/
5435
functions:
55-
api: serverless-http-api-dev-hello
56-
layers:
57-
None
36+
hello: aws-node-http-api-project-dev-hello (1.9 kB)
5837
```
5938

6039
_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/).
@@ -91,7 +70,7 @@ Which should result in response similar to the following:
9170
```
9271
{
9372
"statusCode": 200,
94-
"body": "{\n \"message\": \"Go Serverless v2.0! Your function executed successfully!\",\n \"input\": \"\"\n}"
73+
"body": "{\n \"message\": \"Go Serverless v3.0! Your function executed successfully!\",\n \"input\": \"\"\n}"
9574
}
9675
```
9776

aws-node-http-api/handler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module.exports.hello = async (event) => {
55
statusCode: 200,
66
body: JSON.stringify(
77
{
8-
message: "Go Serverless v2.0! Your function executed successfully!",
8+
message: "Go Serverless v3.0! Your function executed successfully!",
99
input: event,
1010
},
1111
null,

aws-node-scheduled-cron/README.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'AWS Node Scheduled Cron example in NodeJS'
33
description: 'This is an example of creating a function that runs as a cron job using the serverless ''schedule'' event.'
44
layout: Doc
5-
framework: v1
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
priority: 1
@@ -95,37 +95,13 @@ serverless deploy
9595
After running deploy, you should see output similar to:
9696

9797
```bash
98-
Serverless: Packaging service...
99-
Serverless: Excluding development dependencies...
100-
Serverless: Creating Stack...
101-
Serverless: Checking Stack create progress...
102-
........
103-
Serverless: Stack create finished...
104-
Serverless: Uploading CloudFormation file to S3...
105-
Serverless: Uploading artifacts...
106-
Serverless: Uploading service aws-node-scheduled-cron.zip file to S3 (124.47 KB)...
107-
Serverless: Validating template...
108-
Serverless: Updating Stack...
109-
Serverless: Checking Stack update progress...
110-
.............................................
111-
Serverless: Stack update finished...
112-
Service Information
113-
service: aws-node-scheduled-cron
114-
stage: dev
115-
region: us-east-1
116-
stack: aws-node-scheduled-cron-dev
117-
resources: 16
118-
api keys:
119-
None
120-
endpoints:
121-
None
98+
Deploying aws-node-scheduled-cron-project to stage dev (us-east-1)
99+
100+
✔ Service deployed to stack aws-node-scheduled-cron-project-dev (205s)
101+
122102
functions:
123-
rateHandler: aws-node-scheduled-cron-dev-rateHandler
124-
cronHandler: aws-node-scheduled-cron-dev-cronHandler
125-
layers:
126-
None
127-
Serverless: Publishing service to the Serverless Dashboard...
128-
Serverless: Successfully published your service to the Serverless Dashboard: https://app.serverless.com/xxxx/apps/xxxx/aws-node-scheduled-cron/dev/us-east-1
103+
rateHandler: aws-node-scheduled-cron-project-dev-rateHandler (2.9 kB)
104+
cronHandler: aws-node-scheduled-cron-project-dev-cronHandler (2.9 kB)
129105
```
130106

131107
There is no additional step required. Your defined schedules becomes active right away after deployment.

aws-node-sqs-worker/README.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Serverless Framework Node SQS Producer-Consumer on AWS'
33
description: 'This template demonstrates how to develop and deploy a simple SQS-based producer-consumer service running on AWS Lambda using the traditional Serverless Framework.'
44
layout: Doc
5-
framework: v2
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
priority: 1
@@ -43,37 +43,15 @@ serverless deploy
4343
After running deploy, you should see output similar to:
4444

4545
```bash
46-
Serverless: Packaging service...
47-
Serverless: Excluding development dependencies...
48-
Serverless: Creating Stack...
49-
Serverless: Checking Stack create progress...
50-
........
51-
Serverless: Stack create finished...
52-
Serverless: Uploading CloudFormation file to S3...
53-
Serverless: Uploading artifacts...
54-
Serverless: Uploading service aws-node-sqs-worker.zip file to S3 (21.45 MB)...
55-
Serverless: Validating template...
56-
Serverless: Updating Stack...
57-
Serverless: Checking Stack update progress...
58-
................................................
59-
Serverless: Stack update finished...
60-
Service Information
61-
service: aws-node-sqs-worker
62-
stage: dev
63-
region: us-east-1
64-
stack: aws-node-sqs-worker-dev
65-
resources: 17
66-
api keys:
67-
None
68-
endpoints:
69-
POST - https://xxxx.execute-api.us-east-1.amazonaws.com/produce
46+
Deploying aws-node-sqs-worker-project to stage dev (us-east-1)
47+
48+
✔ Service deployed to stack aws-node-sqs-worker-project-dev (175s)
49+
50+
endpoint: POST - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/produce
7051
functions:
71-
producer: aws-node-sqs-worker-dev-producer
72-
jobsWorker: aws-node-sqs-worker-dev-jobsWorker
73-
layers:
74-
None
75-
jobs:
76-
queueUrl: https://sqs.us-east-1.amazonaws.com/xxxx/aws-node-sqs-worker-dev-jobs
52+
producer: aws-node-sqs-worker-project-dev-producer (167 kB)
53+
jobsWorker: aws-node-sqs-worker-project-dev-jobsWorker (167 kB)
54+
jobs: https://sqs.us-east-1.amazonaws.com/000000000000/aws-node-sqs-worker-project-dev-jobs
7755
```
7856

7957

aws-node/README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'AWS NodeJS Example'
33
description: 'This template demonstrates how to deploy a NodeJS function running on AWS Lambda using the traditional Serverless Framework.'
44
layout: Doc
5-
framework: v2
5+
framework: v3
66
platform: AWS
77
language: nodeJS
88
priority: 1
@@ -29,30 +29,12 @@ $ serverless deploy
2929
After running deploy, you should see output similar to:
3030

3131
```bash
32-
Serverless: Packaging service...
33-
Serverless: Excluding development dependencies...
34-
Serverless: Creating Stack...
35-
Serverless: Checking Stack create progress...
36-
........
37-
Serverless: Stack create finished...
38-
Serverless: Uploading CloudFormation file to S3...
39-
Serverless: Uploading artifacts...
40-
Serverless: Uploading service aws-node.zip file to S3 (711.23 KB)...
41-
Serverless: Validating template...
42-
Serverless: Updating Stack...
43-
Serverless: Checking Stack update progress...
44-
.................................
45-
Serverless: Stack update finished...
46-
Service Information
47-
service: aws-node
48-
stage: dev
49-
region: us-east-1
50-
stack: aws-node-dev
51-
resources: 6
32+
Deploying aws-node-project to stage dev (us-east-1)
33+
34+
✔ Service deployed to stack aws-node-project-dev (112s)
35+
5236
functions:
53-
api: aws-node-dev-hello
54-
layers:
55-
None
37+
hello: aws-node-project-dev-hello (1.5 kB)
5638
```
5739

5840
### Invocation
@@ -68,7 +50,7 @@ Which should result in response similar to the following:
6850
```json
6951
{
7052
"statusCode": 200,
71-
"body": "{\n \"message\": \"Go Serverless v2.0! Your function executed successfully!\",\n \"input\": {}\n}"
53+
"body": "{\n \"message\": \"Go Serverless v3.0! Your function executed successfully!\",\n \"input\": {}\n}"
7254
}
7355
```
7456

@@ -85,6 +67,6 @@ Which should result in response similar to the following:
8567
```
8668
{
8769
"statusCode": 200,
88-
"body": "{\n \"message\": \"Go Serverless v2.0! Your function executed successfully!\",\n \"input\": \"\"\n}"
70+
"body": "{\n \"message\": \"Go Serverless v3.0! Your function executed successfully!\",\n \"input\": \"\"\n}"
8971
}
9072
```

aws-node/handler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module.exports.hello = async (event) => {
55
statusCode: 200,
66
body: JSON.stringify(
77
{
8-
message: 'Go Serverless v2.0! Your function executed successfully!',
8+
message: 'Go Serverless v3.0! Your function executed successfully!',
99
input: event,
1010
},
1111
null,

0 commit comments

Comments
 (0)