From ac1b457a1af333395ccb0489187b8aa7c72c3038 Mon Sep 17 00:00:00 2001 From: Jamie Tanna Date: Tue, 31 Oct 2017 23:11:43 +0000 Subject: [PATCH] Create use-cases directory Move each separate use case into their own separate files, linked from the `use-cases` directory. Closes #401. --- use-cases/README.md | 9 +++++++ use-cases/domain-whitelabel.md | 5 ++++ use-cases/email-statistics.md | 5 ++++ .../transactional-templates.md | 24 ------------------- 4 files changed, 19 insertions(+), 24 deletions(-) create mode 100644 use-cases/README.md create mode 100644 use-cases/domain-whitelabel.md create mode 100644 use-cases/email-statistics.md rename USE_CASES.md => use-cases/transactional-templates.md (66%) diff --git a/use-cases/README.md b/use-cases/README.md new file mode 100644 index 00000000..975a7135 --- /dev/null +++ b/use-cases/README.md @@ -0,0 +1,9 @@ +# Use Cases + +This directory provides examples for specific use cases. + +Please [open an issue](https://github.com/sendgrid/sendgrid-java/issues/new) or make a pull request for any use cases you would like us to document here. Thank you! + +* [Transactional Templates](transactional_templates.md) +* [How to Setup a Domain Whitelabel](domain_whitelabel.md) +* [How to View Email Statistics](email_statistics.md) diff --git a/use-cases/domain-whitelabel.md b/use-cases/domain-whitelabel.md new file mode 100644 index 00000000..1ab40ec4 --- /dev/null +++ b/use-cases/domain-whitelabel.md @@ -0,0 +1,5 @@ +# 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-java/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). diff --git a/use-cases/email-statistics.md b/use-cases/email-statistics.md new file mode 100644 index 00000000..91ebae3b --- /dev/null +++ b/use-cases/email-statistics.md @@ -0,0 +1,5 @@ +# 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-java/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. diff --git a/USE_CASES.md b/use-cases/transactional-templates.md similarity index 66% rename from USE_CASES.md rename to use-cases/transactional-templates.md index 5ec48991..b2468098 100644 --- a/USE_CASES.md +++ b/use-cases/transactional-templates.md @@ -1,12 +1,3 @@ -This documentation provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/sendgrid-java/issues) or make a pull request for any use cases you would like us to document here. Thank you! - -# Table of Contents - -* [Transactional Templates](#transactional_templates) -* [How to Setup a Domain Whitelabel](#domain_whitelabel) -* [How to View Email Statistics](#email_stats) - - # 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. @@ -101,18 +92,3 @@ public class Example { } } ``` - - -# 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-java/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-java/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. -