Skip to content

Commit 06825a1

Browse files
authored
fix(KNO-12271): Add target="_blank" to external links in docs (#1381)
* Update external links to open in new tab * Update links in tables to add hyperlink styling * Prettier formatting * Remove leading space * Prettier formatting
1 parent 5f48c88 commit 06825a1

69 files changed

Lines changed: 193 additions & 141 deletions

Some content is hidden

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

content/__api-reference/content.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Each endpoint in the Knock API is rate limited. Knock uses a tier system to dete
8181

8282
Knock's default behavior scopes rate limits based on the authorizing credential used in your requests. When you use a public or private API key to authorize a request, Knock will scope the rate limit for each endpoint by the [environment](/concepts/environments) associated with the key. If you use a signed user token as your authorizing credential, Knock will scope the rate limit by both the key's environment and the signing user. See our documentation on [enhanced security mode](/in-app-ui/security-and-authentication#authentication-with-enhanced-security) for more details on working with signed user tokens.
8383

84-
If you're concerned about exceeding a Knock rate limit, please [contact us](https://knock.app/contact-sales) and we can help figure out a usage rate that's right for your specific needs.
84+
If you're concerned about exceeding a Knock rate limit, please <a href="https://knock.app/contact-sales" target="_blank" rel="noopener">contact us</a> and we can help figure out a usage rate that's right for your specific needs.
8585

8686
</ContentColumn>
8787
<ExampleColumn>
@@ -144,7 +144,7 @@ Knock can apply batch deduplication rate limits to all or part of a request. If
144144
<Section title="Idempotent requests" slug="idempotent-requests" path="/overview/idempotent-requests">
145145
<ContentColumn>
146146

147-
Knock supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) so that requests can be retried safely without unintended side effects.
147+
Knock supports <a href="https://en.wikipedia.org/wiki/Idempotence" target="_blank" rel="noopener noreferrer">idempotency</a> so that requests can be retried safely without unintended side effects.
148148

149149
To perform an idempotent request, set an `Idempotency-Key` header on your request. This idempotency key is a unique string of up to 255 characters that you generate for each request. It is used to identify and prevent the duplicate processing of requests. If you retry a request with the same idempotency key within 24 hours from the original request, Knock will return the same response as the original request. Idempotent requests are expected to be identical. To prevent accidental misuse, Knock returns an error when incoming parameters don't match those from the original request.
150150

@@ -367,7 +367,7 @@ Resources that return multiple entities support the same cursor-based pagination
367367
<Section title="Errors" slug="errors" direction="column" path="/overview/errors">
368368
<ContentColumn>
369369

370-
Knock uses standard [HTTP response codes](https://developer.mozilla.org/en-US/Web/HTTP/Status) to indicate the success or failure of your API requests.
370+
Knock uses standard <a href="https://developer.mozilla.org/en-US/Web/HTTP/Status" target="_blank" rel="noopener noreferrer">HTTP response codes</a> to indicate the success or failure of your API requests.
371371

372372
- `2xx` success status codes confirm that your request worked as expected.
373373

content/__mapi-reference/content.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Authorization: Bearer knock_st_12345
7272
<Section title="Errors" slug="errors" path="/overview/errors" direction="column">
7373
<ContentColumn>
7474

75-
Knock uses standard [HTTP response codes](https://developer.mozilla.org/en-US/Web/HTTP/Status) to indicate the success or failure of your API requests.
75+
Knock uses standard <a href="https://developer.mozilla.org/en-US/Web/HTTP/Status" target="_blank" rel="noopener noreferrer">HTTP response codes</a> to indicate the success or failure of your API requests.
7676

7777
- `2xx` success status codes confirm that your request worked as expected.
7878
- `4xx` error status codes indicate an error caused by incorrect or missing request information (e.g. providing an incorrect API key).
@@ -84,7 +84,7 @@ Knock uses standard [HTTP response codes](https://developer.mozilla.org/en-US/We
8484
<Section title="Postman" slug="postman" path="/overview/postman" direction="column">
8585
<ContentColumn>
8686

87-
You can use our [Management API Postman collection](https://www.postman.com/knock-labs/workspace/knock-public-workspace/collection/15616728-9ed6000c-13bc-43f5-a2cf-db6daea256bd?action=share&creator=15616728&active-environment=15616728-6df39335-c6f9-4c9d-99d5-73e3c7ffe524) to quickly get started testing our Management API.
87+
You can use our <a href="https://www.postman.com/knock-labs/workspace/knock-public-workspace/collection/15616728-9ed6000c-13bc-43f5-a2cf-db6daea256bd?action=share&creator=15616728&active-environment=15616728-6df39335-c6f9-4c9d-99d5-73e3c7ffe524" target="_blank" rel="noopener">Management API Postman collection</a> to quickly get started testing our Management API.
8888

8989
</ContentColumn>
9090
</Section>

content/cli/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ With the CLI, you can:
2525

2626
**Install with Homebrew**
2727

28-
For macOS, you can install the Knock CLI using [Homebrew](https://brew.sh/). Once the CLI is installed you can call it by using the `knock` command in your terminal.
28+
For macOS, you can install the Knock CLI using <a href="https://brew.sh/" target="_blank" rel="noopener noreferrer">Homebrew</a>. Once the CLI is installed you can call it by using the `knock` command in your terminal.
2929

3030
**Install with npm**
3131

@@ -38,7 +38,7 @@ The Knock CLI is built with Node.js and installable as a `npm` package. You must
3838
- Node.js: 16.14.0 or higher
3939
- NPM: 7.18.1 or higher
4040

41-
You can find the Knock CLI npm package [here](https://www.npmjs.com/package/@knocklabs/cli).
41+
You can find the Knock CLI npm package <a href="https://www.npmjs.com/package/@knocklabs/cli" target="_blank" rel="noopener">here</a>.
4242

4343
</ContentColumn>
4444
<ExampleColumn>

content/concepts/recipients.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ You can use our [Subscriptions](/concepts/subscriptions) feature to create a Kno
5555

5656
## Recipient timezones
5757

58-
A recipient can have an optional `timezone` property, which should be a [valid tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `America/New_York` or `Europe/London`. By default, if no recipient timezone is set `Etc/UTC` will be used however a [default timezone](/manage-your-account/account-timezone) can be specified at the account level under "Settings" which will override this default for all recipients.
58+
A recipient can have an optional `timezone` property, which should be a <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="_blank" rel="noopener noreferrer">valid tz database time zone string</a>, like `America/New_York` or `Europe/London`. By default, if no recipient timezone is set `Etc/UTC` will be used however a [default timezone](/manage-your-account/account-timezone) can be specified at the account level under "Settings" which will override this default for all recipients.
5959

6060
## Frequently asked questions
6161

content/concepts/schedules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ There are 2 ways in which to get data into each of your scheduled workflow runs:
269269

270270
## Executing schedules in a recipient's timezone
271271

272-
Knock supports a `timezone` property on the recipient that automatically makes a scheduled workflow run timezone aware, meaning you can express recurring schedules like "every monday at 9am in the recipient's timezone." Recipient timezones must be a [valid tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `America/New_York`.
272+
Knock supports a `timezone` property on the recipient that automatically makes a scheduled workflow run timezone aware, meaning you can express recurring schedules like "every monday at 9am in the recipient's timezone." Recipient timezones must be a <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="_blank" rel="noopener noreferrer">valid tz database time zone string</a>, like `America/New_York`.
273273

274274
[Read more about recipient timezone support](/concepts/recipients#recipient-timezones).
275275

content/concepts/tenants.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,10 @@ that aren't relevant to the user.
208208
text={
209209
<>
210210
Per-tenant branding is only available on our{" "}
211-
<a href="https://knock.app/pricing">Enterprise plan</a>.
211+
<a href="https://knock.app/pricing" target="_blank" rel="noopener">
212+
Enterprise plan
213+
</a>
214+
.
212215
</>
213216
}
214217
/>
@@ -236,7 +239,11 @@ Now that the tenant is set up, when you trigger a workflow with an email step yo
236239
text={
237240
<>
238241
Per-tenant user preferences and tenant preference defaults are only
239-
available on our <a href="https://knock.app/pricing">Enterprise plan</a>.
242+
available on our{" "}
243+
<a href="https://knock.app/pricing" target="_blank" rel="noopener">
244+
Enterprise plan
245+
</a>
246+
.
240247
</>
241248
}
242249
/>

content/concepts/users.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ The following attributes are required for each user you identify with Knock.
4545

4646
The following attributes are optional, depending on the channel types you decide to use with Knock.
4747

48-
| Property | Description |
49-
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50-
| email | The primary email address for the user (required for email channels) |
51-
| name | The full name of the user |
52-
| avatar | A URL for the avatar of the user |
53-
| phone_number | The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels) |
54-
| timezone | A valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) (optional for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients)) |
48+
| Property | Description |
49+
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50+
| email | The primary email address for the user (required for email channels) |
51+
| name | The full name of the user |
52+
| avatar | A URL for the avatar of the user |
53+
| phone_number | The <a href="https://www.twilio.com/docs/glossary/what-e164" target="\_blank" rel="noopener noreferrer" style={{ color: "var(--tgph-accent-11)", textDecoration: "underline" }}>E.164</a> phone number of the user (required for SMS channels) |
54+
| timezone | A valid <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="\_blank" rel="noopener noreferrer" style={{ color: "var(--tgph-accent-11)", textDecoration: "underline" }}>tz database time zone string</a> (optional for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients)) |
5555

5656
### Storing user properties
5757

content/designing-workflows/batch-function.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You can also set the length of your batch windows dynamically using a variable.
8888

8989
When specifying a dynamic batch window you must provide one of the following:
9090

91-
- An [ISO-8601 timestamp](https://en.wikipedia.org/wiki/ISO_8601) (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
91+
- An <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO-8601 timestamp</a> (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
9292
- A relative duration (e.g `{ "unit": "seconds", "value": 30 }`)
9393
- A window rule (e.g `{ "frequency": "daily", "hours": 9, "minutes": 30 }`)
9494

@@ -296,7 +296,10 @@ Here's a list of the variables that you can use to work with batch-related state
296296
text={
297297
<>
298298
The render limit setting for batch activities and actors is only available
299-
on our <a href="https://knock.app/pricing">Enterprise plan.</a>
299+
on our{" "}
300+
<a href="https://knock.app/pricing" target="_blank" rel="noopener">
301+
Enterprise plan.
302+
</a>
300303
</>
301304
}
302305
/>

content/designing-workflows/delay-function.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can also set the length of your delay dynamically using a variable. You can
2222

2323
When specifying a dynamic delay period you must provide one of the following:
2424

25-
- An [ISO-8601 timestamp](https://en.wikipedia.org/wiki/ISO_8601) (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
25+
- An <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO-8601 timestamp</a> (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
2626
- A duration unit (e.g `{ "unit": "seconds", "value": 30 }`)
2727
- A window rule (e.g `{ "frequency": "daily", "hours": 9, "minutes": 30 }`)
2828

content/designing-workflows/throttle-function.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can also set the length of your throttle windows dynamically using a variabl
3333

3434
When specifying a dynamic window you must provide one of the following:
3535

36-
- An **[ISO-8601 timestamp](https://en.wikipedia.org/wiki/ISO_8601)** (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
36+
- An <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO-8601 timestamp</a> (e.g. `2022-05-04T20:34:07Z`) which must be a datetime in the future
3737
- A relative duration unit (e.g `{ "unit": "seconds", "value": 30 }`)
3838
- A window rule (e.g `{ "frequency": "daily", "hours": 9, "minutes": 30 }`)
3939

0 commit comments

Comments
 (0)