Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More SEO Friendly Section links #504

Merged
merged 1 commit into from Oct 22, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<a name="roadmap"></a>
We use [Milestones](https://github.com/sendgrid/sendgrid-php/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.
Expand All @@ -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:

<a name="feature_request"></a>
<a name="feature-request"></a>
## Feature Request

If you'd like to make a feature request, please read this section.
Expand All @@ -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

<a name="submit_a_bug_report"></a>
<a name="submit-a-bug-report"></a>
## Submit a Bug Report

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
Expand All @@ -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-php/blob/master/.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.

<a name="improvements_to_the_codebase"></a>
<a name="improvements-to-the-codebase"></a>
## Improvements to the Codebase

We welcome direct contributions to the sendgrid-php code base. Thank you!
Expand Down Expand Up @@ -92,7 +92,7 @@ See the [examples folder](https://github.com/sendgrid/sendgrid-php/tree/master/e

If you are using composer, replace <PATH_TO> with the path to your `vendor/autoload.php`. Otherwise, include lib/loader.php.

<a name="understanding_the_codebase"></a>
<a name="understanding-the-codebase"></a>
## Understanding the Code Base

**/examples**
Expand Down Expand Up @@ -126,7 +126,7 @@ cd test/unit
../../vendor/bin/phpunit . --bootstrap bootstrap.php --filter test*
```

<a name="style_guidelines_and_naming_conventions"></a>
<a name="style-guidelines-and-naming-conventions"></a>
## 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.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ We appreciate your continued support, thank you!
# Table of Contents

* [Installation](#installation)
* [Quick Start](#quick_start)
* [Quick Start](#quick-start)
* [Usage](#usage)
* [Use Cases](#use_cases)
* [Use Cases](#use-cases)
* [Announcements](#announcements)
* [Roadmap](#roadmap)
* [How to Contribute](#contribute)
Expand Down Expand Up @@ -70,7 +70,7 @@ Previous versions of the library can be found in the [version index](https://sen
- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-php)
- [php-HTTP-Client](https://github.com/sendgrid/php-http-client)

<a name="quick_start"></a>
<a name="quick-start"></a>
# Quick Start

## Hello Email
Expand Down Expand Up @@ -195,7 +195,7 @@ print $response->body();
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-php/tree/master/lib/helpers/mail/README.md) - build a request object payload for a v3 /mail/send API call.

<a name="use_cases"></a>
<a name="use-cases"></a>
# Use Cases

[Examples of common API use cases](https://github.com/sendgrid/sendgrid-php/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
Expand Down
24 changes: 12 additions & 12 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ $sg = new \SendGrid($apiKey);

# 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)
Expand All @@ -26,21 +26,21 @@ $sg = new \SendGrid($apiKey);
* [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)


<a name="access_settings"></a>
<a name="access-settings"></a>
# ACCESS SETTINGS

## Retrieve all recent access attempts
Expand Down Expand Up @@ -285,7 +285,7 @@ echo $response->statusCode();
echo $response->body();
print_r($response->headers());
```
<a name="api_keys"></a>
<a name="api-keys"></a>
# API KEYS

## Create API keys
Expand Down Expand Up @@ -2251,7 +2251,7 @@ echo $response->statusCode();
echo $response->body();
print_r($response->headers());
```
<a name="mail_settings"></a>
<a name="mail-settings"></a>
# MAIL SETTINGS

## Retrieve all mail settings
Expand Down Expand Up @@ -2621,7 +2621,7 @@ echo $response->statusCode();
echo $response->body();
print_r($response->headers());
```
<a name="mailbox_providers"></a>
<a name="mailbox-providers"></a>
# MAILBOX PROVIDERS

## Retrieve email statistics by mailbox provider.
Expand All @@ -2642,7 +2642,7 @@ echo $response->statusCode();
echo $response->body();
print_r($response->headers());
```
<a name="partner_settings"></a>
<a name="partner-settings"></a>
# PARTNER SETTINGS

## Returns a list of all partner settings.
Expand Down Expand Up @@ -3753,7 +3753,7 @@ echo $response->statusCode();
echo $response->body();
print_r($response->headers());
```
<a name="tracking_settings"></a>
<a name="tracking-settings"></a>
# TRACKING SETTINGS

## Retrieve Tracking Settings
Expand Down
12 changes: 6 additions & 6 deletions USE_CASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ This documentation provides examples for specific use cases. Please [open an iss

# Table of Contents
* [Attachments](#attachments)
* [Transactional Templates](#transactional_templates)
* [How to Setup a Domain Whitelabel](#domain_whitelabel)
* [How to View Email Statistics](#email_stats)
* [Transactional Templates](#transactional-templates)
* [How to Setup a Domain Whitelabel](#domain-whitelabel)
* [How to View Email Statistics](#email-stats)

<a name="attachments"></a>
# Attachments
Expand Down Expand Up @@ -46,7 +46,7 @@ echo $response->body();
?>
```

<a name="transactional_templates"></a>
<a name="transactional-templates"></a>
# 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.
Expand Down Expand Up @@ -169,14 +169,14 @@ echo $response->body();
print_r($response->headers());
```

<a name="domain_whitelabel"></a>
<a name="domain-whitelabel"></a>
# 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-php/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).

<a name="email_stats"></a>
<a name="email-stats"></a>
# 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-php/blob/master/USAGE.md#stats).
Expand Down