Fix various broken links

ptarmiganlabs · Apr 18, 2024 · ca5eab8 · ca5eab8
1 parent c8bfcdf
commit ca5eab8
Show file tree

Hide file tree

Showing 23 changed files with 61 additions and 33 deletions.
diff --git a/content/en/docs/about/use cases/_index.md b/content/en/docs/about/use cases/_index.md
@@ -84,16 +84,16 @@ 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
 
 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](/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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -106,12 +106,12 @@ This makes it easy to find the log file you are interested in.&lt;/p&gt;
 &lt;p&gt;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.&lt;br&gt;
 Starting a task from the reload script is as easy as &lt;code&gt;Call StartTask(&#39;fbf645f0-0c92-40a4-af9a-6e3eb1d3c35c&#39;)&lt;/code&gt;.&lt;/p&gt;
 &lt;p&gt;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.&lt;/p&gt;
-&lt;p&gt;Starting reload tasks using REST API is described &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;br&gt;
-Using MQTT messages to achieve this is described &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task-from-mqtt/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
+&lt;p&gt;Starting reload tasks using REST API is described &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;br&gt;
+Using MQTT messages to achieve this is described &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-mqtt/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
 &lt;h2 id=&#34;start-any-reload-task-from-within-any-qlik-sense-or-web-app&#34;&gt;Start any reload task from within any Qlik Sense or web app&lt;/h2&gt;
 &lt;p&gt;Some HTML and Javascript magic is also needed, but given Butler&amp;rsquo;s start-task API it&amp;rsquo;s pretty easy to set up a button in a Sense app (or any web app!) to start any Sense reload task.&lt;/p&gt;
 &lt;p&gt;This can for example be used to allow end users to start an Extract-Transform when they (the user) need refreshed data.&lt;/p&gt;
-&lt;p&gt;More info &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
+&lt;p&gt;More info &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
 &lt;h2 id=&#34;start-reload-tasks-via-rest-api-based-on-task-tags-or-custom-properties&#34;&gt;Start reload tasks via REST API based on task tags or custom properties&lt;/h2&gt;
 &lt;p&gt;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.&lt;/p&gt;

diff --git a/docs/docs/about/printview/index.html b/docs/docs/about/printview/index.html
@@ -297,12 +297,12 @@ <h2 id="start-reload-tasks-from-load-script-or-from-upstream-systems">Start relo
 <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="/docs/examples/start-task-from-rest/">here</a>.<br>
-Using MQTT messages to achieve this is described <a href="/docs/examples/start-task-from-mqtt/">here</a>.</p>
+<p>Starting reload tasks using REST API is described <a href="/docs/examples/start-task/start-task-from-rest/">here</a>.<br>
+Using MQTT messages to achieve this is described <a href="/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="/docs/examples/start-task-from-rest/">here</a>.</p>
+<p>More info <a href="/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/use-cases/index.html b/docs/docs/about/use-cases/index.html
@@ -522,12 +522,12 @@ <h2 id="start-reload-tasks-from-load-script-or-from-upstream-systems">Start relo
 <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="/docs/examples/start-task-from-rest/">here</a>.<br>
-Using MQTT messages to achieve this is described <a href="/docs/examples/start-task-from-mqtt/">here</a>.</p>
+<p>Starting reload tasks using REST API is described <a href="/docs/examples/start-task/start-task-from-rest/">here</a>.<br>
+Using MQTT messages to achieve this is described <a href="/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="/docs/examples/start-task-from-rest/">here</a>.</p>
+<p>More info <a href="/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/use-cases/printview/index.html b/docs/docs/about/use-cases/printview/index.html
@@ -165,12 +165,12 @@ <h2 id="start-reload-tasks-from-load-script-or-from-upstream-systems">Start relo
 <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="/docs/examples/start-task-from-rest/">here</a>.<br>
-Using MQTT messages to achieve this is described <a href="/docs/examples/start-task-from-mqtt/">here</a>.</p>
+<p>Starting reload tasks using REST API is described <a href="/docs/examples/start-task/start-task-from-rest/">here</a>.<br>
+Using MQTT messages to achieve this is described <a href="/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="/docs/examples/start-task-from-rest/">here</a>.</p>
+<p>More info <a href="/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/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
 &lt;p&gt;Or simply: Notifications are usually (always?) a better solution than polling for new data.&lt;/p&gt;
 &lt;p&gt;The good news is that Butler includes solid support for starting Sense tasks from 3rd party systems.&lt;/p&gt;
 &lt;p&gt;Below the concept is described on a high level.&lt;br&gt;
-Actual examples are available &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
+Actual examples are available &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-rest/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
 &lt;h2 id=&#34;start-tasks-by-ids-tags-and-custom-properties&#34;&gt;Start tasks by IDs, tags and custom properties&lt;/h2&gt;
 &lt;p&gt;Butler&amp;rsquo;s &lt;code&gt;/v4/reloadtask/&amp;lt;taskid&amp;gt;/start&lt;/code&gt; API endpoint is used to start tasks.&lt;br&gt;
 For historical reasons there are two variants: POST and PUT. Both do the exactly the same though.&lt;/p&gt;
@@ -413,7 +413,7 @@ Which in MQTT lingo means &amp;ldquo;listen to all messages in the this topic, a
 &lt;ul&gt;
 &lt;li&gt;Start Sense task. The exact topic is defined in config property &lt;code&gt;Butler.mqttConfig.taskStartTopic&lt;/code&gt;.&lt;br&gt;
 Note that this topic &lt;em&gt;must&lt;/em&gt; be a subtopic to the topic specified in &lt;code&gt;Butler.mqttConfig.subscriptionRootTopic&lt;/code&gt;!&lt;br&gt;
-Starts the Sense task identified by the ID sent in the message body. More info in the &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks&#34;&gt;examples&lt;/a&gt; section.&lt;/li&gt;
+Starts the Sense task identified by the ID sent in the message body. More info in the &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/start-task/start-task-from-mqtt/#use-mqtt-to-start-sense-tasks&#34;&gt;examples&lt;/a&gt; section.&lt;/li&gt;
 &lt;/ul&gt;
 &lt;p&gt;As Butler listens to all messages in the topic tree specified by &lt;code&gt;Butler.mqttConfig.subscriptionRootTopic&lt;/code&gt; it can easily be extended with handlers for additional topics.&lt;/p&gt;
 

diff --git a/docs/docs/concepts/mqtt/index.html b/docs/docs/concepts/mqtt/index.html
@@ -485,7 +485,7 @@ <h2 id="incoming-mqtt---subscribe">Incoming MQTT - subscribe</h2>
 <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="/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="/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/printview/index.html b/docs/docs/concepts/mqtt/printview/index.html
@@ -137,7 +137,7 @@ <h2 id="incoming-mqtt---subscribe">Incoming MQTT - subscribe</h2>
 <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="/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="/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/printview/index.html b/docs/docs/concepts/printview/index.html
@@ -1305,7 +1305,7 @@ <h2 id="whats-wrong-with-starting-tasks-from-the-qmc">What&rsquo;s wrong with st
 <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="/docs/examples/start-task-from-rest/">here</a>.</p>
+Actual examples are available <a href="/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>
@@ -1855,7 +1855,7 @@ <h2 id="incoming-mqtt---subscribe">Incoming MQTT - subscribe</h2>
 <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="/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="/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/start-sense-tasks/index.html b/docs/docs/concepts/start-sense-tasks/index.html
@@ -464,7 +464,7 @@ <h2 id="whats-wrong-with-starting-tasks-from-the-qmc">What&rsquo;s wrong with st
 <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="/docs/examples/start-task-from-rest/">here</a>.</p>
+Actual examples are available <a href="/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>