Skip to content

Latest commit

 

History

History
146 lines (88 loc) · 7.75 KB

CONTRIBUTING.md

File metadata and controls

146 lines (88 loc) · 7.75 KB
Raw

Contributing

Thank you for considering to contribute. Here is what SST Guide is trying to accomplish and how you can help. We use Discord for our contributors, feel free to join us there.

Project Goals

We are trying to create a really comprehensive and up to date guide to help people build production ready full-stack serverless applications. To start, we are focussing on building a CRUD API backend with Serverless Framework on AWS and a single-page app web frontend using React.

We want SST Guide to cover a very broad collection of technologies, services, and concepts that gives people the confidence to use this guide to build their next project. Too often we come across tutorials or blog posts that sound very promising but leave us hanging once we get to the complicated bits.

However while we want to be as comprehensive as possible, we also want to make sure that you can get started easily. To achieve this we are using the following structure and layout.

Project Structure

The guide is split up in the following way:

The Basics:

  • The basic aspects of creating a full-stack serverless app. And deploying your app to production.

Best Practices:

  • Everything you need to run your app in production.

The Extensions

  • Extra Credits: Standalone chapters/articles intended to supplement the first two parts and to extend some functionality of the demo app.

Additionally, the demo app that people build as a part of the tutorial is split into the backend (a Serverless Framework project) and the frontend (a React app). Both these are in their separate Git repos.

Key chapters in the Core part of the guide are accompanied with branches in their respective demo app repos. This is used to track progress and as a reference as you work through the tutorial.

How to Help

There are quite a few ways to help.

Additionally, you are welcome to provide general feedback and suggestions via our forums.

Keep the core guide updated

The SST Guide is reliant on a large number of services and open source libraries and projects. Here is what needs updating:

Updating Screenshots

We want to keep the screenshots as consistent as possible to reduce any source of confusion. Here are some guidelines on taking a new screenshot.

  • Use Safari with a window size of 1280x778 (or similar ratio).
  • Mock any account details or private info on the screen using Safari's dev tools.
  • Don't have any tabs or extra toolbars. Try to use the default Safari chrome. Here is an example.
  • Take a screenshot of the browser window with the CMD+SHIFT+4 SPACE command.
  • Use the Preview app to add pointers for input fields or buttons that need to be highlighted. Here are the specific settings used.

Updating dependencies

To update the dependencies for one of the demo apps (backend or frontend):

  • Find the chapter (with a demo repo sample and branch) where the dependency is first introduced
  • Update the dependency in that branch and test it
  • Update the dependency in all the branches that follow including master
  • Submit PRs for all the branches that have been updated

For the steps in the tutorial:

  • Make any necessary changes and submit a PR

Once all the PRs are merged, we'll tag the repo (tutorial & demo app) with the new version number and update the Changelog chapter.

Add an Extra Credit Chapter

The core chapters are missing some extra details (for the sake of simplicity) that are necessary once you start customizing SST setup. Additionally, there are cases that we just don't handle in the core chapters. Here is a rough list of topics that have been requested. This is not an exhaustive list. If you have some ideas to extend some of the demo app functionality, feel free to get in touch with us. Here is how to go about adding a new extra credit chapter:

  • Let us know via Discord that you are planning to work on it
  • Create a new issue in GitHub to track progress
  • Fork the tutorial repo
  • Copy the _drafts/template.md as a starting point for the chapter
  • Move the new chapter(s) to _chapters/new-chapter-name.md
  • Make sure to use a descriptive name for the chapter title and URL
  • Add the title and URL to _data/chapterlist.yml under the Extra Credit section
  • For any screenshots, create a new directory under assets/new-chapter-name/ and add them there
  • The Next and Previous buttons for navigating chapters are based on the date: field in the chapter's front matter. The date needs to be larger than the chapter it comes after and lesser than the one it comes before.
  • Update the front matter's bio field information about you (the author)

For any changes to the demo app:

  • Fork the repo for the demo app and make the changes
  • Update the README to reflect that this is an extension to the tutorial demo app
  • Reference the new forked repo in the chapter

Finally, submit a PR to the tutorial repo with the new changes. We'll review it, maybe suggest some edits or give you some feedback. Once everything looks okay we'll merge with master and publish it. We'll also create comments threads for your chapter in the forums and link to it.

Improve Tooling

Currently we do a lot of manual work to publish updates and maintain the tutorial. You can help by contributing to improve the process. Feel free to get in touch if you're interested in helping out. Here is roughly what we need help with:

  • Compress screenshots

    The images for the screenshots are quite large. It would be ideal if they can be compressed as a part of the build process.

  • Generating the Ebook

  • Creating a pipeline

Translating to Other Languages

We currently have translation efforts for Spanish and Portuguese underway. If you'd like to get involved refer to this thread.

To translate a chapter follow these steps:

  1. Add the following to the frontmatter of the chapter you intend to translate.

    ref: uri-of-the-chapter
lang: en

    Here uri-of-the-chapter is the part of the url that represents the name of the chapter. For example, the What is Serverless has a URI what-is-serverless.

  2. Copy the file to _chapters/[language-code]/[filename].md

    Here the language-code is either pt or es. And the filename is up to you. It does not need to be the same as the English one.

  3. Change the frontmatter to.

    lang: language-code

    Again the language-code is either pt or es.

Note that the only thing linking the translation with the original is the ref: attribute in the frontmatter. Make sure that it is the same for both the files.

As an example, compare the What is Serverless chapter:

Feel free to contact us if you have any questions.