Skip to content

Commit 48f9fbf

Browse files
mnapolimnapoli
committed
Reorganize the docs
1 parent aad1565 commit 48f9fbf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+121
-1926
lines changed

‎docs/README.md

+59-59
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,68 @@
11
- Get Started
22
- [Setup](./getting-started.md)
3-
- [Concepts](./providers/aws/guide/intro.md)
4-
- [AWS Credentials](./providers/aws/guide/credentials.md)
3+
- [Concepts](./guides/intro.md)
4+
- [AWS Credentials](./guides/credentials.md)
55
- Usage
6-
- [Deploying](./providers/aws/guide/deploying.md)
7-
- [Packaging](./providers/aws/guide/packaging.md)
8-
- [Testing](./providers/aws/guide/testing.md)
9-
- [Services](./providers/aws/guide/services.md)
10-
- [Functions](./providers/aws/guide/functions.md)
6+
- [Deploying](./guides/deploying.md)
7+
- [Packaging](./guides/packaging.md)
8+
- [Testing](./guides/testing.md)
9+
- [Services](./guides/services.md)
10+
- [Functions](./guides/functions.md)
1111
- Events
12-
- [Overview](./providers/aws/guide/events.md)
13-
- [HTTP (API Gateway v2)](./providers/aws/events/http-api.md)
14-
- [REST (API Gateway v1)](./providers/aws/events/apigateway.md)
15-
- [ActiveMQ](./providers/aws/events/activemq.md)
16-
- [Application Load Balancer](./providers/aws/events/alb.md)
17-
- [Alexa Skill](./providers/aws/events/alexa-skill.md)
18-
- [Alexa Smart Home](./providers/aws/events/alexa-smart-home.md)
19-
- [CloudWatch Event](./providers/aws/events/cloudwatch-event.md)
20-
- [CloudWatch Log](./providers/aws/events/cloudwatch-log.md)
21-
- [CloudFront](./providers/aws/events/cloudfront.md)
22-
- [Cognito User Pool](./providers/aws/events/cognito-user-pool.md)
23-
- [EventBridge Event](./providers/aws/events/event-bridge.md)
24-
- [IoT](./providers/aws/events/iot.md)
25-
- [IoT Fleet Provisioning](./providers/aws/events/iot-fleet-provisioning.md)
26-
- [Kafka](./providers/aws/events/kafka.md)
27-
- [Kinesis & DynamoDB](./providers/aws/events/streams.md)
28-
- [MSK](./providers/aws/events/msk.md)
29-
- [RabbitMQ](./providers/aws/events/rabbitmq.md)
30-
- [S3](./providers/aws/events/s3.md)
31-
- [Schedule](./providers/aws/events/schedule.md)
32-
- [SNS](./providers/aws/events/sns.md)
33-
- [SQS](./providers/aws/events/sqs.md)
34-
- [Websocket](./providers/aws/events/websocket.md)
35-
- [Layers](./providers/aws/guide/layers.md)
36-
- [IAM Function Permissions](./providers/aws/guide/iam.md)
37-
- [Parameters](./parameters.md)
38-
- [Variables](./providers/aws/guide/variables.md)
39-
- [Resources](./providers/aws/guide/resources.md)
12+
- [Overview](./guides/events.md)
13+
- [HTTP (API Gateway v2)](./events/http-api.md)
14+
- [REST (API Gateway v1)](./events/apigateway.md)
15+
- [ActiveMQ](./events/activemq.md)
16+
- [Application Load Balancer](./events/alb.md)
17+
- [Alexa Skill](./events/alexa-skill.md)
18+
- [Alexa Smart Home](./events/alexa-smart-home.md)
19+
- [CloudWatch Event](./events/cloudwatch-event.md)
20+
- [CloudWatch Log](./events/cloudwatch-log.md)
21+
- [CloudFront](./events/cloudfront.md)
22+
- [Cognito User Pool](./events/cognito-user-pool.md)
23+
- [EventBridge Event](./events/event-bridge.md)
24+
- [IoT](./events/iot.md)
25+
- [IoT Fleet Provisioning](./events/iot-fleet-provisioning.md)
26+
- [Kafka](./events/kafka.md)
27+
- [Kinesis & DynamoDB](./events/streams.md)
28+
- [MSK](./events/msk.md)
29+
- [RabbitMQ](./events/rabbitmq.md)
30+
- [S3](./events/s3.md)
31+
- [Schedule](./events/schedule.md)
32+
- [SNS](./events/sns.md)
33+
- [SQS](./events/sqs.md)
34+
- [Websocket](./events/websocket.md)
35+
- [Layers](./guides/layers.md)
36+
- [IAM Function Permissions](./guides/iam.md)
37+
- [Parameters](./guides/parameters.md)
38+
- [Variables](./guides/variables.md)
39+
- [Resources](./guides/resources.md)
4040
- [Composing services](./guides/compose.md)
41-
- [Workflow Tips](./providers/aws/guide/workflow.md)
42-
- [Serverless.yml Reference](./providers/aws/guide/serverless.yml)
41+
- [Workflow Tips](./guides/workflow.md)
42+
- [Serverless.yml Reference](./guides/serverless.yml)
4343
- CLI Reference
44-
- [Overview](./providers/aws/cli-reference/README.md)
45-
- [config credentials](./providers/aws/cli-reference/config-credentials.md)
46-
- [create](./providers/aws/cli-reference/create.md)
47-
- [install](./providers/aws/cli-reference/install.md)
48-
- [package](./providers/aws/cli-reference/package.md)
49-
- [deploy](./providers/aws/cli-reference/deploy.md)
50-
- [deploy function](./providers/aws/cli-reference/deploy-function.md)
51-
- [deploy list](./providers/aws/cli-reference/deploy-list.md)
52-
- [invoke](./providers/aws/cli-reference/invoke.md)
53-
- [invoke local](./providers/aws/cli-reference/invoke-local.md)
54-
- [logs](./providers/aws/cli-reference/logs.md)
55-
- [metrics](./providers/aws/cli-reference/metrics.md)
56-
- [info](./providers/aws/cli-reference/info.md)
57-
- [rollback](./providers/aws/cli-reference/rollback.md)
58-
- [rollback function](./providers/aws/cli-reference/rollback-function.md)
59-
- [remove](./providers/aws/cli-reference/remove.md)
60-
- [plugin list](./providers/aws/cli-reference/plugin-list.md)
61-
- [plugin search](./providers/aws/cli-reference/plugin-search.md)
62-
- [plugin install](./providers/aws/cli-reference/plugin-install.md)
63-
- [plugin uninstall](./providers/aws/cli-reference/plugin-uninstall.md)
64-
- [generate event](./providers/aws/cli-reference/generate-event.md)
65-
- [print](./providers/aws/cli-reference/print.md)
44+
- [Overview](./cli-reference)
45+
- [config credentials](./cli-reference/config-credentials.md)
46+
- [create](./cli-reference/create.md)
47+
- [install](./cli-reference/install.md)
48+
- [package](./cli-reference/package.md)
49+
- [deploy](./cli-reference/deploy.md)
50+
- [deploy function](./cli-reference/deploy-function.md)
51+
- [deploy list](./cli-reference/deploy-list.md)
52+
- [invoke](./cli-reference/invoke.md)
53+
- [invoke local](./cli-reference/invoke-local.md)
54+
- [logs](./cli-reference/logs.md)
55+
- [metrics](./cli-reference/metrics.md)
56+
- [info](./cli-reference/info.md)
57+
- [rollback](./cli-reference/rollback.md)
58+
- [rollback function](./cli-reference/rollback-function.md)
59+
- [remove](./cli-reference/remove.md)
60+
- [plugin list](./cli-reference/plugin-list.md)
61+
- [plugin search](./cli-reference/plugin-search.md)
62+
- [plugin install](./cli-reference/plugin-install.md)
63+
- [plugin uninstall](./cli-reference/plugin-uninstall.md)
64+
- [generate event](./cli-reference/generate-event.md)
65+
- [print](./cli-reference/print.md)
6666
- Learn More
6767
- [Upgrading to v3](./guides/upgrading-v3.md)
6868
- [Configuration Validation](./configuration-validation.md)

