SendGrid Documentation

This is a Gatsby site.

The develop branch is continuously deployed to a preview site. View dev site

The develop branch is merged to production weekly (unless we need to do a release sooner than that).

The master branch is continuously deployed to production.

Please, feel free to make any contributions you feel will make SendGrid Documentation better.

Submit all pull requests to the develop branch

Before your pull request can be merged into the develop branch, you must submit a completed CLA.

Table of Contents

• CLAs and CCLAs
• Local Setup
• About
• License

CLAs and CCLAs

Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) be filled out by every contributor to a SendGrid open source project.

Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions. The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when contributing. In this way, the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.

SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA. Copies of the CLA are available here.

Local Setup

Dependencies

• Required:
  • Git
  • RVM
  • Homebrew
  • npm
  • yarn
  • Gatsby

Setup Steps

• Install Git for:

  • Mac
  • Windows
  • Linux

• Install RVM

  $ \curl -sSL https://get.rvm.io | bash -s stable --ruby

• Install Homebrew (if you don't have it)

  $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

• Install or update npm

    `sudo apt-get update && sudo apt-get upgrade` // Optional
  

  $ brew install npm

Note: You may need to use 'sudo' before the command to get it to work as intended.

• Set your Node version

  $ npm install -g n

  $ n 8.4.0

• Download yarn

  $ brew install yarn

• Clone the repo

  $ git clone https://github.com/sendgrid/docs.git

• Go to your docs directory

  $ cd docs

• Switch to develop branch to make changes

  $ git checkout develop

• Install the Gatsby CLI

  $ npm install -g gatsby-cli

• Install npm package dependencies

  $ yarn install

• Build the local site

  $ gatsby develop Gatsby starts a hot-reloading development environment accessible at localhost:8000

About

SendGrid is guided and supported by the SendGrid Developer Experience Team. It is maintained and funded by SendGrid, Inc. The names and logos are trademarks of SendGrid, Inc.

License

SendGrid Documentation is licensed under the MIT License (MIT)