serverless / guide Goto Github PK
View Code? Open in Web Editor NEWServerless Guide - An open-source definitive guide to serverless architectures.
Home Page: https://serverless.github.io/guide/
Serverless Guide - An open-source definitive guide to serverless architectures.
Home Page: https://serverless.github.io/guide/
Add content to the Toolsets/Frameworks/Chalice Framework section of the guide.
Filename: /guide/source/toolsets/frameworks/chalice.md
Page/Section: Toolsets/Frameworks/Chalice
Contributing Author/Company: [full name] (company)
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, features etc. 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.
Add content to the Architecture -> The Serverless Architecture
section of the guide.
Filename: /guide/source/architecture/README.md
Page/Section: Architecture -> The Serverless Architecture
Contributing Author: [full name] (company)
Details:
More holistic view of serverless architectures in light of events.
Link to presentation when I cover some of the stuff from here: https://speakerdeck.com/mthenw/the-state-of-serverless-1
Discussion around content for the Architecture section of the guide.
Details:
Some suggested ideas and guidance for content in this section:
Add content to the Development/Project Structure section of the guide.
Filename: /guide/source/dev/project_structure.md
Page/Section: Development/Project Structure
Details:
Some suggested ideas and guidance for content in this section:
Add content to the Toolsets/Framework/Apex Framework section of the guide.
Filename: /guide/source/toolsets/frameworks/apex.md
Page/Section: Toolsets/Framework/Apex
Contributing Author/Company: full name (company)
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, features etc. 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.
Add content to the Architecture -> Patterns for Partitioning Code
sub-section of the guide.
Filename: /guide/source/architecture/README.md
Page/Sub-Section: Architecture -> Patterns for Partitioning Code
Contributing Author: Eslam Hefnawy (Serverless Inc.)
Details:
Adapt from @eahefnawy post Serverless Code Patterns but without Serverless Framework specific examples. Make examples into diagrams showing partitioning.
The pages have been divided up into separate sub-pages to make it easier for multiple authors to work on different sections of the guide at the same time. Also, added some seed content to provide guidance for intended content.
Filename: Various
Page/Section: Various
Details:
Add content to the Architecture -> The Serverless Architectural Pattern
section of the guide.
Filename: /guide/source/architecture/serverless_arch_pattern.md
Page/Sub-Section: Architecture -> The Serverless Architectural Pattern
Contributing Author: Rupak Ganguly (Serverless Inc.)
Details:
Link to presentation when I cover some of the stuff from here: https://speakerdeck.com/mthenw/the-state-of-serverless-1
Update the content for the Google Cloud Functions provider section.
Filename: ./source/providers/gcf.md
Page/Section: Providers:Google Cloud Functions
Details: Added content describing the attributes for the Google Cloud Functions serverless provider. The following sub-sections were added:
Add content to the Operations section of the guide.
Filename: /guide/source/ops/README.md
Page/Section: Operations
Details:
Some suggested ideas and guidance for content in this section:
Feel free to add/modify the sub-sections.
Add content to the Adoption section of the guide.
Filename: /guide/source/adption/README.md
Page/Section: Adoption
Contributing Author/Company: Eric Motazedi (Accenture)
Details:
Some suggested ideas and guidance for content in this section:
Tell the story about adoption of serverless in the enterprises
Add content to the main Development intro section.
Filename: ./source/dev/README.md
Page/Section: Development
Details: The content will cover:
Add content to the Development/Testing section of the guide.
Filename: /guide/source/dev/testing.md
Page/Section: Development/Testing
Contributing Author/Company: Ben Kehoe (iRobot)
Details:
Some suggested ideas and guidance for content in this section:
[Brief intro into unit testing and integration testing]
Adapt from [https://serverless.zone/unit-and-integration-testing-for-lambda-fc9510963003]
Adapt from [https://serverless.zone/monkeyless-chaos-integration-testing-for-serverless-architectures-9d1a4208c3ca]
Add content to the Development/Pathway to Serverless Development section of the guide.
Filename: /guide/source/dev/pathway_to_sls.md
Page/Section: Development/Pathway to Serverless Development
Contributing Author/Company: Jared Short (Trek10)
Details:
Some suggested ideas and guidance for content in this section:
Tell the story around how to get involved and get thinking on introducing serverless technologies into the organizations. Cutting through the hype and misconceptions, use personal experiences to contrast advantages and challenges.
I want to translate this guide into Chinese, how can I contribute to this project?
To ensure the reading experience remains consistent and high-quality as this project scales, I recommend creating a vocabulary section in the beginning. One of the requirements for contributing should be sticking to the declared vocabulary.
Example:
Add guidelines to make it easy for people to contribute.
Add content to the Case Studies section of the guide.
Filename: /guide/source/case_studies/README.md
Page/Section: Case Studies
Details:
Some suggested ideas around use cases that would make good case studies:
Add content for the Development: Pathway to Serverless Development section.
Filename: ./source/dev/README.md
Page/Section: Development: Pathway to Serverless Development
Details: Add content that describes the pathway to developing serverless applications. It will cover the following topics:
hello-world
app. using the Serverless Frameworkhello-world
app.Create a section for Providers -> OpenFaaS
under the Opensource Platforms.
Filename: /guide/source/providers/openfaas.md
Page/Section: Providers -> OpenFaaS
Contributing Author: [full name] (company)
Details:
Add how to add python library dependencies, e.g. psycopg2.
Page/Section: Python
Currently this is confusing, https://serverlesscode.com/post/python-on-serverless-intro/ says "Serverless recommends using the created-by-default vendored/ directory and a component-level requirements.txt file" while aws-python3 template has no "vendored" directory, and I don't know what "component" means (a service?)
Also, is package: include:
in serverless.yml required ?
Also how to handle binary/compiled dependencies like psycopg2.
Add content to the Development/Deployment section of the guide.
Filename: /guide/source/dev/deployment.md
Page/Section: Development/Deployment
Details:
Some suggested ideas and guidance for content in this section:
The current Providers section mixes commercial Serverless platforms with the opensource platforms like OpenWhisk, Kubeless, OpenFaaS etc.
Filename: /guide/source/providers/README.md
Page/Section: Providers -> Opensource Platforms
Contributing Author: Rupak Ganguly (Serverless Inc.)
Details:
Talk about the differences between Serverless and PaaS, by comparing and contrasting tenets of each.
Filename: /guide/source/introduction.md
Page/Section: Introduction -> Serverless vs. PaaS
Contributing Author: (company)
Details:
Add content to the Development/Debugging section of the guide.
Filename: /guide/source/dev/debugging.md
Page/Section: Development/Debugging
Details:
Some suggested ideas and guidance for content in this section:
AWS Lambda now supports Go along with Node.js, Java, C#, Go and Python.
Filename:providers/README.md
Page/Section:A Comparative Look
Contributing Author: Pavan Yara(@yarapavan)
Details:
Talk about the driving factors and benefits of Serverless
Filename: /guide/source/introduction.md
Page/Section: Introduction -> Driving Factors/Benefits of Serverless
Contributing Author: (company)
Details:
Add content to the Architecture -> Introduction section of the guide.
Filename: /guide/source/architecture/README.md
Page/Section: Architecture
Contributing Author: Rupak Ganguly (Serverless Inc.)
Details:
(introduction page, a look back)
can we move this switch so that the experience of navigating the repo is better?
Add content to the Security section of the guide.
Filename: /guide/source/security/README.md
Page/Section: Security
Contributing Author: Shaked Zin (PureSec)
Details:
Some suggested ideas and guidance for content in this section:
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.
Add a section for Providers -> Kubeless
Filename: /guide/source/providers/kubeless.md
Page/Section: Providers -> Kubeless
Contributing Author: Sebastien Goasguen (Bitnami)
Details:
Filename: ./source/introduction.md
Page/Section:
Details: The content will cover:
Add content to the Toolsets section of the guide.
Filename: /guide/source/toolsets/README.md
Page/Section: Toolsets
Details:
Some suggested ideas and guidance for content in this section:
Add content to the Toolsets/Frameworks/Chalice Framework section of the guide.
Filename: /guide/source/toolsets/frameworks/sam.md
Page/Section: Toolsets/Frameworks/Serverless Application Model (SAM)
Contributing Author/Company: [full name] (company)
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, features etc. 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.
not sure where this should go so submitting the text here in the issue.
Just like wireless internet has wires somewhere, serverless architectures still have servers somewhere. What makes something serverless is, that as a developer you don’t have to worry or think about those servers. You can just focus on code.
There are 4 core tenets you should know about:
Zero Administration
This is the most exciting thing about serverless. Whereas previous abstractions like VMs and containers still shared a lot of the same configuration and administration properties of servers, serverless is a completely different experience. When you're ready to deploy code, you don't have to provision anything beforehand, or manage anything afterward. There is no concept of a fleet, an instance, or even an operating system. Everything runs in the cloud and the provider manages scaling for you.
Pay-per-execution
This is what typically incentivizes developers to try serverless for the first time. It’s alluring to have complete resource utilization without paying a cent for idle time. This tenet alone results in over 90% cost-savings over a cloud VM and immeasurable developer satisfaction in knowing that you never have to pay for resources that you don’t use.
Function as unit of deployment
Serverless architectures are composed of very small, independent bits of code (functions) that are loosely coupled and collaborative—also known as a microservice architecture. The main advantage? Pieces of the system are contained. They can be developed and deployed independently. The result is fewer blockers and far greater developer autonomy and productivity.
Event-Driven
This aspect of serverless is the most under-the-radar right now, but is shaping up to be the most important in the long-term. Serverless functions are stateless, and essentially dormant, until they have an event to react to. The event is what brings them to life and provides them with the data/context to do their job. Event-driven architectures are nothing new, but the rise of serverless compute has renewed interest in them because serverless architectures are by definition event-driven.
Update the content for the IBM OpenWhisk provider section.
Filename: ./source/providers/openwhisk.md
Page/Section: Providers:IBM OpenWhisk
Details: Added content describing the attributes for the IBM OpenWhisk serverless provider. The following sub-sections were added:
Add content to the Development/Culture section of the guide.
Filename: /guide/source/dev/culture.md
Page/Section: Development/Culture
Details:
Some suggested ideas and guidance for content in this section:
Add content to the Development/Examples section of the guide.
Filename: /guide/source/dev/examples.md
Page/Section: Development/Examples
Details:
Some suggested ideas and guidance for content in this section:
Add a new provider under Providers -> IBM Cloud Functions
Filename: /guide/source/providers/ibmcf.md
Page/Section: Providers -> IBM Cloud Functions
Contributing Author: James Thomas (IBM)
Details:
Add a new provider under Providers -> SpotInst Functions
Filename: /guide/source/providers/spotinst-functions.md
Page/Section: Providers -> SpotInst Functions
Contributing Author: Will ask in SpotInst Slack channel
Details:
Add content for the Development: Project Structure section.
Filename: ./source/dev/README.md
Page/Section: Development: Project Structure
Details: Add content that describes the project structure for a serverless application. It will cover the following topics:
hello-world
application using the hello-world
templateserverless.yml
file and its sectionsAdd content to the Introduction section of the guide.
Filename: /guide/source/introduction.md
Page/Section: Introduction
Details:
Some suggested ideas and guidance for content in this section:
Completed
Moved to issue #51
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.