Fix broken links

ptarmiganlabs · Apr 15, 2024 · 8641b15 · 8641b15
1 parent 2413b5c
commit 8641b15
Show file tree

Hide file tree

Showing 39 changed files with 60 additions and 60 deletions.
diff --git a/content/en/docs/about/use cases/_index.md b/content/en/docs/about/use cases/_index.md
@@ -168,7 +168,7 @@ More info [here](/docs/examples/file-copy-move-delete/).
 
 Exporting apps as JSON can be very useful for backup purposes. Doing regular snapshots of all apps in a Sense cluster is a fast and space-effective way of keeping point-in-time backups.
 
-The [REST API documentation](http://localhost:1313/docs/reference/rest-api/?operationsSorter=alpha) has full docs for the `/v4/app/{appId}/dump` endpoint.
+The [REST API documentation](/docs/reference/rest-api-1/?operationsSorter=alpha) has full docs for the `/v4/app/{appId}/dump` endpoint.
 
 ## Easily post messages to Slack
 

diff --git a/content/en/docs/about/use cases/retired.md b/content/en/docs/about/use cases/retired.md
@@ -20,8 +20,8 @@ There was also the risk of Butler missing UDP messages and not registering the a
 
 The affected API endpoints are:
 
-[/v4/activeusercount](/docs/reference/rest-api/?operationsSorter=alpha)  
-[/v4/activeusers](/docs/reference/rest-api/?operationsSorter=alpha)
+[/v4/activeusercount](/docs/reference/rest-api-1/?operationsSorter=alpha)  
+[/v4/activeusers](/docs/reference/rest-api-1/?operationsSorter=alpha)
 
 {{% alert title="Tip: Butler SOS" color="info" %}}
 The shortcomings above lead to the creation of the Butler SOS project, which has over the years evolved into a very comprehensive open source tool for professional grade, real-time monitoring of Qlik Sense.

diff --git a/content/en/docs/concepts/file system access/_index.md b/content/en/docs/concepts/file system access/_index.md
@@ -30,7 +30,7 @@ You also need to remove old QVDs from that folder.
 
 This could be done with scheduled BAT/CMD files or PowerShell scripts, but it might be better/more flexible/easier/preferred to do this cleanup from the load script of a Sense app.
 
-The solution: Add `e:\data\qvd\sales\temp` to Butler's list of folders in which files can be deleted, then call Butler's `/v4/filedelete` [API endpoint](/docs/reference/rest-api/?operationsSorter=alpha) from within your app's load script. Done!
+The solution: Add `e:\data\qvd\sales\temp` to Butler's list of folders in which files can be deleted, then call Butler's `/v4/filedelete` [API endpoint](/docs/reference/rest-api-1/?operationsSorter=alpha) from within your app's load script. Done!
 
 ## Convenience subs
 

diff --git a/content/en/docs/examples/Sense demo apps/Partial loads/_index.md b/content/en/docs/examples/Sense demo apps/Partial loads/_index.md
@@ -14,7 +14,7 @@ description: >
 
 ## Partial reload API
 
-The full API documentation is available in the [Reference section](/docs/reference/rest-api/?operationsSorter=alpha), here we're interested in the PUT `/v4/app/{appId}/reload` endpoint.
+The full API documentation is available in the [Reference section](/docs/reference/rest-api-1/?operationsSorter=alpha), here we're interested in the PUT `/v4/app/{appId}/reload` endpoint.
 
 ## Demo apps for partial reloads
 

diff --git a/content/en/docs/getting started/setup/key-value store/_index.md b/content/en/docs/getting started/setup/key-value store/_index.md
@@ -20,7 +20,7 @@ The key-value has several use cases:
 The data in the key-value store is *not* persisted to disk, which means that key-value data will be lost if Butler is restarted.  
 This behaviour could possibly be changed if there is a need, please open a [GitHub ticket](https://github.com/ptarmiganlabs/butler/issues) if key-value persistence is of interest.
 
-Key-value data is manipulated using Butler's [REST API](/docs/reference/rest-api/?operationsSorter=alpha).
+Key-value data is manipulated using Butler's [REST API](/docs/reference/rest-api-1/?operationsSorter=alpha).
 
 The [Reference docs](/docs/reference/key-value/) section has more information about the key-value store.
 

diff --git a/content/en/docs/getting started/setup/mqtt/_index.md b/content/en/docs/getting started/setup/mqtt/_index.md
@@ -14,7 +14,7 @@ MQTT has features such as guaranteed delivery of messages, which makes it very u
 
 Butler can be configured to forward events from Sense (reload task failures, aborted reload tasks, windows services starting/stopping, user session start/stop etc) as MQTT messages.
 
-Butler's [REST API](/docs/reference/rest-api/?operationsSorter=alpha) also has an endpoint that makes it possible to send MQTT messages from Sense apps' load scripts.
+Butler's [REST API](/docs/reference/rest-api-1/?operationsSorter=alpha) also has an endpoint that makes it possible to send MQTT messages from Sense apps' load scripts.
 
 ### Defining what MQTT broker/server to connect to
 

diff --git a/content/en/docs/reference/key-value/_index.md b/content/en/docs/reference/key-value/_index.md
@@ -8,7 +8,7 @@ description: >
 
 ## Key-value store overview
 
-The [API documentation](/docs/reference/rest-api/?operationsSorter=alpha) is the best, most complete source of information about the key-value API endpoints.
+The [API documentation](/docs/reference/rest-api-1/?operationsSorter=alpha) is the best, most complete source of information about the key-value API endpoints.
 
 ## Namespaces
 

diff --git a/docs/docs/about/index.xml b/docs/docs/about/index.xml
@@ -151,7 +151,7 @@ MQTT (and the pubsub concept in general) is a great way for systems to communica
 &lt;p&gt;More info &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/examples/file-copy-move-delete/&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
 &lt;h2 id=&#34;extract-metadata-for-apps&#34;&gt;Extract metadata for apps&lt;/h2&gt;
 &lt;p&gt;Exporting apps as JSON can be very useful for backup purposes. Doing regular snapshots of all apps in a Sense cluster is a fast and space-effective way of keeping point-in-time backups.&lt;/p&gt;
-&lt;p&gt;The &lt;a href=&#34;http://localhost:1313/docs/reference/rest-api/?operationsSorter=alpha&#34;&gt;REST API documentation&lt;/a&gt; has full docs for the &lt;code&gt;/v4/app/{appId}/dump&lt;/code&gt; endpoint.&lt;/p&gt;
+&lt;p&gt;The &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/?operationsSorter=alpha&#34;&gt;REST API documentation&lt;/a&gt; has full docs for the &lt;code&gt;/v4/app/{appId}/dump&lt;/code&gt; endpoint.&lt;/p&gt;
 &lt;h2 id=&#34;easily-post-messages-to-slack&#34;&gt;Easily post messages to Slack&lt;/h2&gt;
 &lt;p&gt;Slack messages can include full formatting (web links, text formatting etc), as well as &amp;ldquo;poking&amp;rdquo; users.&lt;br&gt;
 I.e. notifying specific Slack users that they have a new message.&lt;/p&gt;

diff --git a/docs/docs/about/printview/index.html b/docs/docs/about/printview/index.html
@@ -342,7 +342,7 @@ <h2 id="create-directories-copymovedelete-files">Create directories, copy/move/d
 <p>More info <a href="/docs/examples/file-copy-move-delete/">here</a>.</p>
 <h2 id="extract-metadata-for-apps">Extract metadata for apps</h2>
 <p>Exporting apps as JSON can be very useful for backup purposes. Doing regular snapshots of all apps in a Sense cluster is a fast and space-effective way of keeping point-in-time backups.</p>
-<p>The <a href="http://localhost:1313/docs/reference/rest-api/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
+<p>The <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
 <h2 id="easily-post-messages-to-slack">Easily post messages to Slack</h2>
 <p>Slack messages can include full formatting (web links, text formatting etc), as well as &ldquo;poking&rdquo; users.<br>
 I.e. notifying specific Slack users that they have a new message.</p>
@@ -388,8 +388,8 @@ <h3 id="real-time-metrics-around-active-users">Real-time metrics around active u
 For example, when Butler was started it wouldn&rsquo;t capture currently active users or sessions - it was only after some event captured in the logs that Butler would update it&rsquo;s internal counters. This meant that it would take some time (sometimes quite long) until the metrics were even approaching the real number of users using Sense.</p>
 <p>There was also the risk of Butler missing UDP messages and not registering the associated log event.</p>
 <p>The affected API endpoints are:</p>
-<p><a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusercount</a><br>
-<a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusers</a></p>
+<p><a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusercount</a><br>
+<a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusers</a></p>
 
 
 <div class="alert alert-info" role="alert">

diff --git a/docs/docs/about/use-cases/index.html b/docs/docs/about/use-cases/index.html
@@ -567,7 +567,7 @@ <h2 id="create-directories-copymovedelete-files">Create directories, copy/move/d
 <p>More info <a href="/docs/examples/file-copy-move-delete/">here</a>.</p>
 <h2 id="extract-metadata-for-apps">Extract metadata for apps</h2>
 <p>Exporting apps as JSON can be very useful for backup purposes. Doing regular snapshots of all apps in a Sense cluster is a fast and space-effective way of keeping point-in-time backups.</p>
-<p>The <a href="http://localhost:1313/docs/reference/rest-api/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
+<p>The <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
 <h2 id="easily-post-messages-to-slack">Easily post messages to Slack</h2>
 <p>Slack messages can include full formatting (web links, text formatting etc), as well as &ldquo;poking&rdquo; users.<br>
 I.e. notifying specific Slack users that they have a new message.</p>

diff --git a/docs/docs/about/use-cases/index.xml b/docs/docs/about/use-cases/index.xml
@@ -32,8 +32,8 @@ Here&amp;rsquo;s a list of features that are candidates for removal from Butler,
 For example, when Butler was started it wouldn&amp;rsquo;t capture currently active users or sessions - it was only after some event captured in the logs that Butler would update it&amp;rsquo;s internal counters. This meant that it would take some time (sometimes quite long) until the metrics were even approaching the real number of users using Sense.&lt;/p&gt;
 &lt;p&gt;There was also the risk of Butler missing UDP messages and not registering the associated log event.&lt;/p&gt;
 &lt;p&gt;The affected API endpoints are:&lt;/p&gt;
-&lt;p&gt;&lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api/?operationsSorter=alpha&#34;&gt;/v4/activeusercount&lt;/a&gt;&lt;br&gt;
-&lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api/?operationsSorter=alpha&#34;&gt;/v4/activeusers&lt;/a&gt;&lt;/p&gt;
+&lt;p&gt;&lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/?operationsSorter=alpha&#34;&gt;/v4/activeusercount&lt;/a&gt;&lt;br&gt;
+&lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/?operationsSorter=alpha&#34;&gt;/v4/activeusers&lt;/a&gt;&lt;/p&gt;
 
 
 &lt;div class=&#34;alert alert-info&#34; role=&#34;alert&#34;&gt;

diff --git a/docs/docs/about/use-cases/printview/index.html b/docs/docs/about/use-cases/printview/index.html
@@ -210,7 +210,7 @@ <h2 id="create-directories-copymovedelete-files">Create directories, copy/move/d
 <p>More info <a href="/docs/examples/file-copy-move-delete/">here</a>.</p>
 <h2 id="extract-metadata-for-apps">Extract metadata for apps</h2>
 <p>Exporting apps as JSON can be very useful for backup purposes. Doing regular snapshots of all apps in a Sense cluster is a fast and space-effective way of keeping point-in-time backups.</p>
-<p>The <a href="http://localhost:1313/docs/reference/rest-api/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
+<p>The <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">REST API documentation</a> has full docs for the <code>/v4/app/{appId}/dump</code> endpoint.</p>
 <h2 id="easily-post-messages-to-slack">Easily post messages to Slack</h2>
 <p>Slack messages can include full formatting (web links, text formatting etc), as well as &ldquo;poking&rdquo; users.<br>
 I.e. notifying specific Slack users that they have a new message.</p>
@@ -254,8 +254,8 @@ <h3 id="real-time-metrics-around-active-users">Real-time metrics around active u
 For example, when Butler was started it wouldn&rsquo;t capture currently active users or sessions - it was only after some event captured in the logs that Butler would update it&rsquo;s internal counters. This meant that it would take some time (sometimes quite long) until the metrics were even approaching the real number of users using Sense.</p>
 <p>There was also the risk of Butler missing UDP messages and not registering the associated log event.</p>
 <p>The affected API endpoints are:</p>
-<p><a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusercount</a><br>
-<a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusers</a></p>
+<p><a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusercount</a><br>
+<a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusers</a></p>
 
 
 <div class="alert alert-info" role="alert">

diff --git a/docs/docs/about/use-cases/retired/index.html b/docs/docs/about/use-cases/retired/index.html
@@ -464,8 +464,8 @@ <h3 id="real-time-metrics-around-active-users">Real-time metrics around active u
 For example, when Butler was started it wouldn&rsquo;t capture currently active users or sessions - it was only after some event captured in the logs that Butler would update it&rsquo;s internal counters. This meant that it would take some time (sometimes quite long) until the metrics were even approaching the real number of users using Sense.</p>
 <p>There was also the risk of Butler missing UDP messages and not registering the associated log event.</p>
 <p>The affected API endpoints are:</p>
-<p><a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusercount</a><br>
-<a href="/docs/reference/rest-api/?operationsSorter=alpha">/v4/activeusers</a></p>
+<p><a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusercount</a><br>
+<a href="/docs/reference/rest-api-1/?operationsSorter=alpha">/v4/activeusers</a></p>
 
 
 <div class="alert alert-info" role="alert">

diff --git a/docs/docs/concepts/file-system-access/index.html b/docs/docs/concepts/file-system-access/index.html
@@ -465,7 +465,7 @@ <h2 id="butler-adds-controlled-file-system-access-to-qlik-sense-enterprise">Butl
 <p>For example, you might have a QVD folder at <code>e:\data\qvd\sales\temp</code>.<br>
 You also need to remove old QVDs from that folder.</p>
 <p>This could be done with scheduled BAT/CMD files or PowerShell scripts, but it might be better/more flexible/easier/preferred to do this cleanup from the load script of a Sense app.</p>
-<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
+<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
 <h2 id="convenience-subs">Convenience subs</h2>
 <p>Butler includes a set of Subs that make it easy to use the file copy/move/delete APIs.<br>
 These subs are found in <a href="https://github.com/ptarmiganlabs/butler/blob/master/docs/sense_script/butler_subs.qvs">this .qvs file</a> as well as embedded in the <a href="https://github.com/ptarmiganlabs/butler/tree/master/docs/sense_apps">Butler demo app</a>.</p>

diff --git a/docs/docs/concepts/file-system-access/printview/index.html b/docs/docs/concepts/file-system-access/printview/index.html
@@ -118,7 +118,7 @@ <h2 id="butler-adds-controlled-file-system-access-to-qlik-sense-enterprise">Butl
 <p>For example, you might have a QVD folder at <code>e:\data\qvd\sales\temp</code>.<br>
 You also need to remove old QVDs from that folder.</p>
 <p>This could be done with scheduled BAT/CMD files or PowerShell scripts, but it might be better/more flexible/easier/preferred to do this cleanup from the load script of a Sense app.</p>
-<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
+<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
 <h2 id="convenience-subs">Convenience subs</h2>
 <p>Butler includes a set of Subs that make it easy to use the file copy/move/delete APIs.<br>
 These subs are found in <a href="https://github.com/ptarmiganlabs/butler/blob/master/docs/sense_script/butler_subs.qvs">this .qvs file</a> as well as embedded in the <a href="https://github.com/ptarmiganlabs/butler/tree/master/docs/sense_apps">Butler demo app</a>.</p>

diff --git a/docs/docs/concepts/index.xml b/docs/docs/concepts/index.xml
@@ -362,7 +362,7 @@ No more deleting, copying or moving of files from within the load script.&lt;/p&
 &lt;p&gt;For example, you might have a QVD folder at &lt;code&gt;e:\data\qvd\sales\temp&lt;/code&gt;.&lt;br&gt;
 You also need to remove old QVDs from that folder.&lt;/p&gt;
 &lt;p&gt;This could be done with scheduled BAT/CMD files or PowerShell scripts, but it might be better/more flexible/easier/preferred to do this cleanup from the load script of a Sense app.&lt;/p&gt;
-&lt;p&gt;The solution: Add &lt;code&gt;e:\data\qvd\sales\temp&lt;/code&gt; to Butler&amp;rsquo;s list of folders in which files can be deleted, then call Butler&amp;rsquo;s &lt;code&gt;/v4/filedelete&lt;/code&gt; &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api/?operationsSorter=alpha&#34;&gt;API endpoint&lt;/a&gt; from within your app&amp;rsquo;s load script. Done!&lt;/p&gt;
+&lt;p&gt;The solution: Add &lt;code&gt;e:\data\qvd\sales\temp&lt;/code&gt; to Butler&amp;rsquo;s list of folders in which files can be deleted, then call Butler&amp;rsquo;s &lt;code&gt;/v4/filedelete&lt;/code&gt; &lt;a href=&#34;https://butler.ptarmiganlabs.com/docs/reference/rest-api-1/?operationsSorter=alpha&#34;&gt;API endpoint&lt;/a&gt; from within your app&amp;rsquo;s load script. Done!&lt;/p&gt;
 &lt;h2 id=&#34;convenience-subs&#34;&gt;Convenience subs&lt;/h2&gt;
 &lt;p&gt;Butler includes a set of Subs that make it easy to use the file copy/move/delete APIs.&lt;br&gt;
 These subs are found in &lt;a href=&#34;https://github.com/ptarmiganlabs/butler/blob/master/docs/sense_script/butler_subs.qvs&#34;&gt;this .qvs file&lt;/a&gt; as well as embedded in the &lt;a href=&#34;https://github.com/ptarmiganlabs/butler/tree/master/docs/sense_apps&#34;&gt;Butler demo app&lt;/a&gt;.&lt;/p&gt;

diff --git a/docs/docs/concepts/key-value/index.html b/docs/docs/concepts/key-value/index.html
@@ -527,7 +527,7 @@ <h2 id="persistence-of-key-value-data">Persistence of key-value data</h2>
 
 
 	<div class="text-muted mt-5 pt-3 border-top">
-  Last modified 2021-04-22: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/c105eb7c23c3cfe4d98b4d6d316a786db6614d1e">First commit (c105eb7)</a>
+  Last modified 2024-04-15: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/2413b5c807aa9f5ad7407f44b0c00cfb0ee202da">Fix a few broken links (2413b5c)</a>
 </div>
 
 </div>

diff --git a/docs/docs/concepts/printview/index.html b/docs/docs/concepts/printview/index.html
@@ -1788,7 +1788,7 @@ <h2 id="butler-adds-controlled-file-system-access-to-qlik-sense-enterprise">Butl
 <p>For example, you might have a QVD folder at <code>e:\data\qvd\sales\temp</code>.<br>
 You also need to remove old QVDs from that folder.</p>
 <p>This could be done with scheduled BAT/CMD files or PowerShell scripts, but it might be better/more flexible/easier/preferred to do this cleanup from the load script of a Sense app.</p>
-<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
+<p>The solution: Add <code>e:\data\qvd\sales\temp</code> to Butler&rsquo;s list of folders in which files can be deleted, then call Butler&rsquo;s <code>/v4/filedelete</code> <a href="/docs/reference/rest-api-1/?operationsSorter=alpha">API endpoint</a> from within your app&rsquo;s load script. Done!</p>
 <h2 id="convenience-subs">Convenience subs</h2>
 <p>Butler includes a set of Subs that make it easy to use the file copy/move/delete APIs.<br>
 These subs are found in <a href="https://github.com/ptarmiganlabs/butler/blob/master/docs/sense_script/butler_subs.qvs">this .qvs file</a> as well as embedded in the <a href="https://github.com/ptarmiganlabs/butler/tree/master/docs/sense_apps">Butler demo app</a>.</p>

diff --git a/docs/docs/concepts/scheduler/index.html b/docs/docs/concepts/scheduler/index.html
@@ -507,7 +507,7 @@ <h2 id="the-butler-scheduler">The Butler scheduler</h2>
 
 
 	<div class="text-muted mt-5 pt-3 border-top">
-  Last modified 2021-04-22: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/c105eb7c23c3cfe4d98b4d6d316a786db6614d1e">First commit (c105eb7)</a>
+  Last modified 2024-04-15: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/2413b5c807aa9f5ad7407f44b0c00cfb0ee202da">Fix a few broken links (2413b5c)</a>
 </div>
 
 </div>