Skip to content

Commit 497a41f

Browse files
committed
chore: add docs prefix to textile redirection links
1 parent 1478e0c commit 497a41f

File tree

133 files changed

+1078
-1078
lines changed

Some content is hidden

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

133 files changed

+1078
-1078
lines changed

content/account/app/index.textile

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Create, manage, and configure "API keys":/account/dashboard/api by setting capab
5454

5555
h3. Integrations
5656

57-
"Integrate":/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:
57+
"Integrate":/docs/general/integrations Ably with external services, enabling data to flow between Ably channels and third-party platforms:
5858

5959
* Ably events can trigger webhook requests to external services, or external services can send data to Ably using incoming webhooks.
6060
* Ably enables continuous streaming of events to external services like Amazon Kinesis or Kafka, or can receive inbound streams from external services.

content/account/app/queues.textile

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ meta_description: Manage and configure Ably queues, monitor realtime data, and o
44
meta_keywords: “Ably Queues, realtime data, AMQP, STOMP, queue management, TTL, queue settings"
55
---
66

7-
Ably queues provide a way to consume realtime data using the "AMQP":/general/queues#consume-amqp or "STOMP":/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/general/queues#what.
7+
Ably queues provide a way to consume realtime data using the "AMQP":/docs/general/queues#consume-amqp or "STOMP":/docs/general/queues#consume-stomp protocols. Find out more about using "Ably queues":/docs/general/queues#what.
88

99
h2. Manage your Ably queues
1010

@@ -26,6 +26,6 @@ When provisioning a new queue, you'll need to specify several things:
2626

