diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1dcaed86..54e7d32c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,13 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou - [CLAs and CCLAs](#cla) - [Roadmap & Milestones](#roadmap) -- [Feature Request](#feature_request) -- [Submit a Bug Report](#submit_a_bug_report) -- [Improvements to the Codebase](#improvements_to_the_codebase) -- [Understanding the Code Base](#understanding_the_codebase) +- [Feature Request](#feature-request) +- [Submit a Bug Report](#submit-a-bug-report) +- [Improvements to the Codebase](#improvements-to-the-codebase) +- [Understanding the Code Base](#understanding-the-codebase) - [Testing](#testing) -- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions) -- [Creating a Pull Request](#creating_a_pull_request) +- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions) +- [Creating a Pull Request](#creating-a-pull-request) We use [Milestones](https://github.com/sendgrid/sendgrid-ruby/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged. @@ -26,7 +26,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with There are a few ways to contribute, which we'll enumerate below: - + ## Feature Request If you'd like to make a feature request, please read this section. @@ -36,7 +36,7 @@ The GitHub issue tracker is the preferred channel for library feature requests, - Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests. - Please be respectful and considerate of others when commenting on issues - + ## Submit a Bug Report Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public. @@ -53,7 +53,7 @@ Before you decide to create a new issue, please try the following: In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-ruby/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting. - + ## Improvements to the Codebase We welcome direct contributions to the sendgrid-ruby code base. Thank you! @@ -113,7 +113,7 @@ Then run using: ruby example.rb ``` - + ## Understanding the Code Base **/examples** @@ -143,7 +143,7 @@ To run the tests: rake ``` - + ## Style Guidelines & Naming Conventions Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning. @@ -154,7 +154,8 @@ Please run your code through: - [rubocop](https://github.com/bbatsov/rubocop). -## Creating a Pull Request + +## Creating a Pull Request 1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes: diff --git a/README.md b/README.md index 2f4843d0..b236785d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ We appreciate your continued support, thank you! # Table of Contents * [Installation](#installation) -* [Quick Start](#quick_start) +* [Quick Start](#quick-start) * [Processing Inbound Email](#inbound) * [Usage](#usage) * [Use Cases](#use_cases) @@ -68,7 +68,7 @@ gem install sendgrid-ruby - [Ruby-HTTP-Client](https://github.com/sendgrid/ruby-http-client) - [Sinatra](http://www.sinatrarb.com/) - this is only needed if you plan to process [Inbound Email](#inbound). - + # Quick Start ## Hello Email diff --git a/USAGE.md b/USAGE.md index 7cde51d9..f4cbc2aa 100644 --- a/USAGE.md +++ b/USAGE.md @@ -11,9 +11,9 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) # Table of Contents -* [ACCESS SETTINGS](#access_settings) +* [ACCESS SETTINGS](#access-settings) * [ALERTS](#alerts) -* [API KEYS](#api_keys) +* [API KEYS](#api-keys) * [ASM](#asm) * [BROWSERS](#browsers) * [CAMPAIGNS](#campaigns) @@ -24,21 +24,21 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) * [GEO](#geo) * [IPS](#ips) * [MAIL](#mail) -* [MAIL SETTINGS](#mail_settings) -* [MAILBOX PROVIDERS](#mailbox_providers) -* [PARTNER SETTINGS](#partner_settings) +* [MAIL SETTINGS](#mail-settings) +* [MAILBOX PROVIDERS](#mailbox-providers) +* [PARTNER SETTINGS](#partner-settings) * [SCOPES](#scopes) * [SENDERS](#senders) * [STATS](#stats) * [SUBUSERS](#subusers) * [SUPPRESSION](#suppression) * [TEMPLATES](#templates) -* [TRACKING SETTINGS](#tracking_settings) +* [TRACKING SETTINGS](#tracking-settings) * [USER](#user) * [WHITELABEL](#whitelabel) - + # ACCESS SETTINGS ## Retrieve all recent access attempts @@ -283,7 +283,7 @@ puts response.status_code puts response.body puts response.headers ``` - + # API KEYS ## Create API keys @@ -2249,7 +2249,7 @@ puts response.status_code puts response.body puts response.headers ``` - + # MAIL SETTINGS ## Retrieve all mail settings @@ -2619,7 +2619,7 @@ puts response.status_code puts response.body puts response.headers ``` - + # MAILBOX PROVIDERS ## Retrieve email statistics by mailbox provider. @@ -2640,7 +2640,7 @@ puts response.status_code puts response.body puts response.headers ``` - + # PARTNER SETTINGS ## Returns a list of all partner settings. @@ -3751,7 +3751,7 @@ puts response.status_code puts response.body puts response.headers ``` - + # TRACKING SETTINGS ## Retrieve Tracking Settings @@ -5033,4 +5033,3 @@ puts response.status_code puts response.body puts response.headers ``` - diff --git a/USE_CASES.md b/USE_CASES.md index 404c23c7..562fd38a 100644 --- a/USE_CASES.md +++ b/USE_CASES.md @@ -2,11 +2,11 @@ This documentation provides examples for specific use cases. Please [open an iss # Table of Contents -* [Transactional Templates](#transactional_templates) -* [How to Setup a Domain Whitelabel](#domain_whitelabel) -* [How to View Email Statistics](#email_statistics) +* [Transactional Templates](#transactional-templates) +* [How to Setup a Domain Whitelabel](#domain-whitelabel) +* [How to View Email Statistics](#email-statistics) - + # Transactional Templates For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing. @@ -114,16 +114,16 @@ puts response.body puts response.headers ``` - + # How to Setup a Domain Whitelabel You can find documentation for how to setup a domain whitelabel via the UI [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/setup_domain_whitelabel.html) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#whitelabel). Find more information about all of SendGrid's whitelabeling related documentation [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/index.html). - + # How to View Email Statistics You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#stats). -Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as SendGrid processes your email. \ No newline at end of file +Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as SendGrid processes your email.