From 8641b152b12b147f768568bf744eed4181921400 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=B6ran=20Sander?= Date: Mon, 15 Apr 2024 12:39:58 +0200 Subject: [PATCH] Fix broken links --- content/en/docs/about/use cases/_index.md | 2 +- content/en/docs/about/use cases/retired.md | 4 ++-- .../docs/concepts/file system access/_index.md | 2 +- .../Sense demo apps/Partial loads/_index.md | 2 +- .../setup/key-value store/_index.md | 2 +- .../en/docs/getting started/setup/mqtt/_index.md | 2 +- content/en/docs/reference/key-value/_index.md | 2 +- docs/docs/about/index.xml | 2 +- docs/docs/about/printview/index.html | 6 +++--- docs/docs/about/use-cases/index.html | 2 +- docs/docs/about/use-cases/index.xml | 4 ++-- docs/docs/about/use-cases/printview/index.html | 6 +++--- docs/docs/about/use-cases/retired/index.html | 4 ++-- docs/docs/concepts/file-system-access/index.html | 2 +- .../file-system-access/printview/index.html | 2 +- docs/docs/concepts/index.xml | 2 +- docs/docs/concepts/key-value/index.html | 2 +- docs/docs/concepts/printview/index.html | 2 +- docs/docs/concepts/scheduler/index.html | 2 +- docs/docs/examples/printview/index.html | 2 +- docs/docs/examples/sense-demo-apps/index.xml | 2 +- .../sense-demo-apps/partial-loads/index.html | 2 +- .../partial-loads/printview/index.html | 2 +- .../sense-demo-apps/printview/index.html | 2 +- docs/docs/getting-started/printview/index.html | 4 ++-- docs/docs/getting-started/setup/index.xml | 4 ++-- .../setup/key-value-store/index.html | 2 +- .../setup/key-value-store/printview/index.html | 2 +- docs/docs/getting-started/setup/mqtt/index.html | 2 +- .../setup/mqtt/printview/index.html | 2 +- .../getting-started/setup/printview/index.html | 4 ++-- docs/docs/index.html | 2 +- docs/docs/index.xml | 4 ++-- docs/docs/printview/index.html | 16 ++++++++-------- docs/docs/reference/index.xml | 2 +- docs/docs/reference/key-value/index.html | 2 +- .../reference/key-value/printview/index.html | 2 +- docs/docs/reference/printview/index.html | 2 +- docs/sitemap.xml | 8 ++++---- 39 files changed, 60 insertions(+), 60 deletions(-) diff --git a/content/en/docs/about/use cases/_index.md b/content/en/docs/about/use cases/_index.md index b90b72f9..9359cd66 100644 --- 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 index fa48c43d..eb97cde2 100644 --- 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 index 51c8f221..285f565f 100644 --- 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 index b4457842..47b5b13c 100644 --- 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 index 775e1d80..f88ddbb2 100644 --- 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 index 37901de7..b508d8d5 100644 --- 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 index f7ce603b..46540ed8 100644 --- 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 index 51f937b6..52d5fb07 100644 --- 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 <p>More info <a href="https://butler.ptarmiganlabs.com/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="https://butler.ptarmiganlabs.com/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/printview/index.html b/docs/docs/about/printview/index.html index 5ed724ae..8f603d16 100644 --- a/docs/docs/about/printview/index.html +++ b/docs/docs/about/printview/index.html @@ -342,7 +342,7 @@

Create directories, copy/move/d

More info here.

Extract metadata for apps

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 has full docs for the /v4/app/{appId}/dump endpoint.

+

The REST API documentation has full docs for the /v4/app/{appId}/dump endpoint.

Easily post messages to Slack

Slack messages can include full formatting (web links, text formatting etc), as well as “poking” users.
I.e. notifying specific Slack users that they have a new message.

@@ -388,8 +388,8 @@

Real-time metrics around active u For example, when Butler was started it wouldn’t capture currently active users or sessions - it was only after some event captured in the logs that Butler would update it’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.

There was also the risk of Butler missing UDP messages and not registering the associated log event.

The affected API endpoints are:

-

/v4/activeusercount
-/v4/activeusers

+

/v4/activeusercount
+/v4/activeusers

Partial reload API

-

The full API documentation is available in the Reference section, here we’re interested in the PUT /v4/app/{appId}/reload endpoint.

+

The full API documentation is available in the Reference section, here we’re interested in the PUT /v4/app/{appId}/reload endpoint.

Demo apps for partial reloads

A couple of apps showing how to use Butler’s partial load API are included in the GitHub repository.