2727
h3(#setup). Set up queue rules
2828

29-
Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/general/firehose.
29+
Once you have provisioned a physical queue, you need to set up one or more queue rules to republish messages, presence events or channel events from pub/sub channels into a queue. Queue rules can either be used to publish to internal queues (hosted by Ably) or external external streams or queues (such as Amazon Kinesis and RabbitMQ). Publishing to external streams or queues is part of our "Ably Firehose servers":/docs/general/firehose.
3030

31-
Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/general/queues#setup.
31+
Ably queue rules are setup in the *Integrations* tab found within your app *dashboard*. Find out more about setting up "queue rules":/docs/general/queues#setup.

content/account/control-api.textile

+17-17
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Programmatic management with Control API
33
meta_description: "The Control API is a REST API that enables you to manage your Ably account programmatically. This is the Control API user guide."
44
meta_keywords: "Ably, applications, apps, Control API, account management, control, REST API, OpenAPI Specification, OAS3."
55
redirect_from:
6-
- /control-api
7-
- /control-api/curl-examples
8-
- /control-api/testing-with-postman
6+
- /docs/control-api
7+
- /docs/control-api/curl-examples
8+
- /docs/control-api/testing-with-postman
99
---
1010

11-
Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/api/control-api.
11+
Ably Control API is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure. Details of the API can be found in the "Control API Reference":/docs/api/control-api.
1212

1313
Using the Control API you can automate the provisioning, management, and testing of your Ably realtime infrastructure. You can dynamically create Ably apps, configure them, and delete them if necessary. You can implement multi-tenancy solutions for your customers, and create configuration-driven environments that can easily be replicated under programmatic control. Once these environments are created you can also test them using Control API.
1414

@@ -18,8 +18,8 @@ With the Control API you can create and manage:
1818
* API keys for an Ably app
1919
* "Account and app statistics":/metadata-stats/stats
2020
* "Namespaces":/channels#namespaces (for channel rules)
21-
* "Queues":/general/queues
22-
* "Integration rules":/general/integrations
21+
* "Queues":/docs/general/queues
22+
* "Integration rules":/docs/general/integrations
2323

2424
Repetitive operations such as creating, updating or deleting Ably apps, enumerating queues, creation of rules, and other tasks that would be time-consuming to carry out manually, can be automated using the Control API.
2525

@@ -29,7 +29,7 @@ The following diagram illustrates an example use case:
2929
<img src="@content/screenshots/control-api/provision-and-test.png" style="width: 100%" alt="Provision and Test">
3030
</a>
3131

32-
In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/api/realtime-sdk or "REST API":/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
32+
In this use case, Control API is used to provision a sample app for review and testing purposes. Once provisioned, the "realtime":/docs/api/realtime-sdk or "REST API":/docs/api/rest-api can be used to test the app as needed. Once fully tested, the Control API can be used to replicate the app for users as required, using the known-good configuration.
3333

3434
In order to use the Control API you must first create an access token in the "Ably dashboard":https://ably.com/accounts/any. You can then use the Control API to manage many account functions without having to interact with the dashboard.
3535

@@ -123,7 +123,7 @@ Sample response:
123123

124124
h2(#ids). Account ID and app ID
125125

126-
Operations that affect your entire account, such as "listing the apps":/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
126+
Operations that affect your entire account, such as "listing the apps":/docs/api/control-api/#operation/listApps associated with that account, require an account ID. Those that affect individual apps, such as "creating an API key":/docs/api/control-api/#tag/keys/paths/~1apps~1{app_id}~1keys/post, require an app ID.
127127

128128
h3(#account-id). How to find your account ID
129129

@@ -178,7 +178,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
178178
}'
179179
```
180180

181-
See the "API reference":/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
181+
See the "API reference":/docs/api/control-api#tag/accounts/paths/~1accounts~1{account_id}~1stats/get for information on the request body.
182182

183183
Sample response, with @entries@ trimmed for readability:
184184

@@ -243,7 +243,7 @@ curl --location --request POST 'https://control.ably.net/v1/accounts/${ACCOUNT_I
243243
}'
244244
```
245245

246-
See the "API reference":/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
246+
See the "API reference":/docs/api/control-api/#tag/apps/paths/~1accounts~1{account_id}~1apps/post for information on the request body.
247247

248248
Sample response:
249249

@@ -302,7 +302,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/stats
302302
}'
303303
```
304304

305-
See the "API reference":/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
305+
See the "API reference":/docs/api/control-api#tag/apps/paths/~1apps~1{app_id}~1stats/get for information on the request body.
306306

307307
Sample response, with @entries@ trimmed for readability:
308308

@@ -325,7 +325,7 @@ Sample response, with @entries@ trimmed for readability:
325325

326326
h3(#examples-queues). Queues
327327

328-
You can use the Control API to manage "Ably queues":/general/queues. The main operations are:
328+
You can use the Control API to manage "Ably queues":/docs/general/queues. The main operations are:
329329

330330
* List all Ably queues
331331
* Create a queue
@@ -394,7 +394,7 @@ curl --location --request POST 'https://control.ably.net/v1/apps/${APP_ID}/queue
394394
}'
395395
```
396396

397-
See the "API reference":/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
397+
See the "API reference":/docs/api/control-api/#tag/queues/paths/~1apps~1{app_id}~1queues/post for information on the request body.
398398

399399
Sample response:
400400

@@ -577,7 +577,7 @@ In this case there is only a status code returned (200), or an error code.
577577

578578
h3(#examples-rules). Rules
579579

580-
You can use the Control API to manage Ably "integration rules":/general/integrations. The main operations are:
580+
You can use the Control API to manage Ably "integration rules":/docs/general/integrations. The main operations are:
581581

582582
* List all rules for an app
583583
* List details of a specific rule using rule ID
@@ -642,7 +642,7 @@ The rule details are returned for the specified rule.
642642

643643
h4(#examples-rules-create). Create a rule
644644

645-
The following example creates a rule with the following "configuration":/general/webhooks#configure:
645+
The following example creates a rule with the following "configuration":/docs/general/webhooks#configure:
646646

647647
|_. Parameter |_. Value |_. Description |
648648
| @ruleType@ | http | The type of rule, in this case a webhook rule |
@@ -653,7 +653,7 @@ The following example creates a rule with the following "configuration":/general
653653
| @format@ | json | Format of encoding for the rule, in this case JSON |
654654
| @name@ | User-Agent | Optional header or headers, including custom headers that might be required. In this case a user agent header is specified (this needs to be set for some providers) |
655655
| @value@ | user-agent-name | The value of the header |
656-
| @enveloped@ | true | Wrap packet in "metadata":/general/webhooks#envelope |
656+
| @enveloped@ | true | Wrap packet in "metadata":/docs/general/webhooks#envelope |
657657

658658
The corresponding request is:
659659

@@ -827,4 +827,4 @@ Now that you have obtained the token and IDs, you can learn how to send a reques
827827
<img src="@content/screenshots/control-api/list-apps-response.png" style="width: 70%" alt="Response">
828828
</a>
829829

830-
You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/api/control-api for further information.
830+
You can now try out other requests. You need to set the necessary parameters and authentication token as required by that specific request. Consult the "API Reference":/docs/api/control-api for further information.

content/api/index.textile

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ This section of the documentation contains the API references for Ably.
1717

1818
The following API references are available:
1919

20-
* "Client library Realtime SDK":/api/realtime-sdk
21-
* "Client library REST SDK":/api/rest-sdk
22-
* "REST API":/api/rest-api
23-
* "SSE API":/api/sse
24-
* "Control API":/api/control-api
20+
* "Client library Realtime SDK":/docs/api/realtime-sdk
21+
* "Client library REST SDK":/docs/api/rest-sdk
22+
* "REST API":/docs/api/rest-api
23+
* "SSE API":/docs/api/sse
24+
* "Control API":/docs/api/control-api
2525

2626
h2(#sdks). Client library SDKs
2727

2828
Depending on availability, an Ably client library SDK may support both a realtime interface and a REST interface. Some SDKs only provide a REST interface. You can check availability on the "SDK page":https://ably.com/download.
2929

30-
The "realtime interface":/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
30+
The "realtime interface":/docs/api/realtime-sdk allows your client to both publish and subscribe to a channel, but the REST interface only allows you to publish to a channel. The "REST interface":/docs/api/rest-sdk can also be used for non-recurring operations such as obtaining statistics, or checking status. The REST interface has less resource impact, as it is much simpler than the realtime interface.
3131

3232
Typically the REST interface is used on the server, as the server's main task is to authenticate clients, but does not usually need to subscribe to a channel to obtain realtime events.
3333

@@ -47,15 +47,15 @@ The SDKs that have API references generated from source code are:
4747

4848
h2(#rest-api). REST API
4949

50-
A raw "REST API":/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
50+
A raw "REST API":/docs/api/rest-api is also provided - you don't need to install any SDK to use this. This is used where an Ably client library SDK is not available for your chosen platform, or you do not wish to use a client library SDK due to resource constraints.
5151

5252
h2(#sse-api). SSE API
5353

54-
The "Ably Server-Sent Events API":/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
54+
The "Ably Server-Sent Events API":/docs/api/sse, and raw HTTP streaming API, provide a way to get a realtime stream of events from Ably in circumstances where using a full Ably Realtime client library, or even an MQTT library, is impractical due to resource constraints. HTTP streaming can be used where an SSE client is not supported.
5555

5656
h2(#control-api). Control API
5757

58-
"Ably Control API":/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
58+
"Ably Control API":/docs/api/control-api is a REST API that enables you to manage your Ably account programmatically. The Control API also enables you to build web apps and command-line tools, to create and manage your Ably realtime infrastructure.
5959

6060
h2(#spaces). Spaces SDK
6161

0 commit comments

Comments
 (0)