Skip to content

Commit

Permalink
Merge pull request #397 from Financial-Times/serverless-docs
Browse files Browse the repository at this point in the history
CPP-1055 Tidy up the documentation for Serverless
  • Loading branch information
ivomurrell authored Apr 5, 2023
2 parents bea27de + 5d94e36 commit 5b45170
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions plugins/serverless/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Tool Kit plugin to manage Lambdas with [AWS serverless](https://www.serverless.com/framework/docs/getting-started/).

This plugin will be installed as a dependency of the [backend-serverless-app](https://github.com/Financial-Times/dotcom-tool-kit/tree/main/plugins/backend-serverless-app) plugin, which we recommend using instead of installing this plugin directly. That plugin will install additional plugins that will be useful or most Customer Products projects at the FT.

## Installation & usage

With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
Expand Down Expand Up @@ -35,3 +37,4 @@ plugins:
|-|-|-|
| `ServerlessRun` | Run application with `serverless` | `run:local` |
| `ServerlessProvision` | Deploy review app with `serverless` | `deploy:review` |
| `ServerlessDeploy` | Deploy production app with `serverless` | `deploy:production` |

0 comments on commit 5b45170

Please sign in to comment.