From ca5eab8ef4d272fafc7605318286053f49662de7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=B6ran=20Sander?= Date: Thu, 18 Apr 2024 13:01:43 +0200 Subject: [PATCH] Fix various broken links --- content/en/docs/about/use cases/_index.md | 6 +++--- content/en/docs/concepts/mqtt/_index.md | 2 +- content/en/docs/concepts/start sense tasks/_index.md | 2 +- .../en/docs/getting started/setup/rest api/_index.md | 2 ++ .../getting started/setup/start task filter/_index.md | 2 ++ content/en/docs/reference/InfluxDB/_index.md | 2 ++ content/en/docs/reference/rest api 1/_index.md | 2 ++ docs/docs/about/index.xml | 6 +++--- docs/docs/about/printview/index.html | 6 +++--- docs/docs/about/use-cases/index.html | 6 +++--- docs/docs/about/use-cases/printview/index.html | 6 +++--- docs/docs/concepts/index.xml | 4 ++-- docs/docs/concepts/mqtt/index.html | 2 +- docs/docs/concepts/mqtt/printview/index.html | 2 +- docs/docs/concepts/printview/index.html | 4 ++-- docs/docs/concepts/start-sense-tasks/index.html | 2 +- .../concepts/start-sense-tasks/printview/index.html | 2 +- docs/docs/printview/index.html | 10 +++++----- docs/docs/reference/rest-api-1/index.html | 2 +- docs/docs/reference/rest-api-1/printview/index.html | 2 +- docs/docs/reference/rest_api/index.html | 10 ++++++++++ docs/printview/docs/reference/rest_api/index.html | 10 ++++++++++ docs/sitemap.xml | 2 +- 23 files changed, 61 insertions(+), 33 deletions(-) create mode 100644 docs/docs/reference/rest_api/index.html create mode 100644 docs/printview/docs/reference/rest_api/index.html diff --git a/content/en/docs/about/use cases/_index.md b/content/en/docs/about/use cases/_index.md index 9359cd66..c66213c6 100644 --- a/content/en/docs/about/use cases/_index.md +++ b/content/en/docs/about/use cases/_index.md @@ -84,8 +84,8 @@ Starting a task from the reload script is as easy as `Call StartTask('fbf645f0-0 Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible. -Starting reload tasks using REST API is described [here](/docs/examples/start-task-from-rest/). -Using MQTT messages to achieve this is described [here](/docs/examples/start-task-from-mqtt/). +Starting reload tasks using REST API is described [here](/docs/examples/start-task/start-task-from-rest/). +Using MQTT messages to achieve this is described [here](/docs/examples/start-task/start-task-from-mqtt/). ## Start any reload task from within any Qlik Sense or web app @@ -93,7 +93,7 @@ Some HTML and Javascript magic is also needed, but given Butler's start-task API This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data. -More info [here](/docs/examples/start-task-from-rest/). +More info [here](/docs/examples/start-task/start-task-from-rest/). ## Start reload tasks via REST API based on task tags or custom properties diff --git a/content/en/docs/concepts/mqtt/_index.md b/content/en/docs/concepts/mqtt/_index.md index 3b216d6c..4a38454e 100644 --- a/content/en/docs/concepts/mqtt/_index.md +++ b/content/en/docs/concepts/mqtt/_index.md @@ -42,6 +42,6 @@ Topics with special meaning are: * Start Sense task. The exact topic is defined in config property `Butler.mqttConfig.taskStartTopic`. Note that this topic *must* be a subtopic to the topic specified in `Butler.mqttConfig.subscriptionRootTopic`! - Starts the Sense task identified by the ID sent in the message body. More info in the [examples](/docs/examples/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks) section. + Starts the Sense task identified by the ID sent in the message body. More info in the [examples](/docs/examples/start-task/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks) section. As Butler listens to all messages in the topic tree specified by `Butler.mqttConfig.subscriptionRootTopic` it can easily be extended with handlers for additional topics. diff --git a/content/en/docs/concepts/start sense tasks/_index.md b/content/en/docs/concepts/start sense tasks/_index.md index aebab8a2..fca9c3d1 100644 --- a/content/en/docs/concepts/start sense tasks/_index.md +++ b/content/en/docs/concepts/start sense tasks/_index.md @@ -21,7 +21,7 @@ Or simply: Notifications are usually (always?) a better solution than polling fo The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems. Below the concept is described on a high level. -Actual examples are available [here](/docs/examples/start-task-from-rest/). +Actual examples are available [here](/docs/examples/start-task/start-task-from-rest/). ## Start tasks by IDs, tags and custom properties diff --git a/content/en/docs/getting started/setup/rest api/_index.md b/content/en/docs/getting started/setup/rest api/_index.md index afb76190..20a58cdb 100644 --- a/content/en/docs/getting started/setup/rest api/_index.md +++ b/content/en/docs/getting started/setup/rest api/_index.md @@ -2,6 +2,8 @@ title: "Configuring Butler's REST API" linkTitle: "REST API" weight: 30 +alias: + - /docs/getting-started/setup/api-endpoints/ description: > Butler's REST API can be enabled/disabled in itself. If the API is enabled, individual API endpoints can then be enabled/disabled as needed. diff --git a/content/en/docs/getting started/setup/start task filter/_index.md b/content/en/docs/getting started/setup/start task filter/_index.md index fb0da551..0cf2c5ec 100644 --- a/content/en/docs/getting started/setup/start task filter/_index.md +++ b/content/en/docs/getting started/setup/start task filter/_index.md @@ -2,6 +2,8 @@ title: "Control which tasks can be started via Butler's API" linkTitle: "Start task filter" weight: 305 +alias: + - /docs/getting-started/setup/task-filter/ description: > Qlik Sense tasks can be started using Butler's REST API. diff --git a/content/en/docs/reference/InfluxDB/_index.md b/content/en/docs/reference/InfluxDB/_index.md index e9909868..a041a485 100644 --- a/content/en/docs/reference/InfluxDB/_index.md +++ b/content/en/docs/reference/InfluxDB/_index.md @@ -2,6 +2,8 @@ title: "Information stored in InfluxDB" linkTitle: "InfluxDB" weight: 55 +alias: + - /docs/examples/influxdb-metrics description: > Butler stores a lot of information in InfluxDB. This page describes the different measurements and tags that Butler send to InfluxDB. --- diff --git a/content/en/docs/reference/rest api 1/_index.md b/content/en/docs/reference/rest api 1/_index.md index b9267821..7f514a5b 100644 --- a/content/en/docs/reference/rest api 1/_index.md +++ b/content/en/docs/reference/rest api 1/_index.md @@ -3,6 +3,8 @@ title: "REST API documentation" linkTitle: "REST API 1" type: swagger weight: 20 +aliases: + - /docs/reference/rest_api description: > OpenAPI/Swagger style documentation for the Butler API. diff --git a/docs/docs/about/index.xml b/docs/docs/about/index.xml index 52d5fb07..3c9ad0ef 100644 --- a/docs/docs/about/index.xml +++ b/docs/docs/about/index.xml @@ -106,12 +106,12 @@ This makes it easy to find the log file you are interested in.</p> <p>Trigger Sense reload tasks from a reload script: This makes it possible to start different Sense tasks based on what data has been read from a database, what time of day it is etc.<br> Starting a task from the reload script is as easy as <code>Call StartTask('fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c')</code>.</p> <p>Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible.</p> -<p>Starting reload tasks using REST API is described <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/">here</a>.<br> -Using MQTT messages to achieve this is described <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task-from-mqtt/">here</a>.</p> +<p>Starting reload tasks using REST API is described <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/">here</a>.<br> +Using MQTT messages to achieve this is described <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-mqtt/">here</a>.</p> <h2 id="start-any-reload-task-from-within-any-qlik-sense-or-web-app">Start any reload task from within any Qlik Sense or web app</h2> <p>Some HTML and Javascript magic is also needed, but given Butler&rsquo;s start-task API it&rsquo;s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.</p> <p>This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.</p> -<p>More info <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/">here</a>.</p> +<p>More info <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/">here</a>.</p> <h2 id="start-reload-tasks-via-rest-api-based-on-task-tags-or-custom-properties">Start reload tasks via REST API based on task tags or custom properties</h2> <p>Using tags and/or custom properties to identify what tasks should be started can be easier than having to know the tasks IDs. This both makes it easier for 3rd party systems to start Qlik Sense tasks and easier for Sense admins to manage which tasks should be startable by 3rd party systems.</p> diff --git a/docs/docs/about/printview/index.html b/docs/docs/about/printview/index.html index 8f603d16..06dbaa75 100644 --- a/docs/docs/about/printview/index.html +++ b/docs/docs/about/printview/index.html @@ -297,12 +297,12 @@

Start relo

Trigger Sense reload tasks from a reload script: This makes it possible to start different Sense tasks based on what data has been read from a database, what time of day it is etc.
Starting a task from the reload script is as easy as Call StartTask('fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c').

Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible.

-

Starting reload tasks using REST API is described here.
-Using MQTT messages to achieve this is described here.

+

Starting reload tasks using REST API is described here.
+Using MQTT messages to achieve this is described here.

Start any reload task from within any Qlik Sense or web app

Some HTML and Javascript magic is also needed, but given Butler’s start-task API it’s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.

This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.

-

More info here.

+

More info here.

Start reload tasks via REST API based on task tags or custom properties

Using tags and/or custom properties to identify what tasks should be started can be easier than having to know the tasks IDs. This both makes it easier for 3rd party systems to start Qlik Sense tasks and easier for Sense admins to manage which tasks should be startable by 3rd party systems.

diff --git a/docs/docs/about/use-cases/index.html b/docs/docs/about/use-cases/index.html index e4048407..2179a476 100644 --- a/docs/docs/about/use-cases/index.html +++ b/docs/docs/about/use-cases/index.html @@ -522,12 +522,12 @@

Start relo

Trigger Sense reload tasks from a reload script: This makes it possible to start different Sense tasks based on what data has been read from a database, what time of day it is etc.
Starting a task from the reload script is as easy as Call StartTask('fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c').

Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible.

-

Starting reload tasks using REST API is described here.
-Using MQTT messages to achieve this is described here.

+

Starting reload tasks using REST API is described here.
+Using MQTT messages to achieve this is described here.

Start any reload task from within any Qlik Sense or web app

Some HTML and Javascript magic is also needed, but given Butler’s start-task API it’s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.

This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.

-

More info here.

+

More info here.

Start reload tasks via REST API based on task tags or custom properties

Using tags and/or custom properties to identify what tasks should be started can be easier than having to know the tasks IDs. This both makes it easier for 3rd party systems to start Qlik Sense tasks and easier for Sense admins to manage which tasks should be startable by 3rd party systems.

diff --git a/docs/docs/about/use-cases/printview/index.html b/docs/docs/about/use-cases/printview/index.html index c5d4d77b..447e2aa4 100644 --- a/docs/docs/about/use-cases/printview/index.html +++ b/docs/docs/about/use-cases/printview/index.html @@ -165,12 +165,12 @@

Start relo

Trigger Sense reload tasks from a reload script: This makes it possible to start different Sense tasks based on what data has been read from a database, what time of day it is etc.
Starting a task from the reload script is as easy as Call StartTask('fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c').

Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible.

-

Starting reload tasks using REST API is described here.
-Using MQTT messages to achieve this is described here.

+

Starting reload tasks using REST API is described here.
+Using MQTT messages to achieve this is described here.

Start any reload task from within any Qlik Sense or web app

Some HTML and Javascript magic is also needed, but given Butler’s start-task API it’s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.

This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.

-

More info here.

+

More info here.

Start reload tasks via REST API based on task tags or custom properties

Using tags and/or custom properties to identify what tasks should be started can be easier than having to know the tasks IDs. This both makes it easier for 3rd party systems to start Qlik Sense tasks and easier for Sense admins to manage which tasks should be startable by 3rd party systems.

diff --git a/docs/docs/concepts/index.xml b/docs/docs/concepts/index.xml index b1bfc7da..235d37a6 100644 --- a/docs/docs/concepts/index.xml +++ b/docs/docs/concepts/index.xml @@ -254,7 +254,7 @@ Consider a Sense environment that gets its data from some source system, for exa <p>Or simply: Notifications are usually (always?) a better solution than polling for new data.</p> <p>The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.</p> <p>Below the concept is described on a high level.<br> -Actual examples are available <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/">here</a>.</p> +Actual examples are available <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/">here</a>.</p> <h2 id="start-tasks-by-ids-tags-and-custom-properties">Start tasks by IDs, tags and custom properties</h2> <p>Butler&rsquo;s <code>/v4/reloadtask/&lt;taskid&gt;/start</code> API endpoint is used to start tasks.<br> For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.</p> @@ -413,7 +413,7 @@ Which in MQTT lingo means &ldquo;listen to all messages in the this topic, a <ul> <li>Start Sense task. The exact topic is defined in config property <code>Butler.mqttConfig.taskStartTopic</code>.<br> Note that this topic <em>must</em> be a subtopic to the topic specified in <code>Butler.mqttConfig.subscriptionRootTopic</code>!<br> -Starts the Sense task identified by the ID sent in the message body. More info in the <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks">examples</a> section.</li> +Starts the Sense task identified by the ID sent in the message body. More info in the <a href="https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks">examples</a> section.</li> </ul> <p>As Butler listens to all messages in the topic tree specified by <code>Butler.mqttConfig.subscriptionRootTopic</code> it can easily be extended with handlers for additional topics.</p> diff --git a/docs/docs/concepts/mqtt/index.html b/docs/docs/concepts/mqtt/index.html index 9c04957d..e59f9222 100644 --- a/docs/docs/concepts/mqtt/index.html +++ b/docs/docs/concepts/mqtt/index.html @@ -485,7 +485,7 @@

Incoming MQTT - subscribe

As Butler listens to all messages in the topic tree specified by Butler.mqttConfig.subscriptionRootTopic it can easily be extended with handlers for additional topics.

diff --git a/docs/docs/concepts/mqtt/printview/index.html b/docs/docs/concepts/mqtt/printview/index.html index ed4192a5..1475f397 100644 --- a/docs/docs/concepts/mqtt/printview/index.html +++ b/docs/docs/concepts/mqtt/printview/index.html @@ -137,7 +137,7 @@

Incoming MQTT - subscribe

As Butler listens to all messages in the topic tree specified by Butler.mqttConfig.subscriptionRootTopic it can easily be extended with handlers for additional topics.

diff --git a/docs/docs/concepts/printview/index.html b/docs/docs/concepts/printview/index.html index baca85b3..660e0d10 100644 --- a/docs/docs/concepts/printview/index.html +++ b/docs/docs/concepts/printview/index.html @@ -1305,7 +1305,7 @@

What’s wrong with st

Or simply: Notifications are usually (always?) a better solution than polling for new data.

The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.

Below the concept is described on a high level.
-Actual examples are available here.

+Actual examples are available here.

Start tasks by IDs, tags and custom properties

Butler’s /v4/reloadtask/<taskid>/start API endpoint is used to start tasks.
For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.

@@ -1855,7 +1855,7 @@

Incoming MQTT - subscribe

As Butler listens to all messages in the topic tree specified by Butler.mqttConfig.subscriptionRootTopic it can easily be extended with handlers for additional topics.

diff --git a/docs/docs/concepts/start-sense-tasks/index.html b/docs/docs/concepts/start-sense-tasks/index.html index ef4b1153..05bd4805 100644 --- a/docs/docs/concepts/start-sense-tasks/index.html +++ b/docs/docs/concepts/start-sense-tasks/index.html @@ -464,7 +464,7 @@

What’s wrong with st

Or simply: Notifications are usually (always?) a better solution than polling for new data.

The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.

Below the concept is described on a high level.
-Actual examples are available here.

+Actual examples are available here.

Start tasks by IDs, tags and custom properties

Butler’s /v4/reloadtask/<taskid>/start API endpoint is used to start tasks.
For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.

diff --git a/docs/docs/concepts/start-sense-tasks/printview/index.html b/docs/docs/concepts/start-sense-tasks/printview/index.html index f9f88430..c86f272f 100644 --- a/docs/docs/concepts/start-sense-tasks/printview/index.html +++ b/docs/docs/concepts/start-sense-tasks/printview/index.html @@ -112,7 +112,7 @@

What’s wrong with st

Or simply: Notifications are usually (always?) a better solution than polling for new data.

The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.

Below the concept is described on a high level.
-Actual examples are available here.

+Actual examples are available here.

Start tasks by IDs, tags and custom properties

Butler’s /v4/reloadtask/<taskid>/start API endpoint is used to start tasks.
For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.

diff --git a/docs/docs/printview/index.html b/docs/docs/printview/index.html index 10a681c4..6bcfb78c 100644 --- a/docs/docs/printview/index.html +++ b/docs/docs/printview/index.html @@ -2727,12 +2727,12 @@

Start relo

Trigger Sense reload tasks from a reload script: This makes it possible to start different Sense tasks based on what data has been read from a database, what time of day it is etc.
Starting a task from the reload script is as easy as Call StartTask('fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c').

Trigger Sense reloads from external systems: When new data is available in a source database, that database can trigger a reload in Sense, and the data is loaded from the database into Sense. This way delays caused by Sense polling for data are minimized and data arrives at end users as quickly as possible.

-

Starting reload tasks using REST API is described here.
-Using MQTT messages to achieve this is described here.

+

Starting reload tasks using REST API is described here.
+Using MQTT messages to achieve this is described here.

Start any reload task from within any Qlik Sense or web app

Some HTML and Javascript magic is also needed, but given Butler’s start-task API it’s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.

This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.

-

More info here.

+

More info here.

Start reload tasks via REST API based on task tags or custom properties

Using tags and/or custom properties to identify what tasks should be started can be easier than having to know the tasks IDs. This both makes it easier for 3rd party systems to start Qlik Sense tasks and easier for Sense admins to manage which tasks should be startable by 3rd party systems.

@@ -9250,7 +9250,7 @@

What’s wrong with st

Or simply: Notifications are usually (always?) a better solution than polling for new data.

The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.

Below the concept is described on a high level.
-Actual examples are available here.

+Actual examples are available here.

Start tasks by IDs, tags and custom properties

Butler’s /v4/reloadtask/<taskid>/start API endpoint is used to start tasks.
For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.

@@ -9800,7 +9800,7 @@

Incoming MQTT - subscribe

As Butler listens to all messages in the topic tree specified by Butler.mqttConfig.subscriptionRootTopic it can easily be extended with handlers for additional topics.

diff --git a/docs/docs/reference/rest-api-1/index.html b/docs/docs/reference/rest-api-1/index.html index 854f065e..76a61c0f 100644 --- a/docs/docs/reference/rest-api-1/index.html +++ b/docs/docs/reference/rest-api-1/index.html @@ -486,7 +486,7 @@

Remember

- Last modified 2022-06-21: Docs for Butler 8.3.2 (6893708) + Last modified 2024-04-15: Fix broken links (c8bfcdf)
diff --git a/docs/docs/reference/rest-api-1/printview/index.html b/docs/docs/reference/rest-api-1/printview/index.html index 2e97e1e2..8a1fc4d8 100644 --- a/docs/docs/reference/rest-api-1/printview/index.html +++ b/docs/docs/reference/rest-api-1/printview/index.html @@ -485,7 +485,7 @@

Remember

- Last modified 2022-06-21: Docs for Butler 8.3.2 (6893708) + Last modified 2024-04-15: Fix broken links (c8bfcdf)
diff --git a/docs/docs/reference/rest_api/index.html b/docs/docs/reference/rest_api/index.html new file mode 100644 index 00000000..9ec63557 --- /dev/null +++ b/docs/docs/reference/rest_api/index.html @@ -0,0 +1,10 @@ + + + + https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/ + + + + + + diff --git a/docs/printview/docs/reference/rest_api/index.html b/docs/printview/docs/reference/rest_api/index.html new file mode 100644 index 00000000..2b86415b --- /dev/null +++ b/docs/printview/docs/reference/rest_api/index.html @@ -0,0 +1,10 @@ + + + + https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/printview/ + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 4c9e7ce0..3585cc7a 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -90,7 +90,7 @@ 2024-04-15T12:39:58+02:00 https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/ - 2022-06-21T09:33:35+02:00 + 2024-04-15T12:49:02+02:00 https://butler.ptarmiganlabs.com/docs/concepts/scheduler/ 2024-04-15T12:16:15+02:00