Skip to content

Commit 009fed1

Browse files
author
Matt Bernier
authored
Merge pull request #294 from pushkyn/seo-friendly-section-links
More SEO Friendly Section links
2 parents f438e94 + 377892c commit 009fed1

File tree

4 files changed

+34
-33
lines changed

4 files changed

+34
-33
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
22

33
- [CLAs and CCLAs](#cla)
44
- [Roadmap & Milestones](#roadmap)
5-
- [Feature Request](#feature_request)
6-
- [Submit a Bug Report](#submit_a_bug_report)
7-
- [Improvements to the Codebase](#improvements_to_the_codebase)
8-
- [Understanding the Code Base](#understanding_the_codebase)
5+
- [Feature Request](#feature-request)
6+
- [Submit a Bug Report](#submit-a-bug-report)
7+
- [Improvements to the Codebase](#improvements-to-the-codebase)
8+
- [Understanding the Code Base](#understanding-the-codebase)
99
- [Testing](#testing)
10-
- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
11-
- [Creating a Pull Request](#creating_a_pull_request)
10+
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
11+
- [Creating a Pull Request](#creating-a-pull-request)
1212

1313
<a name="roadmap"></a>
1414
We use [Milestones](https://github.com/sendgrid/sendgrid-java/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
2626

2727
There are a few ways to contribute, which we'll enumerate below:
2828

29-
<a name="feature_request"></a>
29+
<a name="feature-request"></a>
3030
## Feature Request
3131

3232
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,
3636
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
3737
- Please be respectful and considerate of others when commenting on issues
3838

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

4242
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:
5353

5454
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-java/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.
5555

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

5959
We welcome direct contributions to the sendgrid-java code base. Thank you!
@@ -105,7 +105,7 @@ Add the example you want to test to Example.java, including the headers at the t
105105
javac -classpath ../repo/com/sendgrid/4.1.1/sendgrid-4.1.0-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/4.1.0/sendgrid-4.1.1-jar.jar:. Example
106106
```
107107

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

111111
**/examples**
@@ -149,7 +149,7 @@ For the purposes of contributing to this repo, please update the [`SendGridTest.
149149
./gradlew test -i
150150
```
151151

152-
<a name="style_guidelines_and_naming_conventions"></a>
152+
<a name="style-guidelines-and-naming-conventions"></a>
153153
## Style Guidelines & Naming Conventions
154154

155155
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.
@@ -158,7 +158,8 @@ Please run your code through:
158158
- [FindBugs](http://findbugs.sourceforge.net/)
159159
- [CheckStyle](http://checkstyle.sourceforge.net/) with [Google's Java Style Guide](http://checkstyle.sourceforge.net/reports/google-java-style.html).
160160

161-
## Creating a Pull Request<a name="creating_a_pull_request"></a>
161+
<a name="creating-a-pull-request"></a>
162+
## Creating a Pull Request
162163

163164
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
164165
and configure the remotes:

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ We appreciate your continued support, thank you!
1616
# Table of Contents
1717

1818
* [Installation](#installation)
19-
* [Quick Start](#quick_start)
19+
* [Quick Start](#quick-start)
2020
* [Usage](#usage)
21-
* [Use Cases](#use_cases)
21+
* [Use Cases](#use-cases)
2222
* [Announcements](#announcements)
2323
* [Roadmap](#roadmap)
2424
* [How to Contribute](#contribute)
@@ -79,7 +79,7 @@ You can just drop the jar file in. It's a fat jar - it has all the dependencies
7979

8080
- [Java-HTTP-Client](https://github.com/sendgrid/java-http-client)
8181

82-
<a name="quick_start"></a>
82+
<a name="quick-start"></a>
8383
# Quick Start
8484

8585
## Hello Email
@@ -180,7 +180,7 @@ public class Example {
180180
- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-java/tree/master/src/main/java/com/sendgrid/helpers) - build a request object payload for a v3 /mail/send API call.
181181

182182

183-
<a name="use_cases"></a>
183+
<a name="use-cases"></a>
184184
# Use Cases
185185

186186
[Examples of common API use cases](https://github.com/sendgrid/sendgrid-java/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
@@ -204,10 +204,10 @@ We encourage contribution to our libraries (you might even score some nifty swag
204204

205205
Quick links:
206206

207-
- [Feature Request](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#feature_request)
208-
- [Bug Reports](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#submit_a_bug_report)
207+
- [Feature Request](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#feature-request)
208+
- [Bug Reports](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#submit-a-bug-report)
209209
- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#cla)
210-
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
210+
- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
211211

212212
<a name="troubleshooting"></a>
213213
# Troubleshooting

USAGE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ public class Example {
2222

2323
# Table of Contents
2424

25-
* [ACCESS SETTINGS](#access_settings)
25+
* [ACCESS SETTINGS](#access-settings)
2626
* [ALERTS](#alerts)
27-
* [API KEYS](#api_keys)
27+
* [API KEYS](#api-keys)
2828
* [ASM](#asm)
2929
* [BROWSERS](#browsers)
3030
* [CAMPAIGNS](#campaigns)
@@ -35,21 +35,21 @@ public class Example {
3535
* [GEO](#geo)
3636
* [IPS](#ips)
3737
* [MAIL](#mail)
38-
* [MAIL SETTINGS](#mail_settings)
39-
* [MAILBOX PROVIDERS](#mailbox_providers)
40-
* [PARTNER SETTINGS](#partner_settings)
38+
* [MAIL SETTINGS](#mail-settings)
39+
* [MAILBOX PROVIDERS](#mailbox-providers)
40+
* [PARTNER SETTINGS](#partner-settings)
4141
* [SCOPES](#scopes)
4242
* [SENDERS](#senders)
4343
* [STATS](#stats)
4444
* [SUBUSERS](#subusers)
4545
* [SUPPRESSION](#suppression)
4646
* [TEMPLATES](#templates)
47-
* [TRACKING SETTINGS](#tracking_settings)
47+
* [TRACKING SETTINGS](#tracking-settings)
4848
* [USER](#user)
4949
* [WHITELABEL](#whitelabel)
5050

5151

52-
<a name="access_settings"></a>
52+
<a name="access-settings"></a>
5353
# ACCESS SETTINGS
5454

5555
## Retrieve all recent access attempts
@@ -353,7 +353,7 @@ For more information about alerts, please see our [User Guide](https://sendgrid.
353353
throw ex;
354354
}
355355
```
356-
<a name="api_keys"></a>
356+
<a name="api-keys"></a>
357357
# API KEYS
358358

359359
## Create API keys
@@ -2710,7 +2710,7 @@ This endpoint has a helper, check it out [here](https://github.com/sendgrid/send
27102710
throw ex;
27112711
}
27122712
```
2713-
<a name="mail_settings"></a>
2713+
<a name="mail-settings"></a>
27142714
# MAIL SETTINGS
27152715

27162716
## Retrieve all mail settings
@@ -3201,7 +3201,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
32013201
throw ex;
32023202
}
32033203
```
3204-
<a name="mailbox_providers"></a>
3204+
<a name="mailbox-providers"></a>
32053205
# MAILBOX PROVIDERS
32063206

32073207
## Retrieve email statistics by mailbox provider.
@@ -3235,7 +3235,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
32353235
throw ex;
32363236
}
32373237
```
3238-
<a name="partner_settings"></a>
3238+
<a name="partner-settings"></a>
32393239
# PARTNER SETTINGS
32403240

32413241
## Returns a list of all partner settings.
@@ -4675,7 +4675,7 @@ For more information about transactional templates, please see our [User Guide](
46754675
throw ex;
46764676
}
46774677
```
4678-
<a name="tracking_settings"></a>
4678+
<a name="tracking-settings"></a>
46794679
# TRACKING SETTINGS
46804680
46814681
## Retrieve Tracking Settings

USE_CASES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ This documentation provides examples for specific use cases. Please [open an iss
22

33
# Table of Contents
44

5-
* [Transactional Templates](#transactional_templates)
5+
* [Transactional Templates](#transactional-templates)
66

7-
<a name="transactional_templates"></a>
7+
<a name="transactional-templates"></a>
88
# Transactional Templates
99

1010
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.

0 commit comments

Comments
 (0)