The source code for our SendGrid Knowledge Center
Clone or download
Latest commit 66c8f13 Jan 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Merge pull request #4187 from PyroclasticMayhem/develop Oct 26, 2018
.vscode Fixed Formatting of JSON Oct 9, 2018
content/docs fixing release note type Jan 18, 2019
data examples page Dec 3, 2018
plugins examples page Dec 3, 2018
src Merge pull request #4894 from sendgrid/date Jan 17, 2019
static Merge branch 'develop' into master Jan 2, 2019
travis updating the deploy Oct 3, 2018
.babelrc First commit 💥 Apr 10, 2018
.browserslistrc First commit 💥 Apr 10, 2018
.eslintignore First commit 💥 Apr 10, 2018
.eslintrc.json tabbed code MD component May 18, 2018
.gitignore Add yarn.lock Jul 17, 2018
.prettierrc First commit 💥 Apr 10, 2018
.stylelintrc Footer, switftype & linting Apr 23, 2018
.travis.yml updating the deploy Oct 3, 2018
CODE_OF_CONDUCT.md 📝 (Repo Wide) Ensure Oxford Comma usage Oct 8, 2018
CONTRIBUTING.md CONTRIBUTING.md : Add file Nov 1, 2018
README.md Update README.md Nov 1, 2018
first-timers-tr.md Create first-timers-tr.md Oct 23, 2018
first-timers.md 📝 (Repo Wide) Removing 2 spaces after periods Oct 8, 2018
gatsby-browser.js remark code in HTML Jul 27, 2018
gatsby-config.js remove GA plugin. Jan 14, 2019
gatsby-node.js remove redirects Aug 21, 2018
jsconfig.json First commit 💥 Apr 10, 2018
license updated year in the license file Oct 5, 2018
package.json removing old version of segment Aug 29, 2018
redirects.js adding in redirects reported today in the docs room Aug 23, 2018
styleguide.md adding Automation as a group, updating styleguide headmatter section Nov 16, 2018
yarn.lock cleanup no longer valid favicon symlink & USAGE.md Oct 10, 2018

README.md

SendGrid Logo

SendGrid Documentation

Build Status Twitter Follow MIT licensed

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

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

Setup Steps

  • Install Git for:

  • 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)