sendgrid / docs

Repository of Twilio SendGrid's product documentation.

THIS REPOSITORY WILL NO LONGER BE MONITORED AFTER JUNE 15, 2021

SendGrid Documentation

Introduction

This is a Gatsby site.

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

The main branch is continuously deployed to production.

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

  • Familiarize yourself with our Styleguide

• Submit all pull requests to the develop branch

• All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

  • When making contributions, be sure to place an "x" in the brackets of the PR description where it says "[ ] I acknowledge that all my contributions will be made under the project's license."

Table of Contents

• Local Dependency Setup
  • Mac
  • Windows
  • Linux
• Local Repository Setup
• About
• License

Local Dependency Setup

Dependencies

• Required:
  • Git
  • npm
  • Gatsby

Note: Dependencies differ for work on the old-develop branch. If you need to work on old-develop, please see the README file after checking out that branch. This is uncommon.

Setup Steps

Mac

• Install Git
  • Git for Mac

We recommend using Homebrew to install and manage packages on a MacOS.

• Install Homebrew:

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

• Install npm:

  $ brew install npm

• Set your Node.js version to 12

  $ npm install -g n
  
  $ n 12.16.1

Windows

• Install Git

  • Git for Windows

• Install npm

  • To install Node.js and npm on Windows, you can download the installer here:
    • https://nodejs.org/en/#home-downloadhead
  • Use Node.js version 12, the current Long Term Support (LTS) version.

Linux

• Install Git:

  • Git for Linux

• Install npm:

  • To install Node.js and npm on Linux, select the package and instillation appropriate for your Linux distribution. You can find help here:
    • https://nodejs.org/en/download/package-manager/
  • Use Node.js version 12, the current Long Term Support (LTS) version.

Local Repository Setup

Note: When working on Windows, you may need to run Command Prompt or PowerShell as an Administrator.

Note: When working on Mac or Linux, you may need to run some commands using "sudo."

• Clone the SendGrid Docs Repo

  • SSH:

    $ git clone [e-mail]:sendgrid/docs.git

  • HTTPS:

    $ 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

  $ npm ci

• Build the local site

  • With the Gatsby CLI installed globally, you can run:

    $ gatsby develop

  • Alternatively, you can run:

    $ npm run develop

  • Either of the above commands should start 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)