Skip to content

Commit 6f2842e

Browse files
committed
Redirect platform customization links after migration
1 parent b11db0b commit 6f2842e

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

content/errors/codes.textile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -394,15 +394,15 @@ By default, Ably apps require "TLS":/docs/platform/account/app/settings#channel-
394394

395395
h2(#40330). 40330: Unable to activate account due to placement constraint (unspecified)
396396

397-
This error occurs when an app belonging to a dedicated (private) "cluster":/docs/platform-customization#dedicated-and-isolated-clusters is accessed using an incorrect endpoint. "Enterprise":/docs/platform/pricing/enterprise customers with private clusters receive "custom":/docs/platform-customization#setting-up-a-custom-environment environment endpoints specific to their deployment.
397+
This error occurs when an app belonging to a dedicated (private) "cluster":/docs/platform/enterprise-customization#dedicated-and-isolated-clusters is accessed using an incorrect endpoint. "Enterprise":/docs/platform/pricing/enterprise customers with private clusters receive "custom":/docs/platform/enterprise-customization#setting-up-a-custom-environment environment endpoints specific to their deployment.
398398

399399
An example of this error is when an app configured for a private cluster tries to connect via the default global endpoint.
400400

401401
*Resolution*: Check your custom environment settings for all connecting clients to ensure they point to the correct private cluster endpoints.
402402

403403
h2(#40331). 40331: Unable to activate account due to placement constraint (incompatible environment)
404404

405-
This error occurs when an app that belongs to a dedicated (private) "cluster":/docs/platform-customization#dedicated-and-isolated-clusters is accessed using an incorrect URL. This often happens when the correct environment is not specified when initializing a client library. "Enterprise":/docs/platform/pricing/enterprise customers with private clusters receive "custom":/docs/platform-customization#setting-up-a-custom-environment environment endpoints specific to their deployment.
405+
This error occurs when an app that belongs to a dedicated (private) "cluster":/docs/platform/enterprise-customization#dedicated-and-isolated-clusters is accessed using an incorrect URL. This often happens when the correct environment is not specified when initializing a client library. "Enterprise":/docs/platform/pricing/enterprise customers with private clusters receive "custom":/docs/platform/enterprise-customization#setting-up-a-custom-environment environment endpoints specific to their deployment.
406406

407407
If a request arrives at an unexpected dedicated cluster or incorrect region, the account in that scope may be disabled, triggering this error.
408408

@@ -418,7 +418,7 @@ An example of this error is when a client attempts to connect to an Ably app res
418418

419419
*Resolution*: The following steps can help resolve this issue:
420420
* Ensure you are configured with the correct environment for your "region-restricted":/https://faqs.ably.com/do-you-have-an-option-to-keep-my-data-in-europe-or-the-united-states account.
421-
* If your account has a regional constraint, you should have been provided with a "custom":/docs/platform-customization#setting-up-a-custom-environment environment to pass to the "@ClientOptions@":/docs/getting-started/setup#options.
421+
* If your account has a regional constraint, you should have been provided with a "custom":/docs/platform/enterprise-customization#setting-up-a-custom-environment environment to pass to the "@ClientOptions@":/docs/getting-started/setup#options.
422422
* Verify that your connection settings match the region assigned to your account.
423423

424424
h2(#40400). 40400: Not found

content/getting-started/setup.textile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,6 @@ Properties that can be set include those used to:
315315
* authenticate the client, such as @key@ if using "basic authentication":/docs/auth/basic, or an @authUrl@ or @authCallback@ if using "token authentication":/docs/auth/token.
316316
* customize client behavior, such as using @echoMessages@ to set whether messages published by the client are received by them, or @idempotentRestPublishing@ to enable idempotent publishing.
317317
* set retry and timeout durations.
318-
* set environment names and fallbacks if using a "custom environment":/docs/platform-customization.
318+
* set environment names and fallbacks if using a "custom environment":/docs/platform/enterprise-customization.
319319

320320
See the API references for a full list of properties available to the "realtime":/docs/api/realtime-sdk#client-options and "REST":/docs/api/rest-sdk?#client-options interfaces.

content/partials/types/_client_options.textile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ h4.
1616

1717
- <span lang="default">useTokenAuth</span><span lang="csharp,go">UseTokenAuth</span><span lang="python">use_token_auth</span><span lang="ruby">:use_token_auth</span> := _false_ When true, forces "Token authentication":/docs/auth/token to be used by the library. Please note that if a <span lang="ruby,python">@client_id@</span><span lang="default">@clientId@</span> is not specified in the "@ClientOptions@":/docs/api/realtime-sdk/types#client-options or "@TokenParams@":/docs/api/realtime-sdk/types#token-params, then the Ably Token issued will be "anonymous":https://faqs.ably.com/authenticated-and-identified-clients. <br>__Type: @Boolean@__
1818

19-
- <span lang="default">endpoint</span><span lang="csharp,go">Endpoint</span><span lang="ruby">:endpoint</span> := _<span lang="default">null</span><span lang="java">Null</span><span lang="python">None</span><span lang="ruby,objc,swift">nil</span>_ Enables "enterprise customers":https://ably.com/pricing to use their own custom endpoints, which support dedicated, isolated clusters and regional message routing and storage constraints. See our "platform customization guide":/docs/platform-customization for more details.<br>__Type: @String@__
19+
- <span lang="default">endpoint</span><span lang="csharp,go">Endpoint</span><span lang="ruby">:endpoint</span> := _<span lang="default">null</span><span lang="java">Null</span><span lang="python">None</span><span lang="ruby,objc,swift">nil</span>_ Enables "enterprise customers":https://ably.com/pricing to use their own custom endpoints, which support dedicated, isolated clusters and regional message routing and storage constraints. See our "platform customization guide":/docs/platform/enterprise-customization for more details.<br>__Type: @String@__
2020

21-
- <span lang="default">environment</span><span lang="csharp,go">Environment</span><span lang="ruby">:environment</span> := _<span lang="default">null</span><span lang="java">Null</span><span lang="python">None</span><span lang="ruby,objc,swift">nil</span>_ Deprecated, use @endpoint@. Enables "enterprise customers":https://ably.com/pricing to use their own custom environments, which support dedicated, isolated clusters and regional message routing and storage constraints. See our "platform customization guide":/docs/platform-customization for more details.<br>__Type: @String@__
21+
- <span lang="default">environment</span><span lang="csharp,go">Environment</span><span lang="ruby">:environment</span> := _<span lang="default">null</span><span lang="java">Null</span><span lang="python">None</span><span lang="ruby,objc,swift">nil</span>_ Deprecated, use @endpoint@. Enables "enterprise customers":https://ably.com/pricing to use their own custom environments, which support dedicated, isolated clusters and regional message routing and storage constraints. See our "platform customization guide":/docs/platform/enterprise-customization for more details.<br>__Type: @String@__
2222

2323
- <span lang="default">idempotentRestPublishing</span><span lang="csharp,go">IdempotentRestPublishing</span><span lang="ruby">:idempotent_rest_publishing</span> := _false_ When true, enables idempotent publishing by assigning a unique message ID client-side, allowing the Ably servers to discard automatic publish retries following a failure such as a network fault. We recommend you enable this by default. In version 1.2 onwards, idempotent publishing for retries will be enabled by default.<br>__Type: @Boolean@__
2424

src/data/nav/platform.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ export default {
256256
},
257257
{
258258
name: 'Enterprise customization',
259-
link: '/docs/platform-customization',
259+
link: '/docs/platform/enterprise-customization',
260260
},
261261
{
262262
name: 'App management',

src/pages/docs/chat/moderation/direct/hive-dashboard.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The setup is as follows:
3535
2. Click "+ Create new"
3636
3. Ensure that the "Action type" is set to "POST"
3737
4. Enter a descriptive name for the action, for example "Delete message"
38-
5. Set the "Endpoint URL" field to `https://rest.ably.io/chat/v2/moderation/hive/delete` (if you have a [dedicated cluster](https://ably.com/docs/platform-customization#setting-up-a-custom-environment) the domain should be your custom REST domain)
38+
5. Set the "Endpoint URL" field to `https://rest.ably.io/chat/v2/moderation/hive/delete` (if you have a [dedicated cluster](https://ably.com/docs/platform/enterprise-customization#setting-up-a-custom-environment) the domain should be your custom REST domain)
3939
6. Under "Customize API Request" add the `Authorization` header with the value `Bearer <your Base64 encoded Ably API key>`, make sure to Base64 encode the API key you get from the Ably dashboard.
4040
7. Under "Request Body" add the following two params:
4141
* `serial` := `Post ID`

src/pages/docs/platform/architecture/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The platform has been designed with the following primary objectives in mind:
4545

4646
## Cluster architecture
4747

48-
Ably's platform runs on AWS EC2 infrastructure with a globally distributed architecture. Ably's [clusters](/docs/platform-customization#dedicated-and-isolated-clusters) typically span multiple regions, usually between two and ten. This multi-region approach maximizes availability and is a critical aspect of providing a fault tolerant service.
48+
Ably's platform runs on AWS EC2 infrastructure with a globally distributed architecture. Ably's [clusters](/docs/platform/enterprise-customization#dedicated-and-isolated-clusters) typically span multiple regions, usually between two and ten. This multi-region approach maximizes availability and is a critical aspect of providing a fault tolerant service.
4949

5050
Each regional deployment operates independently, handling its own subscriber connections, REST traffic, channel management and message routing. When activity occurs on a channel across multiple regions, messages flow peer-to-peer between regions directly, eliminating central bottlenecks and single points of failure.
5151

0 commit comments

Comments
 (0)