Content Contribution: Serverless Framework

[rupakg]

Description

Add content to the Toolsets/Framework/Serverless Framework section of the guide.

Filename: /guide/source/toolsets/frameworks/serverless.md

Page/Section: Toolsets/Framework/Serverless

Contributing Author/Company: Eslam Hefnawy (Serverless)

Details:

Some suggested ideas and guidance for content in this section:

Note: The content should not feel like the documentation already out there but should tell a story around the concepts. Examples are good but are only required to support an argument. A person who is new to serverless should be able to read this and get excited about using the framework and serverless technologies in general. At the end of reading this, they should get an overall picture what they are getting out of using the framework with respect to the challenges one faces when they start with serverless.

The Serverless Framework

• Introduction (general overview)
• What are the challenges that a dev faces, starting off with just the provider tools?
• Why is there a need for the framework?
• What problems does it solve?
• How did it bring the community together? (contributors, thought leadership)
• Language and runtime support
• Talk about some features that solve the biggest issues for the developer:
  • serverless.yml (mapping of service to a provider to functions to handlers to events at one place)
  • Variable system
  • Packaging (exclude dev dependencies etc.)
  • Deployment (CF for AWS, how we do for other providers?)
  • Auto-generation of IAM roles
  • Multi-provider support (vendor lock-in)
  • Login
  • Versioning
  • Rollback
• Plugin system
  • Introduction (overview)
  • what problems does it solve? - extensibility, community involvement etc.
  • Life-cycle events (diagram of the flow)
• Example of use cases that the framework makes it easy to develop
• Future Plans
• Resources
  • Link to various framework docs

[pmuens]

Just dropping the notes @rupakg and I took while talking about the guide and this specific chapter.

• Goal: See the value of Serverless (for beginners, managers and C-Level)

• The Framework helps applying best practices

• Tooling for Microservices does not fit well —> Therefore the Framework

• Providers have their own tooling at the provider level

  • Too much to lern on a provider level —> No abstraction / generalization (learning is the same when you use the Framework since best practices are already in place)

• What is the differentiator of the Serverless Framework?

• Show examples and use cases so that it’s visible how the Serverless Framework can be used to solve the problems

• Toolset

  • Introduction in Toolset
    • Talk about all the different tools you use when working in a Serverless architecture
    • Talk about whole story (end-to-end)
    • „If you need X then use the Serverless Framework“
    • „If you need Y then you Apex“ etc.
  • Why the Serverless Framework?
    • What is the differentiators?
      • Go into detail here (e.g. abstractions on a high-level)
  • How does the Serverless Framework work?
    • Start with a diagram
      • Shows all the pieces of the Framework
    • Don’t make it too technical

/cc @eahefnawy

[eahefnawy]

Thanks @pmuens just deleted a duplicate comment 😊

[pmuens]

Thanks @pmuens just deleted a duplicate comment 😊

Thanks @eahefnawy 👍 😊

Maybe we could take a quick call with @rupakg soon (the upcoming week or smth.) to discuss how we can help and proceed here.

[rupakg]

@pmuens @eahefnawy Had a good overall discussion with you about the content for this section. If you have any questions, feel free to ping me or add it here.

For next steps, let's get a draft outline for the content that we can review together.

[pmuens]

@pmuens @eahefnawy Had a good overall discussion with you about the content for this section. If you have any questions, feel free to ping me or add it here.

Thanks @rupakg! Yes, now I have a better understanding what this chapter should cover 👍

For next steps, let's get a draft outline for the content that we can review together.

That sounds good. I'd propose to open up a PR which adds the rough skeleton for this chapter. Next up we could fill it with bullet points about the content and discuss it in the PR.

[rupakg]

@pmuens @eahefnawy Any chance you can do an initial PR this week? I would really appreciate that.

[pmuens]

@pmuens @eahefnawy Any chance you can do an initial PR this week? I would really appreciate that.

@rupakg sure thing 👍 It's on my list of todays todos! I'll PR smth. throughout the day.

[pmuens]

Hey @rupakg 👋

Just PRed the very first version (filled out some bullet points). Nothing super exciting right now, but at least a start 😬!

/cc @eahefnawy