From 6eda2ac11e7287a9fc769f241003c9fcf379537d Mon Sep 17 00:00:00 2001 From: Philipp Muens Date: Thu, 23 Jun 2016 14:15:21 +0200 Subject: [PATCH 1/2] Add new documentation structure for alpha 1 release --- README.md | 4 +- docs/README.md | 92 ++++++++----------- docs/concepts/README.md | 3 - docs/developing-plugins/README.md | 10 ++ .../building-plugins.md} | 11 +-- .../building-provider-integrations.md | 1 + docs/guide/README.md | 19 +++- docs/guide/creating-a-service.md | 14 +++ docs/guide/custom-provider-resources.md | 1 + docs/guide/deploying-a-service.md | 4 + docs/guide/event-sources.md | 64 +++++++++++++ docs/guide/installation.md | 1 + docs/guide/invoking-a-function.md | 10 ++ docs/guide/removing-a-service.md | 6 ++ docs/tutorials/README.md | 4 - docs/tutorials/adding-event-sources.md | 61 ------------ docs/tutorials/your-first-service.md | 54 ----------- docs/understanding-serverless/README.md | 13 +++ .../serverless-env-yaml.md | 0 .../serverless-yaml.md | 0 .../services-and-functions.md} | 0 docs/using-plugins/README.md | 7 ++ docs/using-plugins/adding-custom-plugins.md | 1 + 23 files changed, 194 insertions(+), 186 deletions(-) delete mode 100644 docs/concepts/README.md create mode 100644 docs/developing-plugins/README.md rename docs/{concepts/plugins.md => developing-plugins/building-plugins.md} (97%) create mode 100644 docs/developing-plugins/building-provider-integrations.md create mode 100644 docs/guide/creating-a-service.md create mode 100644 docs/guide/custom-provider-resources.md create mode 100644 docs/guide/deploying-a-service.md create mode 100644 docs/guide/installation.md create mode 100644 docs/guide/invoking-a-function.md create mode 100644 docs/guide/removing-a-service.md delete mode 100644 docs/tutorials/README.md delete mode 100644 docs/tutorials/adding-event-sources.md delete mode 100644 docs/tutorials/your-first-service.md create mode 100644 docs/understanding-serverless/README.md rename docs/{concepts => understanding-serverless}/serverless-env-yaml.md (100%) rename docs/{concepts => understanding-serverless}/serverless-yaml.md (100%) rename docs/{concepts/services.md => understanding-serverless/services-and-functions.md} (100%) create mode 100644 docs/using-plugins/README.md create mode 100644 docs/using-plugins/adding-custom-plugins.md diff --git a/README.md b/README.md index 20f85c524..9479fbf77 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Serverless Application Framework AWS Lambda API Gateway](other/img/readme_serverless_framework_v1.gif) -Serverless Framework V.1 (BETA) +Serverless Framework v.1.0 ================================= [![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com) @@ -19,7 +19,7 @@ Also, [we're hiring](mailto:jobs@serverless.com) :) ## Status -Serverless Framework V.1 is currently under construction and not yet ready. +Serverless Framework v.1.0 is currently under construction and not yet ready. ## Features diff --git a/docs/README.md b/docs/README.md index caf28da86..43b1631f7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,62 +17,46 @@ service afterwards. 4. `serverless invoke --function hello --stage dev --region us-east-1` 5. `serverless remove --stage dev --region us-east-1` -## In depth +## How to contribute to Serverless -- [Concepts](/docs/concepts) - - [Services](/docs/concepts/services.md) - Understanding Serverless services - - [serverless.yaml](/docs/concepts/serverless-yaml.md) - A look at the `serverless.yaml` file - - [serverless.env.yaml](/docs/concepts/serverless-env-yaml.md) - A look at the `serverless.env.yaml` file - - [Plugins](/docs/concepts/plugins.md) - How plugins work -- [Guide](/docs/guide) - - [Event sources](/docs/guide/event-sources.md) - Understand and use event sources -- [Tutorials](/docs/tutorials) - - [Your first service](/docs/tutorials/your-first-service.md) - Create, deploy, invoke and remove your first service - - [Adding event sources](/docs/tutorials/adding-event-sources.md) - Learn how you can extend your services functionality - with event sources -- Plugins - - [Core plugins](/lib/plugins) - - [Create](/lib/plugins/create) - Creates a new Serverless service - - [Deploy](/lib/plugins/deploy) - Deploy your resources to your provider - - [Invoke](/lib/plugins/invoke) - Invoke your function - - [Remove](/lib/plugins/remove) - Remove a deployed service - - [AWS plugins](/lib/plugins/aws) - - [Compile Functions](/lib/plugins/aws/deploy/compile/functions) - Compiles functions to - CloudFormation resources - - [Compile S3 Events](/lib/plugins/aws/deploy/compile/events/s3) - Compiles S3 events to - CloudFormation resources - - [Compile Scheduled Events](/lib/plugins/aws/deploy/compile/events/schedule) - Compiles scheduled - events to CloudFormation resources - - [Compile Api Gateway Events](/lib/plugins/aws/deploy/compile/apiGateway) - Compiles http events - to CloudFormation resources - - [Deploy](/lib/plugins/aws/deploy) - Deploys the service to AWS - - [Invoke](/lib/plugins/aws/invoke) - Invokes an AWS lambda function - - [Remove](/lib/plugins/aws/remove) - Removes the service with all it's resources from AWS +We love our community! Contributions are always welcomed! +Jump right into our [issues](https://github.com/serverless/serverless/issues) to join existing discussions or open up +new ones if you have a bug or want to improve Serverless. -## FAQ +Also feel free to open up [pull request](https://github.com/serverless/serverless/pulls) which resolves issues! -> Where do I start when I want to write apps with Serverless? +You may also take a look at our [contributing guidelines](/CONTRIBUTING.md). -You should take a look at the [tutorials](/docs/tutorials) where you will find different guides which will help you -with your first application (there's also a ["Your first service"](/docs/tutorials/your-first-service.md) tutorial). +## User documentation -> I want to integrate provider X. How does this work? - -You can implement your provider of choice with he help of plugins. Start by reading the [plugin concept](/docs/concepts/plugins.md) -to get an overview how plugins work. After that you might want to take a look at the [AWS Deploy](/lib/plugins/aws/deploy) -plugin which will explain to you how the AWS provider is implemented / works. - -We'd recommend to take a look at the different sources of the [plugins](/lib/plugins) as they show implementation -details and best practices which will help you integrate your provider easily. - -> How does Serverless work? - -The [concepts](/docs/concepts) folder in the docs will help you understand how Serverless works. - -> I found a bug / encountered a strange error - -Please take a look at our [issues](https://github.com/serverless/serverless/issues) to see if someone else has faced -the same problem. - -Contributions are always welcomed! Just open up a new issue to start the discussion or submit a pull request -which fixes the bug. +- [Understanding Serverless and its configuration files](understanding-serverless) + - [Serverless services and functions](understanding-serverless/services-and-functions.md) + - [serverless.yaml](understanding-serverless/serverless-yaml.md) + - [serverless.env.yaml](understanding-serverless/serverless-env-yaml.md) +- [How to build your Serverless services](guide) + - [Installing Serverless](guide/installation.md) + - [Creating a service](guide/creating-a-service.md) + - [Deploying your service](guide/deploying-a-service.md) + - [Invoking your functions](guide/invoking-a-function.md) + - [Adding additional event sources](guide/event-sources.md) + - [Managing custom provider resources](guide/custom-provider-resources.md) + - [Removing your service](guide/removing-a-service.md) +- [Using plugins](using-plugins) + - [How to use additional plugins in your service](using-plugins/adding-custom-plugins.md) + - Plugins provided by Serverless + - Core plugins + - [Create](/lib/plugins/create) + - [Deploy](/lib/plugins/deploy) + - [Invoke](/lib/plugins/invoke) + - [Remove](/lib/plugins/remove) + - Amazon Web Services + - [Compile Functions](/lib/plugins/aws/deploy/compile/functions) + - [Compile S3 Events](/lib/plugins/aws/deploy/compile/events/s3) + - [Compile Scheduled Events](/lib/plugins/aws/deploy/compile/events/schedule) + - [Compile Api Gateway Events](/lib/plugins/aws/deploy/compile/apiGateway) + - [Deploy](/lib/plugins/aws/deploy) + - [Invoke](/lib/plugins/aws/invoke) + - [Remove](/lib/plugins/aws/remove) +- [Building plugins](developing-plugins) + - [How to build your own plugin](developing-plugins/building-plugins.md) + - [How to build provider integration with your plugin](developing-plugins/building-provider-integrations.md) diff --git a/docs/concepts/README.md b/docs/concepts/README.md deleted file mode 100644 index ca321a25d..000000000 --- a/docs/concepts/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Concepts - -The "concepts" section provides documents for a deep dive into the different concepts Serverless is built upon. diff --git a/docs/developing-plugins/README.md b/docs/developing-plugins/README.md new file mode 100644 index 000000000..2696e1deb --- /dev/null +++ b/docs/developing-plugins/README.md @@ -0,0 +1,10 @@ +# Developing plugins + +Here you can read how to develop your own Serverless plugins. We'll get into details on how to write custom plugins to +extend the functionality of Serverless. Furthermore we'll look into the way how you can use your plugin knowledge +to integrate your own provider into the Serverless framework. + +## Table of contents + +- [Building plugins](building-plugins.md) +- [Building provider integrations](building-provider-integrations.md) diff --git a/docs/concepts/plugins.md b/docs/developing-plugins/building-plugins.md similarity index 97% rename from docs/concepts/plugins.md rename to docs/developing-plugins/building-plugins.md index d10460549..104beaef5 100644 --- a/docs/concepts/plugins.md +++ b/docs/developing-plugins/building-plugins.md @@ -1,4 +1,4 @@ -# Plugin System and Lifecycle Management +# Building plugins The Serverless Plugin System is at the core of our Framework. It supports any feature we build, it decides how fast we can build them, how easily testable they are and how approachable they are for our users. @@ -251,8 +251,8 @@ A user has to define the plugins they want to use in the root level of the serve ```yaml plugins: - - custom_plugin_1 - - custom_plugin_2 + - custom_plugin_1 + - custom_plugin_2 ``` We do not auto-detect plugins from installed dependencies so users do not run into any surprises and we cut down on the @@ -295,11 +295,10 @@ E.g. we defined the following event for a function: ```yaml events: - aws: - S3: bucket_name + - s3: bucket_name ``` -The SimpleS3Event plugin could now bind to the configureEvent Lifecycle Event, read this configuration and add +The S3 event plugin could now bind to the configureEvent Lifecycle Event, read this configuration and add appropriate resources to the CloudFormation configuration. Then once the AWSResourceDeployment plugin converts the CloudFormation syntax we’ve stored in the object into an actual CloudFormation stack file it will include all of the configuration necessary to create the Bucket and set it up to trigger the Lambda function we’re also deploying. diff --git a/docs/developing-plugins/building-provider-integrations.md b/docs/developing-plugins/building-provider-integrations.md new file mode 100644 index 000000000..0e740163a --- /dev/null +++ b/docs/developing-plugins/building-provider-integrations.md @@ -0,0 +1 @@ +# Building provider integrations diff --git a/docs/guide/README.md b/docs/guide/README.md index 942371df8..11a6aee03 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,4 +1,19 @@ # Guide -This guide will help you build your Serverless services. Furthermore it will provide best practices and patterns you can -use while developing your Serverless application. +This guide will help you building your Serverless services. +We'll start by givin you information on how to install Serverless. After that we create and deploy a service, invoke a +services function and add additional event sources to our function. + +At the end we'll add custom provider resources to our service and remove it. + +This guide is Amazon web service specific but can be applied to any other provider as the steps are similar. + +## Table of contents + +- [Installation](installation.md) +- [Creating a service](creating-a-service.md) +- [Deploying a service](deploying-a-service.md) +- [Invoking a function](invoking-a-function.md) +- [Event sources](event-sources.md) +- [Custom provider resources](custom-provider-resources.md) +- [Removing a service](removing-a-service.md) diff --git a/docs/guide/creating-a-service.md b/docs/guide/creating-a-service.md new file mode 100644 index 000000000..6d062ccc4 --- /dev/null +++ b/docs/guide/creating-a-service.md @@ -0,0 +1,14 @@ +# Creating a service + +`cd` into a directory of your choice and run `serverless create --name my-service --provider aws`. +Serverless will create a skeleton for your new Serverless service inside the `my-service` directory. + +Type `cd my-service` to navigate into the previously created directory. + +## Open the service inside an editor + +Open the directory with your favorite editor. You should see some files. One of those is the `serverless.yaml` file. +This file holds all the important information about your service. You should see e.g. a `functions` definition where +one function is defined. + +You don't have to understand what's going on here as we'll go into more details about this file in upcoming tutorials. diff --git a/docs/guide/custom-provider-resources.md b/docs/guide/custom-provider-resources.md new file mode 100644 index 000000000..f6a1b62b1 --- /dev/null +++ b/docs/guide/custom-provider-resources.md @@ -0,0 +1 @@ +# Custom provider resources diff --git a/docs/guide/deploying-a-service.md b/docs/guide/deploying-a-service.md new file mode 100644 index 000000000..414e4648d --- /dev/null +++ b/docs/guide/deploying-a-service.md @@ -0,0 +1,4 @@ +# Deploying a service + +Let's deploy our service by typing `serverless deploy`. You should see a prompt which informs you once the corresponding +resources are deployed to AWS. diff --git a/docs/guide/event-sources.md b/docs/guide/event-sources.md index f488e60db..4cf168ec2 100644 --- a/docs/guide/event-sources.md +++ b/docs/guide/event-sources.md @@ -1,5 +1,69 @@ # Event sources +Serverless is used to build event driven architecture. Basically everything a function can trigger is an event. +Events could be HTTP requests, events fired from a cloud storage, scheduled events, etc. + +This tutorial will show you how you can add event sources to your Serverless service. + +We'll assume that you have Serverless v1.0 or greater installed on your machine. + +Our provider we use throughout the tutorial will be Amazon web services (AWS). + +**Note:** This tutorial will implement a schedule event for a function which is deployed to Amazon web services. +You can re-use this tutorial to add [other event sources](/docs/guide/event-sources.md) +(even from other providers) to your functions. + +## Scheduling a function + +Let's pretend we want to re-run our function every 10 minutes. One solution would be to open up the cloud provider dashboard +and run the function by hand but this is of course not the best way to solve our problem. + +You might be familiar with so called "Cron jobs" if you're a UNIX user. Cron jobs are a way to define reoccurring +tasks the operating system will trigger automatically (e.g. some sort of scripts that automates something for you). + +AWS has introduced a similar way we can automate the way our lambda function get's called. + +## Adding the schedule event source + +Let's add a schedule event source to a function in our Serverless service. + +Go to the Serverless service directory and open up the `serverless.yaml` file. Navigate to the function of your choice +where you want to add an event source. Add a new entry `events` inside the function. It should be on the same level as +the `handler` entry. + +After that add a `- schedule: rate(10 minutes)` entry inside the `events` definition. + +Not the content of your `serverless.yaml` file might look like this: + +```yaml +functions: + greet: + handler: handler.greet + events: + - schedule: rate(10 minutes) +``` + +That's it for the event addition. Next up we need to (re)deploy our service to enable our scheduled event. + +## (Re)deploying the Serverless service + +Run `serverless deploy` to (re)deploy the whole service. +Your function will be scheduled to run every 10 minutes once the deployment has finished. + +## Conclusion + +Event sources are a great way to extend the functionality of your functions. +They are pretty easy to setup. You simply need to add them to the corresponding function in your services `serverless.yaml` +file and (re)deploy the service. + +Serverless has implementations for different provider independent and provider specific event sources you can use. + +Curious what events are available? Here's a list with [all available events](/docs/guide/event-sources.md). + +--- + +# Event sources + With Serverless you write event driven architectures. An event can be e.g. a HTTP request, a schedule event or even an event when someone uploads a file to a cloud storage. diff --git a/docs/guide/installation.md b/docs/guide/installation.md new file mode 100644 index 000000000..25267fe2b --- /dev/null +++ b/docs/guide/installation.md @@ -0,0 +1 @@ +# Installation diff --git a/docs/guide/invoking-a-function.md b/docs/guide/invoking-a-function.md new file mode 100644 index 000000000..6cfca51f1 --- /dev/null +++ b/docs/guide/invoking-a-function.md @@ -0,0 +1,10 @@ +# Invoking a function + +Next up we'll invoke the `hello` function from our service (this example function was automatically created when we +initially created our service). + +Run `serverless invoke --function hello --stage dev --region us-east-1` to tell Serverless that you want to run the function. + +The function get's invoked and you should see a message on your console. + +Great! We've just executed our first function from our Serverless service! diff --git a/docs/guide/removing-a-service.md b/docs/guide/removing-a-service.md new file mode 100644 index 000000000..bfd198094 --- /dev/null +++ b/docs/guide/removing-a-service.md @@ -0,0 +1,6 @@ +# Removing a service + +Let's remove our service entirely from our provider. This is pretty easy. Just run `serverless remove --stage dev +--region us-east-1` to remove everything. + +A prompt will inform you once everything is removed. diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md deleted file mode 100644 index fd5791948..000000000 --- a/docs/tutorials/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Tutorials - -This section provides different tutorials you can follow to build example services and explore what Serverless can be -used for and is capable of. diff --git a/docs/tutorials/adding-event-sources.md b/docs/tutorials/adding-event-sources.md deleted file mode 100644 index b628bfa69..000000000 --- a/docs/tutorials/adding-event-sources.md +++ /dev/null @@ -1,61 +0,0 @@ -# Adding event sources - -Serverless is used to build event driven architecture. Basically everything a function can trigger is an event. -Events could be HTTP requests, events fired from a cloud storage, scheduled events, etc. - -This tutorial will show you how you can add event sources to your Serverless service. - -We'll assume that you have Serverless v1.0 or greater installed on your machine. - -Our provider we use throughout the tutorial will be Amazon web services (AWS). - -**Note:** This tutorial will implement a schedule event for a function which is deployed to Amazon web services. -You can re-use this tutorial to add [other event sources](/docs/guide/event-sources.md) -(even from other providers) to your functions. - -## Scheduling a function - -Let's pretend we want to re-run our function every 10 minutes. One solution would be to open up the cloud provider dashboard -and run the function by hand but this is of course not the best way to solve our problem. - -You might be familiar with so called "Cron jobs" if you're a UNIX user. Cron jobs are a way to define reoccurring -tasks the operating system will trigger automatically (e.g. some sort of scripts that automates something for you). - -AWS has introduced a similar way we can automate the way our lambda function get's called. - -## Adding the schedule event source - -Let's add a schedule event source to a function in our Serverless service. - -Go to the Serverless service directory and open up the `serverless.yaml` file. Navigate to the function of your choice -where you want to add an event source. Add a new entry `events` inside the function. It should be on the same level as -the `handler` entry. - -After that add a `- schedule: rate(10 minutes)` entry inside the `events` definition. - -Not the content of your `serverless.yaml` file might look like this: - -```yaml -functions: - greet: - handler: handler.greet - events: - - schedule: rate(10 minutes) -``` - -That's it for the event addition. Next up we need to (re)deploy our service to enable our scheduled event. - -## (Re)deploying the Serverless service - -Run `serverless deploy` to (re)deploy the whole service. -Your function will be scheduled to run every 10 minutes once the deployment has finished. - -## Conclusion - -Event sources are a great way to extend the functionality of your functions. -They are pretty easy to setup. You simply need to add them to the corresponding function in your services `serverless.yaml` -file and (re)deploy the service. - -Serverless has implementations for different provider independent and provider specific event sources you can use. - -Curious what events are available? Here's a list with [all available events](/docs/guide/event-sources.md). diff --git a/docs/tutorials/your-first-service.md b/docs/tutorials/your-first-service.md deleted file mode 100644 index 6b7d4105f..000000000 --- a/docs/tutorials/your-first-service.md +++ /dev/null @@ -1,54 +0,0 @@ -# Your first service - -In this tutorial we'll create and use our very first Serverless service. -We'll create a new service, deploy it, invoke the first function and remove the whole service afterwards. - -Our provider we use throughout the tutorial will be Amazon web services (AWS). - -We'll assume that you have Serverless v1.0 or greater installed on your machine. - -Excited? Let's go. - -## Creating a new service - -`cd` into a directory of your choice and run `serverless create --name my-service --provider aws`. -Serverless will create a skeleton for your new Serverless service inside the `my-service` directory. - -Type `cd my-service` to navigate into the previously created directory. - -## Open the service inside an editor - -Open the directory with your favorite editor. You should see some files. One of those is the `serverless.yaml` file. -This file holds all the important information about your service. You should see e.g. a `functions` definition where -one function is defined. - -You don't have to understand what's going on here as we'll go into more details about this file in upcoming tutorials. - -## Deploying the service - -Let's deploy our service by typing `serverless deploy`. You should see a prompt which informs you once the corresponding -resources are deployed to AWS. - -## Invoking your function - -Next up we'll invoke the `hello` function from our service (this example function was automatically created when we -initially created our service). - -Run `serverless invoke --function hello --stage dev --region us-east-1` to tell Serverless that you want to run the function. - -The function get's invoked and you should see a message on your console. - -Great! We've just executed our first function from our Serverless service! - -## Removing the service - -Let's remove our service entirely from our provider. This is pretty easy. Just run `serverless remove --stage dev ---region us-east-1` to remove everything. - -A prompt will inform you once everything is removed. - -## Conclusion - -Congratulations, you've just created, deployed, invoked and removed your very first Serverless service! - -You're interested to learn more about Serverless? Visit the [tutorials section](/docs/tutorials) to see other tutorials! diff --git a/docs/understanding-serverless/README.md b/docs/understanding-serverless/README.md new file mode 100644 index 000000000..31a4dcaca --- /dev/null +++ b/docs/understanding-serverless/README.md @@ -0,0 +1,13 @@ +# Understanding Serverless + +Here we'll take a deep dive into the internals of Serverless and understand what a service is and how functions relate +to a service. + +Additionally we look at the Serverless key pieces of each service which are the `serverless.yaml` and +`serverless.env.yaml` files. + +## Table of contents + +- [Serverless services and functions](services-and-functions.md) +- [serverless.yaml](serverless-yaml.md) +- [serverless.env.yaml](serverless-env-yaml.md) diff --git a/docs/concepts/serverless-env-yaml.md b/docs/understanding-serverless/serverless-env-yaml.md similarity index 100% rename from docs/concepts/serverless-env-yaml.md rename to docs/understanding-serverless/serverless-env-yaml.md diff --git a/docs/concepts/serverless-yaml.md b/docs/understanding-serverless/serverless-yaml.md similarity index 100% rename from docs/concepts/serverless-yaml.md rename to docs/understanding-serverless/serverless-yaml.md diff --git a/docs/concepts/services.md b/docs/understanding-serverless/services-and-functions.md similarity index 100% rename from docs/concepts/services.md rename to docs/understanding-serverless/services-and-functions.md diff --git a/docs/using-plugins/README.md b/docs/using-plugins/README.md new file mode 100644 index 000000000..e9eca5469 --- /dev/null +++ b/docs/using-plugins/README.md @@ -0,0 +1,7 @@ +# Using plugins + +Learn how you can use custom plugins to extend Serverless functionality. + +## Table of contents + +- [Adding custom plugins](adding-custom-plugins.md) diff --git a/docs/using-plugins/adding-custom-plugins.md b/docs/using-plugins/adding-custom-plugins.md new file mode 100644 index 000000000..98805fb7f --- /dev/null +++ b/docs/using-plugins/adding-custom-plugins.md @@ -0,0 +1 @@ +# Adding custom plugins From 817234d4e8ed0c340bd120f9c2c389113e0239e1 Mon Sep 17 00:00:00 2001 From: Philipp Muens Date: Thu, 23 Jun 2016 15:24:52 +0200 Subject: [PATCH 2/2] Move list of plugins into own, separate file --- docs/README.md | 15 +-------------- docs/using-plugins/README.md | 4 +++- docs/using-plugins/core-plugins.md | 18 ++++++++++++++++++ 3 files changed, 22 insertions(+), 15 deletions(-) create mode 100644 docs/using-plugins/core-plugins.md diff --git a/docs/README.md b/docs/README.md index 43b1631f7..ffe471d45 100644 --- a/docs/README.md +++ b/docs/README.md @@ -43,20 +43,7 @@ You may also take a look at our [contributing guidelines](/CONTRIBUTING.md). - [Removing your service](guide/removing-a-service.md) - [Using plugins](using-plugins) - [How to use additional plugins in your service](using-plugins/adding-custom-plugins.md) - - Plugins provided by Serverless - - Core plugins - - [Create](/lib/plugins/create) - - [Deploy](/lib/plugins/deploy) - - [Invoke](/lib/plugins/invoke) - - [Remove](/lib/plugins/remove) - - Amazon Web Services - - [Compile Functions](/lib/plugins/aws/deploy/compile/functions) - - [Compile S3 Events](/lib/plugins/aws/deploy/compile/events/s3) - - [Compile Scheduled Events](/lib/plugins/aws/deploy/compile/events/schedule) - - [Compile Api Gateway Events](/lib/plugins/aws/deploy/compile/apiGateway) - - [Deploy](/lib/plugins/aws/deploy) - - [Invoke](/lib/plugins/aws/invoke) - - [Remove](/lib/plugins/aws/remove) + - [Plugins provided by Serverless](using-plugins/core-plugins.md) - [Building plugins](developing-plugins) - [How to build your own plugin](developing-plugins/building-plugins.md) - [How to build provider integration with your plugin](developing-plugins/building-provider-integrations.md) diff --git a/docs/using-plugins/README.md b/docs/using-plugins/README.md index e9eca5469..4b5e33ebd 100644 --- a/docs/using-plugins/README.md +++ b/docs/using-plugins/README.md @@ -1,7 +1,9 @@ # Using plugins -Learn how you can use custom plugins to extend Serverless functionality. +Learn how you can use plugins to extend Serverless functionality. +Furthermore see a list of core plugins Serverless provides. ## Table of contents - [Adding custom plugins](adding-custom-plugins.md) +- [Core plugins](core-plugins.md) diff --git a/docs/using-plugins/core-plugins.md b/docs/using-plugins/core-plugins.md new file mode 100644 index 000000000..6a70298a6 --- /dev/null +++ b/docs/using-plugins/core-plugins.md @@ -0,0 +1,18 @@ +# Core plugins + +This is a list of all plugins which ship with Serverless. Click on each plugin to read what it does, how it works and +see the corresponding source code. + +- Core plugins + - [Create](/lib/plugins/create) + - [Deploy](/lib/plugins/deploy) + - [Invoke](/lib/plugins/invoke) + - [Remove](/lib/plugins/remove) +- Amazon Web Services + - [Compile Functions](/lib/plugins/aws/deploy/compile/functions) + - [Compile S3 Events](/lib/plugins/aws/deploy/compile/events/s3) + - [Compile Scheduled Events](/lib/plugins/aws/deploy/compile/events/schedule) + - [Compile Api Gateway Events](/lib/plugins/aws/deploy/compile/apiGateway) + - [Deploy](/lib/plugins/aws/deploy) + - [Invoke](/lib/plugins/aws/invoke) + - [Remove](/lib/plugins/aws/remove)