feat: versions 8.3/3.11.0 (#2717)

* version: new versions of docs

* version 8.3: reviewable steps (#2718)

* chore: update cutNewVersions with new version numbers

* version: sidebars

* version: version manifests

* version: redirects

* chore: show/hide correct version banners, and customize the label for Optimize 3.11

* chore: redirects for content that moved between 8.2 and 8.3

* oops: swap the version numbers for 8.3 label

* fix: map new versions to each other so cross-instance shortcuts can be resolved

docusaurus.config.js

@@ -47,10 +47,17 @@ module.exports = {
         sidebarPath: require.resolve("./optimize_sidebars.js"),
         editUrl: "https://github.com/camunda/camunda-docs/edit/main/",
         versions: {
+          "3.11.0": {
+            label: "8.3 / 3.11.0",
+          },
+          "3.10.0": {
+            banner: "none",
+          },
           "3.9.0": {
             banner: "none",
           },
-          "3.8.0": {
+          // surprising, yes, but true: 3.8 should show unsupported banner, but 3.7 should not.
+          "3.7.0": {
             banner: "none",
           },
         },
@@ -239,10 +246,10 @@ module.exports = {
           beforeDefaultRemarkPlugins: [versionedLinks],
           // 👋 When cutting a new version, remove the banner for maintained versions by adding an entry. Remove the entry to versions >18 months old.
           versions: {
-            8.1: {
+            8.2: {
               banner: "none",
             },
-            "8.0": {
+            8.1: {
               banner: "none",
             },
           },
@@ -261,9 +268,11 @@ module.exports = {
             "/docs/1.3/**",
             "/docs/8.0/**",
             "/docs/8.1/**",
+            "/docs/8.2/**",
             "/optimize/3.7.0/**",
             "/optimize/3.8.0/**",
             "/optimize/3.9.0/**",
+            "/optimize/3.10.0/**",
             "/optimize/next/**",
           ],
         },

hacks/cutNewVersions.sh

@@ -2,10 +2,10 @@
 set -e
 
 # Before running this script make sure these versions are correct!
-NEW_DOCS_VERSION="8.2"
-PREVIOUS_DOCS_VERSION="8.1"
-NEW_OPTIMIZE_VERSION="3.10.0"
-PREVIOUS_OPTIMIZE_VERSION="3.9.0"
+NEW_DOCS_VERSION="8.3"
+PREVIOUS_DOCS_VERSION="8.2"
+NEW_OPTIMIZE_VERSION="3.11.0"
+PREVIOUS_OPTIMIZE_VERSION="3.10.0"
 
 echo "1/5 Creating version $NEW_DOCS_VERSION of main docs..."
 npm run docusaurus docs:version $NEW_DOCS_VERSION

optimize_versioned_docs/version-3.11.0/apis-tools/optimize-api/configuration/disable-sharing.md

@@ -0,0 +1,59 @@
+---
+id: disable-sharing
+title: "Disable sharing"
+description: "The REST API to disable sharing"
+---
+
+This API allows users to disable the sharing functionality for all reports and dashboards in Optimize. Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).
+
+When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.
+
+## Method & HTTP target resource
+
+POST `api/public/share/disable`
+
+## Request headers
+
+The following request headers must be provided with every request:
+
+| Header        | Constraints | Value                                                 |
+| ------------- | ----------- | ----------------------------------------------------- |
+| Authorization | REQUIRED    | See [Authorization](../optimize-api-authorization.md) |
+
+## Query parameters
+
+No query parameters necessary.
+
+## Request body
+
+An empty request body should be sent.
+
+## Response codes
+
+Possible HTTP Response Status codes:
+
+| Code | Description                                                                                                               |
+| ---- | ------------------------------------------------------------------------------------------------------------------------- |
+| 204  | Request successful.                                                                                                       |
+| 401  | Secret incorrect or missing in HTTP Header. See [Authorization](../optimize-api-authorization.md) on how to authenticate. |
+| 500  | Some error occurred while processing the request, best check the Optimize log.                                            |
+
+## Example
+
+### Disable sharing
+
+POST `api/public/share/disable`
+
+#### Request header
+
+`Authorization: Bearer mySecret`
+
+#### Response
+
+Status 204 (Successful)
+
+#### Response content
+
+```
+no content
+```

optimize_versioned_docs/version-3.11.0/apis-tools/optimize-api/configuration/enable-sharing.md

@@ -0,0 +1,59 @@
+---
+id: enable-sharing
+title: "Enable sharing"
+description: "The REST API to enable sharing"
+---
+
+This API allows users to enable the sharing functionality for all reports and dashboards in Optimize. Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).
+
+If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.
+
+## Method & HTTP target resource
+
+POST `api/public/share/enable`
+
+## Request headers
+
+The following request headers must be provided with every request:
+
+| Header        | Constraints | Value                                                 |
+| ------------- | ----------- | ----------------------------------------------------- |
+| Authorization | REQUIRED    | See [Authorization](../optimize-api-authorization.md) |
+
+## Query parameters
+
+No query parameters necessary.
+
+## Request body
+
+An empty request body should be sent.
+
+## Response codes
+
+Possible HTTP Response Status codes:
+
+| Code | Description                                                                                                               |
+| ---- | ------------------------------------------------------------------------------------------------------------------------- |
+| 204  | Request successful.                                                                                                       |
+| 401  | Secret incorrect or missing in HTTP Header. See [Authorization](../optimize-api-authorization.md) on how to authenticate. |
+| 500  | Some error occurred while processing the request, best check the Optimize log.                                            |
+
+## Example
+
+### Enable sharing
+
+POST `api/public/share/enable`
+
+#### Request header
+
+`Authorization: Bearer mySecret`
+
+#### Response
+
+Status 204 (Successful)
+
+#### Response content
+
+```
+no content
+```

optimize_versioned_docs/version-3.11.0/apis-tools/optimize-api/dashboard/delete-dashboard.md

@@ -0,0 +1,64 @@
+---
+id: delete-dashboard
+title: "Delete dashboards"
+description: "The REST API to delete dashboards from Optimize."
+---
+
+The dashboards deletion API allows you to delete dashboards by ID from Optimize.
+
+:::note Heads up!
+The deletion of a dashboard does not affect the referenced reports.
+:::
+
+## Method & HTTP target resource
+
+DELETE `/api/public/dashboard/{dashboard-ID}`
+
+Where `dashboard-ID` is the ID of the dashboard you wish to delete.
+
+## Request headers
+
+The following request headers have to be provided with every delete request:
+
+| Header        | Constraints | Value                                                 |
+| ------------- | ----------- | ----------------------------------------------------- |
+| Authorization | REQUIRED    | See [Authorization](../optimize-api-authorization.md) |
+
+## Query parameters
+
+No query parameters available.
+
+## Request body
+
+No request body is required.
+
+## Result
+
+No response body.
+
+## Response codes
+
+Possible HTTP Response status codes:
+
+| Code | Description                                                                                                               |
+| ---- | ------------------------------------------------------------------------------------------------------------------------- |
+| 204  | Request successful.                                                                                                       |
+| 401  | Secret incorrect or missing in HTTP Header. See [Authorization](../optimize-api-authorization.md) on how to authenticate. |
+| 404  | The requested dashboard was not found, please check the provided dashboard-ID.                                            |
+| 500  | Some error occurred while processing the request, best check the Optimize log.                                            |
+
+## Example
+
+### Delete a dashboard
+
+Let's assume you want to delete a dashboard with the ID `e6c5abb1-6a18-44e7-8480-d562d511ba62`, this is what it would look like:
+
+DELETE `/api/public/dashboard/e6c5aaa1-6a18-44e7-8480-d562d511ba62`
+
+#### Request header
+
+`Authorization: Bearer mySecret`
+
+#### Response
+
+Status 204.

optimize_versioned_docs/version-3.11.0/apis-tools/optimize-api/dashboard/export-dashboard-definitions.md

@@ -0,0 +1,136 @@
+---
+id: export-dashboard-definitions
+title: "Export dashboard definitions"
+description: "The REST API to export dashboard definitions."
+---
+
+This API allows users to export dashboard definitions which can later be imported into another Optimize system. Note that exporting a dashboard also exports all reports contained within the dashboard. The dashboards to be exported may be within a Collection or private entities, the API has access to both.
+
+The obtained list of entity exports can be imported into other Optimize systems either using the dedicated [import API](../import-entities.md) or [via UI](components/userguide/additional-features/export-import.md#importing-entities).
+
+## Method & HTTP target resource
+
+POST `/api/public/export/dashboard/definition/json`
+
+## Request headers
+
+The following request headers have to be provided with every request:
+
+| Header        | Constraints | Value                                             |
+| ------------- | ----------- | ------------------------------------------------- |
+| Authorization | REQUIRED    | [Authorization](../optimize-api-authorization.md) |
+
+## Query parameters
+
+No query parameters available.
+
+## Request body
+
+The request body should contain a JSON array of dashboard IDs to be exported.
+
+## Result
+
+The response contains a list of exported dashboard definitions as well as all report definitions contained within the dashboards.
+
+## Response codes
+
+Possible HTTP response status codes:
+
+| Code | Description                                                                                                               |
+| ---- | ------------------------------------------------------------------------------------------------------------------------- |
+| 204  | Request successful.                                                                                                       |
+| 401  | Secret incorrect or missing in HTTP Header. See [Authorization](../optimize-api-authorization.md) on how to authenticate. |
+| 404  | At least one of the given dashboard IDs does not exist.                                                                   |
+| 500  | Some error occurred while processing the request, best check the Optimize log.                                            |
+
+## Example
+
+### Export two dashboards
+
+Assuming you want to export the two dashboards with IDs `123` and `456` and have configured the accessToken `mySecret`, this is what it would look like:
+
+POST `/api/public/export/dashboard/definition/json`
+
+#### Request header
+
+`Authorization: Bearer mySecret`
+
+#### Request body
+
+```
+[ "123", "456" ]
+```
+
+#### Response
+
+Status 200.
+
+#### Response content
+
+The response contains the two exported dashboard definitions as well as all three process reports contained within the two dashboards.
+
+```
+[
+    {
+        "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
+        "exportEntityType": "single_process_report",
+        "name": "Number: Process instance duration",
+        "description": "This report shows the average instance duration",
+        "sourceIndexVersion": 11,
+        "collectionId": null,
+        "data": {...}
+    },
+    {
+        "id": "625c2411-b95f-4442-936b-1976b9511d4a",
+        "exportEntityType": "single_process_report",
+        "name": "Heatmap: Flownode count",
+        "description": "This report shows a heatmap of the number of instances",
+        "sourceIndexVersion": 11,
+        "collectionId": null,
+        "data": {...}
+    },
+    {
+        "id": "94a7252e-d5c3-45ea-9906-75271cc0cac2",
+        "exportEntityType": "single_process_report",
+        "name": "Data Table: User task count",
+        "description": "This report shows number of user tasks",
+        "sourceIndexVersion": 11,
+        "collectionId": null,
+        "data": {...}
+    },
+    {
+        "id": "123",
+        "exportEntityType": "dashboard",
+        "name": "Dashboard 1",
+        "description": "A dashboard showing possible automation candidates",
+        "sourceIndexVersion": 8,
+        "reports": [
+            {
+                "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
+                ...
+            },
+            {
+                "id": "625c2411-b95f-4442-936b-1976b9511d4a",
+                ...
+            }
+        ],
+        "availableFilters": [...],
+        "collectionId": null
+    },
+    {
+        "id": "456",
+        "exportEntityType": "dashboard",
+        "name": "Dashboard 2",
+        "description": "A dashboard showing user task data",
+        "sourceIndexVersion": 8,
+        "reports": [
+            {
+                "id": "94a7252e-d5c3-45ea-9906-75271cc0cac2",
+                ...
+            }
+        ],
+        "availableFilters": [...],
+        "collectionId": null
+    }
+]
+```