Overview:

The SendGrid Documentation repository contains instructions for contributing to the SendGrid documentation website, built with Gatsby. The repository includes information on setting up dependencies and the local repository to make contributions. The project is continuously deployed to production, and contributors are encouraged to submit pull requests to the develop branch.

Features:

Local Dependency Setup: Instructions for setting up dependencies on Mac, Windows, and Linux
Local Repository Setup: Guidelines for cloning the repository, switching branches, and building the local site
Continuous Deployment: The main branch is continuously deployed to production to maintain the latest changes
Contributions: Contributors are encouraged to submit pull requests to the develop branch
Open Source License: All contributions are made under the MIT License
Developer Experience Team: The project is guided and supported by the SendGrid Developer Experience Team
Familiarize with Styleguide: Contributors are advised to familiarize themselves with the project's styleguide

Local Dependency Setup:

Mac:

Install Git for Mac using Homebrew: brew install git
Set your Node.js version to 12
Install npm

Windows:

Install Git for Windows
Install Node.js and npm, using the installer from Node.js website
Use Node.js version 12, the current LTS version

Linux:

Install Git for Linux
Install Node.js and npm appropriate for your Linux distribution. Refer to Node.js website
Use Node.js version 12, the current LTS version

Local Respository Setup:

Clone the SendGrid Docs Repo using SSH or HTTPS
Switch to the develop branch
Install the Gatsby CLI globally: npm install -g gatsby-cli
Install npm package dependencies
Build the local site:
- Run gatsby develop or npm run develop
- Access the development environment at localhost:8000

Summary:

The SendGrid Documentation repository provides detailed instructions for setting up dependencies and the local repository to contribute to the SendGrid documentation website. Contributors are encouraged to submit pull requests to the develop branch, familiarize themselves with the styleguide, and adhere to the MIT License for all contributions. The project is continuously deployed to production, and maintained by the SendGrid Developer Experience Team.

Sendgrid

Docs

Eventkit Rails