‎docs/providers/aws/cli-reference/config-credentials.md ‎docs/cli-reference/config-credentials.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Config Credentials
3-
menuText: config credentials
4-
menuOrder: 1
5-
description: Configure Serverless credentials
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/config-credentials)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Config Credentials
162

173
```bash

‎docs/providers/aws/cli-reference/create.md ‎docs/cli-reference/create.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Create
3-
menuText: create
4-
menuOrder: 2
5-
description: Creates a new Service in your current working directory
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/create)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Create
162

173
Creates a new service in the current working directory based on the provided template.

‎docs/providers/aws/cli-reference/deploy-function.md ‎docs/cli-reference/deploy-function.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Deploy Function
3-
menuText: deploy function
4-
menuOrder: 6
5-
description: Deploy your AWS Lambda functions quickly without cloudformation
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy-function)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Deploy Function
162

173
The `sls deploy function` command deploys an individual function without AWS CloudFormation. This command simply swaps out the zip file that your CloudFormation stack is pointing toward. This is a much faster way of deploying changes in code.

‎docs/providers/aws/cli-reference/deploy-list.md ‎docs/cli-reference/deploy-list.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Deploy List
3-
menuText: deploy list
4-
menuOrder: 7
5-
description: List your previous CloudFormation deployments
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy-list)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Deploy List
162

173
The `sls deploy list [functions]` command will list information about your deployments.

‎docs/providers/aws/cli-reference/deploy.md ‎docs/cli-reference/deploy.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Deploy
3-
menuText: deploy
4-
menuOrder: 5
5-
description: Deploy your service to the specified provider
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - deploy
162

173
The `sls deploy` command deploys your entire service via CloudFormation. Run this command when you have made infrastructure changes (i.e., you edited `serverless.yml`). Use `serverless deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to AWS Lambda or just change function configuration.

