From a5a8e60b1db5576a607306edfa04632b02d968f5 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 14 Apr 2025 11:34:45 +0100 Subject: [PATCH] tidied up doc structure and fixed upgrade script typo --- content/en/blog/releases/2025.X/2025.3.md | 2 +- .../2025.3/Guides/cortex-gateway/_index.md | 1 + .../Guides/cortex-gateway/help/_index.md | 7 - .../help/cortex-release-notes.md | 7 - .../cortex-gateway/settings/packages.md | 7 - .../cortex-gateway/welcome-page/_index.md | 13 -- .../2025.3/Guides/cortex-innovation/_index.md | 1 + .../2025.3/Guides/cortex-studio/_index.md | 1 + .../cortex-studio/package-management.md | 20 --- .../upgrade-gateway.md | 2 +- .../cortex-interaction-portal/_index.md | 4 +- .../en/docs/2025.3/Reference/APIs/_index.md | 1 + .../execute-http-request-block-1.md | 4 +- .../en/docs/2025.3/Reference/logs/_index.md | 1 + .../docs/2025.3/Reference/messages/_index.md | 1 + .../2025.3/Tutorials/Development/_index.md | 120 ------------------ .../2025.3/Tutorials/Installation/_index.md | 8 -- .../en/docs/2025.3/Tutorials/Setup/_index.md | 8 -- .../Tutorials/Troubleshooting/_index.md | 18 --- data/urls.toml | 2 + 20 files changed, 14 insertions(+), 214 deletions(-) delete mode 100644 content/en/docs/2025.3/Guides/cortex-gateway/help/_index.md delete mode 100644 content/en/docs/2025.3/Guides/cortex-gateway/help/cortex-release-notes.md delete mode 100644 content/en/docs/2025.3/Guides/cortex-gateway/settings/packages.md delete mode 100644 content/en/docs/2025.3/Guides/cortex-gateway/welcome-page/_index.md delete mode 100644 content/en/docs/2025.3/Guides/cortex-studio/package-management.md rename content/en/docs/2025.3/Guides/{ => user-guides/user-interfaces}/cortex-interaction-portal/_index.md (86%) delete mode 100644 content/en/docs/2025.3/Tutorials/Development/_index.md delete mode 100644 content/en/docs/2025.3/Tutorials/Installation/_index.md delete mode 100644 content/en/docs/2025.3/Tutorials/Setup/_index.md delete mode 100644 content/en/docs/2025.3/Tutorials/Troubleshooting/_index.md diff --git a/content/en/blog/releases/2025.X/2025.3.md b/content/en/blog/releases/2025.X/2025.3.md index a6775328e..0556d6fc6 100644 --- a/content/en/blog/releases/2025.X/2025.3.md +++ b/content/en/blog/releases/2025.X/2025.3.md @@ -466,7 +466,7 @@ Releases are currently forecast to be made available on: [{{% ctx %}} Triggers Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" version="2025.3" >}} [{{% ctx %}} Innovation Execution Application]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.MainDoc" version="2025.3" >}} [{{% ctx %}} Execution Service]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.Services.ExecutionService.MainDoc" version="2025.3" >}} -[Interaction Portal]: {{< url path="Cortex.Guides.CortexInteractionPortal.MainDoc" version="2025.3" >}} +[Interaction Portal]: {{< url path="Cortex.Guides.UserGuides.UserInterfaces.CortexInteractionPortal.MainDoc" version="2025.3" >}} [creating a new process from Natural Language]: {{< ref "#support-for-creating-a-new-process-from-natural-language" >}} [Scalability]: {{< ref "#scalability" >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/_index.md b/content/en/docs/2025.3/Guides/cortex-gateway/_index.md index ff99ab5be..830d278ba 100644 --- a/content/en/docs/2025.3/Guides/cortex-gateway/_index.md +++ b/content/en/docs/2025.3/Guides/cortex-gateway/_index.md @@ -3,6 +3,7 @@ title: "CORTEX Gateway" linkTitle: "CORTEX Gateway" description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} platform." weight: 50 +outOfSupport: true --- {{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/help/_index.md b/content/en/docs/2025.3/Guides/cortex-gateway/help/_index.md deleted file mode 100644 index dae7d1fc2..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/help/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Help" -linkTitle: "Help" -description: "System level help" ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/help/cortex-release-notes.md b/content/en/docs/2025.3/Guides/cortex-gateway/help/cortex-release-notes.md deleted file mode 100644 index e60258650..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/help/cortex-release-notes.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Release Notes" -linkTitle: "Release Notes" -description: "Release notes for all currently available {{% ctx %}} Versions." ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/settings/packages.md b/content/en/docs/2025.3/Guides/cortex-gateway/settings/packages.md deleted file mode 100644 index 473daeffa..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/settings/packages.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Packages" -linkTitle: "Packages" -description: "Create and Manage {{% ctx %}} Packages" ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-gateway/welcome-page/_index.md b/content/en/docs/2025.3/Guides/cortex-gateway/welcome-page/_index.md deleted file mode 100644 index 04b16f12a..000000000 --- a/content/en/docs/2025.3/Guides/cortex-gateway/welcome-page/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Welcome Page" -linkTitle: "Welcome Page" -description: "Welcome Page" ---- - -{{< workinprogress >}} - -## Summary - -## Recently Edited Flows - -TODO: Summary, Screenshots diff --git a/content/en/docs/2025.3/Guides/cortex-innovation/_index.md b/content/en/docs/2025.3/Guides/cortex-innovation/_index.md index 0753f5cb1..39f0f630e 100644 --- a/content/en/docs/2025.3/Guides/cortex-innovation/_index.md +++ b/content/en/docs/2025.3/Guides/cortex-innovation/_index.md @@ -3,4 +3,5 @@ title: "CORTEX Applications" linkTitle: "CORTEX Applications" description: "The Service Fabric applications hosting the services within the {{% ctx %}} platform." weight: 300 +outOfSupport: true --- diff --git a/content/en/docs/2025.3/Guides/cortex-studio/_index.md b/content/en/docs/2025.3/Guides/cortex-studio/_index.md index d54973ba6..a71a50e81 100644 --- a/content/en/docs/2025.3/Guides/cortex-studio/_index.md +++ b/content/en/docs/2025.3/Guides/cortex-studio/_index.md @@ -3,6 +3,7 @@ title: "CORTEX Studio" linkTitle: "CORTEX Studio" description: "The web-based, low-code, integrated development environment (IDE) for creating, editing, debugging, testing and managing flows that define the logic and actions required to capture and automate simple user tasks through to complex business or IT processes." weight: 100 +outOfSupport: true --- {{< workinprogress >}} diff --git a/content/en/docs/2025.3/Guides/cortex-studio/package-management.md b/content/en/docs/2025.3/Guides/cortex-studio/package-management.md deleted file mode 100644 index 31bea9f7b..000000000 --- a/content/en/docs/2025.3/Guides/cortex-studio/package-management.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "CORTEX Studio - Package Management (TBC)" -linkTitle: "CORTEX Studio - Package Management (TBC)" -description: "Package Management" -weight: 1 ---- - -{{< workinprogress >}} - -## Summary - -## Automatic Selection of Dependent Flows - -## Remarks - -### Known Limitations - -## See Also - -### Related Concepts diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md index cfd556aab..bd04f4125 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -15,7 +15,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202 ## Run Upgrade Script -{{< section "/upgrade/2024.11/upgrade-web-application-server/run-gateway-script.md" >}} +{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}} ## Preserve installation files diff --git a/content/en/docs/2025.3/Guides/cortex-interaction-portal/_index.md b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/cortex-interaction-portal/_index.md similarity index 86% rename from content/en/docs/2025.3/Guides/cortex-interaction-portal/_index.md rename to content/en/docs/2025.3/Guides/user-guides/user-interfaces/cortex-interaction-portal/_index.md index 20cd67f36..e4a03ca00 100644 --- a/content/en/docs/2025.3/Guides/cortex-interaction-portal/_index.md +++ b/content/en/docs/2025.3/Guides/user-guides/user-interfaces/cortex-interaction-portal/_index.md @@ -1,6 +1,6 @@ --- -title: "CORTEX Interaction Portal" -linkTitle: "CORTEX Interaction Portal" +title: "Interaction Portal" +linkTitle: "Interaction Portal" description: "A web application that provides Human-in-the-Loop capabilities to the {{% ctx %}} platform." weight: 400 --- diff --git a/content/en/docs/2025.3/Reference/APIs/_index.md b/content/en/docs/2025.3/Reference/APIs/_index.md index c1ff26a3d..18e702570 100644 --- a/content/en/docs/2025.3/Reference/APIs/_index.md +++ b/content/en/docs/2025.3/Reference/APIs/_index.md @@ -3,4 +3,5 @@ title: "APIs" linkTitle: "APIs" description: "This section includes all reference documentation for APIs." weight: 10 +outOfSupport: true --- diff --git a/content/en/docs/2025.3/Reference/Blocks/http/execute-http-request/execute-http-request-block-1.md b/content/en/docs/2025.3/Reference/Blocks/http/execute-http-request/execute-http-request-block-1.md index cb3c1627f..3370f3d2a 100644 --- a/content/en/docs/2025.3/Reference/Blocks/http/execute-http-request/execute-http-request-block-1.md +++ b/content/en/docs/2025.3/Reference/Blocks/http/execute-http-request/execute-http-request-block-1.md @@ -271,7 +271,7 @@ Note: This example does not follow the base [Uri][] or [API][] as specified [abo
-This example will send a [POST][] request to the [Uri][] of a [Flow][] within a [published package][Publish Package] using [HTTP 1.1][HTTP11] and run the [Flow][], using Basic authentication which requires [Http Credentials][Http Credentials Property] to be a [UserCredentials][]. This example is similar in functionality to the [Run Flow][] block. +This example will send a [POST][] request to the [Uri][] of a [Flow][] within a published [package][Package] using [HTTP 1.1][HTTP11] and run the [Flow][], using Basic authentication which requires [Http Credentials][Http Credentials Property] to be a [UserCredentials][]. This example is similar in functionality to the [Run Flow][] block.
@@ -513,6 +513,6 @@ None [Flow]:{{< url path="Cortex.Reference.Glossary.F-J.Flow">}} [Cortex API Gateway]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ApiGatewayService.MainDoc" >}} -[Publish Package]: {{< url path="Cortex.Guides.Gateway.Settings.Packages.MainDoc" >}} +[Package]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Packages.WhatIsAPackage.MainDoc" >}} [Run Flow]: {{< url path="Cortex.Reference.Blocks.Flows.RunFlow.RunFlow.MainDoc">}} [Run Flow Async]: {{< url path="Cortex.Reference.Blocks.Flows.RunFlow.RunFlowAsync.MainDoc">}} diff --git a/content/en/docs/2025.3/Reference/logs/_index.md b/content/en/docs/2025.3/Reference/logs/_index.md index ac1da1a5b..3c5f6cd52 100644 --- a/content/en/docs/2025.3/Reference/logs/_index.md +++ b/content/en/docs/2025.3/Reference/logs/_index.md @@ -3,4 +3,5 @@ title: "Logs" linkTitle: "Logs" description: "This section includes all reference documentation for the logs generated by the {{% ctx %}} platform." weight: 10 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Reference/messages/_index.md b/content/en/docs/2025.3/Reference/messages/_index.md index fb26ee4e2..9f354cf1f 100644 --- a/content/en/docs/2025.3/Reference/messages/_index.md +++ b/content/en/docs/2025.3/Reference/messages/_index.md @@ -3,6 +3,7 @@ title: "Messages" linkTitle: "Messages" description: "This section includes all reference documentation for messages generated by the {{% ctx %}} platform." weight: 10 +outOfSupport: true --- {{< workinprogress >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Tutorials/Development/_index.md b/content/en/docs/2025.3/Tutorials/Development/_index.md deleted file mode 100644 index 2deb472a3..000000000 --- a/content/en/docs/2025.3/Tutorials/Development/_index.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: "Development" -linkTitle: "Development" -description: "This section includes tutorials about developing automation using the {{% ctx %}} platform." -weight: 30 ---- - -## Signing in and out of Gateway - -Shows how to sign in and out of {{% ctx %}} Gateway. - -{{< youtube id="DlgFfkE2LOY" >}} - -## Overview of Gateway - -Shows a high-level overview of {{% ctx %}} Gateway. - -{{< youtube id="EZoUUiv3EpM" >}} - -## Creating groups and moving flows - -Shows how to create new groups, and move existing flows between groups. - -{{< youtube id="fE0dyRoc1Os" >}} - -## Creating and interacting with flows - -Shows how to create a flow, and provides an overview of commonly used features of the flow editor. - -{{< youtube id="zFug1mUwXA8" >}} - -## Interacting with blocks - -Shows how to add, connect, copy, cut, paste, and delete blocks. - -{{< youtube id="vdhZ8opqU8A" >}} - -## Configuring variables - -Shows how to create and configure variables. - -{{< youtube id="AGDdFvRST5k" >}} - -## Configuring blocks - -Shows how to configure blocks using the Properties Editor. - -{{< youtube id="OZrydwUDzuU" >}} - -## Handling exceptions at the block level - -Shows how to handle exceptions at the block level. - -{{< youtube id="abFwXiOR1XQ" >}} - -## Handling exceptions at the workspace level - -Shows how to handle exceptions at the workspace level. - -{{< youtube id="Q_KrAhuyt38" >}} - -## Handling exceptions at the flow level - -Shows how to handle exceptions at the flow level. - -{{< youtube id="S-scB8rV1hw" >}} - -## Throwing exceptions - -Shows how to throw an exception within a flow. - -{{< youtube id="Gt3dSdWNQa4" >}} - -## Debugging a flow - -Shows how to start debugging a flow. - -{{< youtube id="reDYeeAiEYU" >}} - -## Adding and removing breakpoints - -Shows how to add and remove breakpoints when debugging a flow. - -{{< youtube id="8qJRCdz0CpU" >}} - -## Editing a flow whilst debugging - -Shows how to edit a flow whilst debugging, including fixing a runtime exception. - -{{< youtube id="DKrDZxpv9nY" >}} - -## Interacting with version control - -Shows how to save, commit, get master, and compare versions of a flow. - -{{< youtube id="oAfu7DsVgDM" >}} - -## Interacting with version control (multiple flows) - -Shows how to perform commit or get master of multiple flows. - -{{< youtube id="JPdFjeReYQE" >}} - -## Starting a published flow - -Shows how to start a flow, in the default package, via the API Gateway Service using an HTTP request. - -{{< youtube id="IXg0lnKg1BM" >}} - -## Starting a published flow (specific package) - -Shows how to start a flow, in a specific package, via the API Gateway Service using an HTTP request. - -{{< youtube id="8G0N7E9oTvo" >}} - -## Configuring input and output variables - -Shows how to configure the input and output variables of a flow. - -{{< youtube id="5YLg6f4HaBo" >}} diff --git a/content/en/docs/2025.3/Tutorials/Installation/_index.md b/content/en/docs/2025.3/Tutorials/Installation/_index.md deleted file mode 100644 index 3ba2a4769..000000000 --- a/content/en/docs/2025.3/Tutorials/Installation/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Installation" -linkTitle: "Installation" -description: "This section includes tutorials about installing the {{% ctx %}} platform." -weight: 10 ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Tutorials/Setup/_index.md b/content/en/docs/2025.3/Tutorials/Setup/_index.md deleted file mode 100644 index 230d4cef6..000000000 --- a/content/en/docs/2025.3/Tutorials/Setup/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Setup" -linkTitle: "Setup" -description: "This section includes tutorials about post-installation setup of the {{% ctx %}} platform." -weight: 20 ---- - -{{< workinprogress >}} diff --git a/content/en/docs/2025.3/Tutorials/Troubleshooting/_index.md b/content/en/docs/2025.3/Tutorials/Troubleshooting/_index.md deleted file mode 100644 index fc8b26cf4..000000000 --- a/content/en/docs/2025.3/Tutorials/Troubleshooting/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Troubleshooting" -linkTitle: "Troubleshooting" -description: "This section includes tutorials about troubleshooting the {{% ctx %}} platform." -weight: 50 ---- - -## Errors when starting published flows - -When making requests to start published flows, you may encounter errors. The videos below will show you how to fix them. - -### FlowNotFound - -{{< youtube id="1vXswyCAfn4" >}} - -### InvalidInputVariables - -{{< youtube id="0KIksXI8NLU" >}} diff --git a/data/urls.toml b/data/urls.toml index 5f61f847a..094440cc5 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -907,6 +907,8 @@ MainDoc = "/docs/guides/user-guides/" [Cortex.Guides.UserGuides.UserInterfaces] MainDoc = "/docs/guides/user-guides/user-interfaces/" + [Cortex.Guides.UserGuides.UserInterfaces.CortexInteractionPortal] + MainDoc = "/docs/guides/user-guides/user-interfaces/cortex-interaction-portal/" [Cortex.Guides.UserGuides.UserInterfaces.Gateway] MainDoc = "/docs/guides/user-guides/user-interfaces/gateway/" [Cortex.Guides.UserGuides.UserInterfaces.Gateway.Admin]