Skip to content

Commit 04b895a

Browse files
authored
docs: convert in-site absolute links to root-relative (#860)
* docs: convert in-site absolute links to root-relative Convert internal doc links from https://docs.sparkpost.com/docs/... to /docs/... (root-relative) across 65 files. This enables client-side routing via next/link, keeps links correct on preview/staging deploys, and matches the relative-link convention already used elsewhere in the content. External sparkpost.com links (developers/app/www) are left absolute. * docs: revert placeholder link in template example /docs/product.url is a merge-field placeholder inside a fenced code example, not a real navigational link. Keep it as-is to scope this PR to genuine in-site links.
1 parent 528d28b commit 04b895a

65 files changed

Lines changed: 145 additions & 145 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/docs/deliverability/ded-ip-full-circle-dns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ lastUpdated: "02/08/2020"
33
title: "Dedicated IPs - full-circle reverse DNS and EHLO hostnames on SparkPost"
44
description: "Dedicated IP addresses issued from SparkPost address ranges automatically have Full Circle Reverse DNS"
55
---
6-
You may have noticed that recently allocated [dedicated IP addresses](https://docs.sparkpost.com/docs/deliverability/managing-dedicated-ip-pools/) in your SparkPost account come from specific address ranges.
6+
You may have noticed that recently allocated [dedicated IP addresses](/docs/deliverability/managing-dedicated-ip-pools/) in your SparkPost account come from specific address ranges.
77

8-
Unless you are using our [Bring your Own IP](https://docs.sparkpost.com/docs/tech-resources/bring-your-own-ip/) feature, your dedicated IPs come from a range registered to SparkPost.
8+
Unless you are using our [Bring your Own IP](/docs/tech-resources/bring-your-own-ip/) feature, your dedicated IPs come from a range registered to SparkPost.
99

1010
```
1111
whois 147.253.215.24

content/docs/deliverability/dedicated-ip-pools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Dedicated IP Pools"
44
description: "Dedicated IP addresses are available for any account with the exception of the FREE plan with no credit card details on file Any new dedicated IP address added to your account will have a neutral initial reputation which means that you will be responsible for properly warming up your new..."
55
---
66

7-
Dedicated IP addresses are available for any account with the exception of Starter and Test plans. Any new dedicated IP address added to your account will have a neutral initial reputation, which means that you will be responsible for properly warming up your new IP. You can refer to our [IP Warmup Overview](https://docs.sparkpost.com/docs/deliverability/ip-warm-up-overview/) for a comprehensive guide to warming up your new IP.
7+
Dedicated IP addresses are available for any account with the exception of Starter and Test plans. Any new dedicated IP address added to your account will have a neutral initial reputation, which means that you will be responsible for properly warming up your new IP. You can refer to our [IP Warmup Overview](/docs/deliverability/ip-warm-up-overview/) for a comprehensive guide to warming up your new IP.
88

99
## Plans with an Included IP
1010

@@ -28,7 +28,7 @@ You can provision additional dedicated IPs directly to your Account via the UI.
2828

2929
You can view and manage your dedicated IPs and their associated IP Pools in the UI by selecting **Configuration** > **IP Pools**
3030

31-
From here, you can create, delete, or edit IP Pools. You can also move dedicated IPs between pools. Read this article to understand more about __[managing your existing dedicated IP pools](https://docs.sparkpost.com/docs/deliverability/managing-dedicated-ip-pools/)__.
31+
From here, you can create, delete, or edit IP Pools. You can also move dedicated IPs between pools. Read this article to understand more about __[managing your existing dedicated IP pools](/docs/deliverability/managing-dedicated-ip-pools/)__.
3232

3333
## Using Your Dedicated IPs
3434

content/docs/deliverability/deliverability-analytics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The seed list is updated periodically, as we regularly expand our panel coverage
7979

8080
### Getting Started with Panel Data
8181

82-
Panel data associated with a sending domain in your SparkPost account will start flowing into your account immediately. If you already have a sending domain added and verified, no further action is needed! If you do not yet have a sending domain in your SparkPost account, please follow these [Getting Started steps](https://docs.sparkpost.com/docs/getting-started/getting-started-sparkpost/) to set one up and verify it.
82+
Panel data associated with a sending domain in your SparkPost account will start flowing into your account immediately. If you already have a sending domain added and verified, no further action is needed! If you do not yet have a sending domain in your SparkPost account, please follow these [Getting Started steps](/docs/getting-started/getting-started-sparkpost/) to set one up and verify it.
8383

8484
Note: You do *not* need to send emails to the consumer panel *through SparkPost* in order to see the data - we will show you panel data sent through any method. We do require a verified domain in order to display the results to the correct account.
8585

@@ -111,7 +111,7 @@ SparkPost also provides the following deliverability metrics in the [SparkPost a
111111
| Moved to Spam Count | Number of panel messages delivered to the inbox but then moved to the spam folder. | `count_moved_to_spam`
112112
| Moved to Spam Rate | Percentage of panel messages delivered to the inbox folder but then moved to the spam folder. | `count_moved_to_spam` / (`count_inbox_panel` + `count_inbox_seed`) |
113113

114-
To view the deliverability metrics in the UI, first click “Signals Analytics” in the top menu to be taken to the “Analytics Report”. Click “Add Metrics” and scroll to the “Deliverability Metrics” section to add your desired metrics. All [user roles](https://docs.sparkpost.com/docs/user-guide/managing-users/) can view deliverability metrics in the UI.
114+
To view the deliverability metrics in the UI, first click “Signals Analytics” in the top menu to be taken to the “Analytics Report”. Click “Add Metrics” and scroll to the “Deliverability Metrics” section to add your desired metrics. All [user roles](/docs/user-guide/managing-users/) can view deliverability metrics in the UI.
115115

116116
![](media/deliverability-analytics/02-deliverability-metrics.png)
117117

content/docs/deliverability/optimizing-deliverability-and-inbox-placement.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ In order to get the best deliverability and inbox placement rates, you need to e
2222
* Hide the unsubscribe link or ignore unsubscribe requests
2323
* Buy email lists - especially those from untrustworthy sources
2424
* Sell your list to a third party without permission
25-
8. Set up [custom bounce domain(s)](https://docs.sparkpost.com/docs/tech-resources/custom-bounce-domain/)
26-
9. Set up [custom tracking domain(s)](https://docs.sparkpost.com/docs/tech-resources/enabling-multiple-custom-tracking-domains/)
25+
8. Set up [custom bounce domain(s)](/docs/tech-resources/custom-bounce-domain/)
26+
9. Set up [custom tracking domain(s)](/docs/tech-resources/enabling-multiple-custom-tracking-domains/)
2727

2828
For more detailed information on this topic, please review [MAAWG Sender Best Common Practices](https://www.m3aawg.org/documents/en/m3aawg-sender-best-common-practices-version-30).
2929

content/docs/faq/can-i-send-from-any-domain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Domain Ownership And Control You can send mail through Spark Post
66

77
## Domain Ownership And Control
88

9-
You can send mail through SparkPost from any domain *that you or your customers control*. By verifying your sending domains with SparkPost, you're letting us know that you control them and that you authorize delivery from those domains. The DKIM domain verification procedure is the best option here since it also brings deliverability best practice with it. [There are instructions here how to verify your sending domains](https://docs.sparkpost.com/docs/getting-started/getting-started-sparkpost/#step-2-verify-domain).
9+
You can send mail through SparkPost from any domain *that you or your customers control*. By verifying your sending domains with SparkPost, you're letting us know that you control them and that you authorize delivery from those domains. The DKIM domain verification procedure is the best option here since it also brings deliverability best practice with it. [There are instructions here how to verify your sending domains](/docs/getting-started/getting-started-sparkpost/#step-2-verify-domain).
1010

1111
## Why Can't I Just Send From Any Domain?
1212

content/docs/faq/cc-bcc-archive-recipients.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ It is possible to specify a list of one or more recipients who will receive a co
2222
### Notes
2323

2424
* The “rcpt_type” field present in webhook/Message Events API data is used to specify whether the recipient is a CC, BCC or Archive recipient.
25-
* If the [REST API is used to send cc or bcc messages](https://docs.sparkpost.com/docs/faq/cc-bcc-with-rest-api/) (please note that archive is **not** supported via the REST API), the "rcpt_type" field **does not appear** in the webhook or Message Events API data. We recommend that you include recipient-level metadata for tracking which type each recipient address belongs to.
25+
* If the [REST API is used to send cc or bcc messages](/docs/faq/cc-bcc-with-rest-api/) (please note that archive is **not** supported via the REST API), the "rcpt_type" field **does not appear** in the webhook or Message Events API data. We recommend that you include recipient-level metadata for tracking which type each recipient address belongs to.
2626
* Each Archive, CC, and BCC recipient is counted in the standard targeted and accepted metrics.
2727
* Archive messages do not include a BCC header.
2828
* The total number of CC, BCC and archive recipients cannot exceed 1000.

content/docs/faq/cc-bcc-with-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Using CC and BCC with the REST API"
44
description: "Before getting started please read What are the differences between CC BCC and archive recipients Note to use CC BCC and Archiving with SMTP check out our SMTP API reference documentation Note Please be advised that CC and BCC messages count towards your usage What is CC CC is a..."
55
---
66

7-
Before getting started please read [What are the differences between CC, BCC, and archive recipients?](https://docs.sparkpost.com/docs/faq/cc-bcc-archive-recipients/)
7+
Before getting started please read [What are the differences between CC, BCC, and archive recipients?](/docs/faq/cc-bcc-archive-recipients/)
88

99
Note: to use CC, BCC, and Archiving with SMTP, check out our [SMTP API reference documentation](https://developers.sparkpost.com/api/#/reference/smtp-api).
1010
Note: Please be advised that CC and BCC  messages count towards your usage.

content/docs/faq/daily-and-monthly-quota-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ Daily limits can take up to a week to fully update after you upgrade your plan.
3434

3535
If you need to send more than 50,000 email a day on average throughout a calendar month, SparkPost requires that you have one or more dedicated IPs and custom bounce and tracking domains set up. Please set these up before requesting a limit rise.
3636

37-
**Note:** Please follow our [IP Warm up Guide](https://docs.sparkpost.com/docs/deliverability/ip-warm-up-overview/) to warm up any new IP and correctly establish your sending reputation.
37+
**Note:** Please follow our [IP Warm up Guide](/docs/deliverability/ip-warm-up-overview/) to warm up any new IP and correctly establish your sending reputation.

content/docs/faq/dkim-wont-verify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Q Why won't my DKIM record verify A While configuring your Sending
66

77
Q: Why won't my DKIM record verify?
88

9-
A: [While configuring your Sending Domains](https://docs.sparkpost.com/docs/getting-started/getting-started-sparkpost/#prerequisites), you need to "verify" that the DNS entries you have made are available to SparkPost and ESPs for use. The DNS TXT records you create have a TTL (Time To Live) value associated with them. This value is important (in cases where you have been unable to verify your Sending Domain's DNS DKIM record). The TTL is typically measured in seconds. For example a TTL value of 60 = 1 minute.
9+
A: [While configuring your Sending Domains](/docs/getting-started/getting-started-sparkpost/#prerequisites), you need to "verify" that the DNS entries you have made are available to SparkPost and ESPs for use. The DNS TXT records you create have a TTL (Time To Live) value associated with them. This value is important (in cases where you have been unable to verify your Sending Domain's DNS DKIM record). The TTL is typically measured in seconds. For example a TTL value of 60 = 1 minute.
1010

1111
When you click the "verify" link on the Sending Domains configuration page, SparkPost makes a request to DNS to see if that record is available. Sometimes, the TTL may cause changes you've just made to not be "visible" to SparkPost yet. So if you don't see a message saying your DKIM is verified, just wait a bit and refresh the page.
1212

content/docs/faq/error-messages-smtp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ For error messages that are not listed below, see one of the popular SMTP reply
1212
|:---------------------------------------------------------|:-------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1313
| 535 5.7.8 Sorry. *** No authentication type succeeded | There is some problem with the authentication credentials. API key, user name, etc. | Confirm that the API key has the Send via SMTP permission and the user name SMTP_Injection. |
1414
| 550 5.6.0 JSON parsing error in X-MSYS-API | The X-MSYS-API header is malformed in some way | Fix the header's json. The error message usually supplies additional details about the problem. See [the API Docs](https://developers.sparkpost.com/api/smtp-api.html) for more information about the format. |
15-
| 550 5.7.1 Unconfigured Sending Domain <demo.example.com> | The domain part of the "From" address isn't a configured sending domain | Use a "From" address that uses a configured sending domain. See [Creating Sending Domains](https://docs.sparkpost.com/docs/getting-started/getting-started-sparkpost/#preparing-your-from-address) if you need to create a sending domain. |
15+
| 550 5.7.1 Unconfigured Sending Domain <demo.example.com> | The domain part of the "From" address isn't a configured sending domain | Use a "From" address that uses a configured sending domain. See [Creating Sending Domains](/docs/getting-started/getting-started-sparkpost/#preparing-your-from-address) if you need to create a sending domain. |

0 commit comments

Comments
 (0)