‎docs/providers/aws/cli-reference/generate-event.md ‎docs/cli-reference/generate-event.md

File renamed without changes.

‎docs/providers/aws/cli-reference/info.md ‎docs/cli-reference/info.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Info
3-
menuText: info
4-
menuOrder: 13
5-
description: Display information about your deployed service and the AWS Lambda Functions, Events and AWS Resources it contains.
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/info)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Info
162

173
Displays information about the deployed service.

‎docs/providers/aws/cli-reference/install.md ‎docs/cli-reference/install.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Install
3-
menuText: install
4-
menuOrder: 3
5-
description: Install pre-written AWS Lambda Functions, Events and Resources with the Serverless Framework
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/install)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Install
162

173
Installs a service from a GitHub URL in the current working directory.

‎docs/providers/aws/cli-reference/invoke-local.md ‎docs/cli-reference/invoke-local.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Invoke Local
3-
menuText: invoke local
4-
menuOrder: 9
5-
description: Emulate an invocation of your AWS Lambda function locally using the Serverless Framework
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke-local)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Invoke Local
162

173
This runs your code locally by emulating the AWS Lambda environment. Please keep in mind, it's not a 100% perfect emulation, there may be some differences, but it works for the vast majority of users. We mock the `context` with simple mock data.

‎docs/providers/aws/cli-reference/invoke.md ‎docs/cli-reference/invoke.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Invoke
3-
menuText: invoke
4-
menuOrder: 8
5-
description: Invoke an AWS Lambda Function using the Serverless Framework
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Invoke
162

173
Invokes a deployed function. You can send event data, read logs and display other important information of the function invocation.

‎docs/providers/aws/cli-reference/logs.md ‎docs/cli-reference/logs.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Logs
3-
menuText: logs
4-
menuOrder: 10
5-
description: View logs of your AWS Lambda Function within your terminal using the Serverless Framework
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/logs)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Logs
162

173
Lets you watch the logs of a specific function.

‎docs/providers/aws/cli-reference/metrics.md ‎docs/cli-reference/metrics.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Metrics
3-
menuText: metrics
4-
menuOrder: 12
5-
description: View metrics of your AWS Lambda Function within your terminal using the Serverless Framework
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/metrics)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - Metrics
162

173
Lets you watch the metrics of a specific function.

‎docs/providers/aws/cli-reference/package.md ‎docs/cli-reference/package.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Package
3-
menuText: package
4-
menuOrder: 4
5-
description: Package your service according to a specified provider
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/package)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# AWS - package
162

173
The `sls package` command packages your entire infrastructure into the `.serverless` directory by default and make it ready for deployment. You can specify another packaging directory by passing the `--package` option.

‎docs/providers/aws/cli-reference/plugin-install.md ‎docs/cli-reference/plugin-install.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Plugin Install
3-
menuText: plugin install
4-
menuOrder: 19
5-
description: Install a Serverless plugin
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/plugin-install)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# Plugin Install
162

173
Install a Serverless plugin and add it to the services `plugins` array. By default, a latest version is installed.

‎docs/cli-reference/plugin-list.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Plugin List
2+
3+
List all available plugins on the terminal. Connected to the [Serverless plugin registry](https://github.com/serverless/plugins).
4+
5+
```bash
6+
serverless plugin list
7+
```
8+
9+
## Options
10+
11+
- _None_
12+
13+
## Provided lifecycle events
14+
15+
- `plugin:list:list`

‎docs/providers/aws/cli-reference/plugin-search.md ‎docs/cli-reference/plugin-search.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
<!--
2-
title: Serverless Framework Commands - AWS Lambda - Plugin Search
3-
menuText: plugin search
4-
menuOrder: 18
5-
description: Search through all available Serverless plugins
6-
layout: Doc
7-
-->
8-
9-
<!-- DOCS-SITE-LINK:START automatically generated -->
10-
11-
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/plugin-search)
12-
13-
<!-- DOCS-SITE-LINK:END -->
14-
151
# Plugin Search
162

173
Search for a specific plugin based on a search query. Connected to the [Serverless plugin registry](https://github.com/serverless/plugins).

0 commit comments

Comments
 (0)