Skip to content

Commit

Permalink
Merge 2024.3 Documentation (#126)
Browse files Browse the repository at this point in the history
Merge 2024.3 Documentation
  • Loading branch information
cortex-td authored Apr 10, 2024
1 parent 71e9091 commit 1036b42
Show file tree
Hide file tree
Showing 1,189 changed files with 80,787 additions and 10 deletions.
9 changes: 7 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -200,15 +200,20 @@ enable = true
[[menu.main]]
identifier = 'documentation'
name = 'Documentation'
url = '/docs/2024.1'
url = '/docs/2024.3'
weight = 10

# Releases menu
[[params.versions]]
version = "2024.3"
url = "/docs/2024.3/"
dotNetVersion = "net-6.0"
latest = true

[[params.versions]]
version = "2024.1"
url = "/docs/2024.1/"
dotNetVersion = "net-6.0"
latest = true

[[params.versions]]
version = "2023.11"
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/releases/2024.X/2024.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Affected Components:

##### Configurable Logging within the HA Platform

An API route has been added to API Gateway which allows for configuration of logging accross the entire {{% ctx %}} Platform. All logs are written at a given `LogLevel`, and the current `LogLevel` of the application can be changed and updated at runtime.
An API route has been added to API Gateway which allows for configuration of logging across the entire {{% ctx %}} Platform. All logs are written at a given `LogLevel`, and the current `LogLevel` of the application can be changed and updated at runtime.

Any logs with a `LogLevel` lower than the configured `LogLevel` for the platform will not be logged. Information regarding the types of log level and what logs are written at a given level can be found below:

Expand Down
730 changes: 730 additions & 0 deletions content/en/blog/releases/2024.X/2024.3.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Copy the `Cortex Innovation {{< version >}} - Encryption Key Generator.zip` arte
1. Run the `Cortex.Encryption.KeyGeneration.exe` application using the following command, modifying the argument value to contain the NETBIOS names or fully qualified domain names of the Application Server and Web Application Server:
```powershell
.\Cortex.Encryption.KeyGeneration.exe "app-server, webapp-server"
.\Cortex.Encryption.KeyGeneration.exe "app-server1"
```
1. A message similar to the following will indicate that the application has completed successfully:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,8 @@ See [SSL Best Practices][] for a full list of the security changes which will be
[IIS URL Rewrite]: {{< url path="IIS.Downloads.UrlRewrite-2_1" >}}
[Install Application Server]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.InstallApplicationServer" >}}
[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScript" >}}
[Microsoft Server 2019]: {{< url path="MSEval.WindowsServer.2019" >}}
[Microsoft Server 2022]: {{< url path="MSEval.WindowsServer.2022" >}}
[NET Framework 472]: {{< url path="MSDotNet.Framework472.MainDoc" >}}
[Port Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.PortRequirements" >}}
[SSL Best Practices]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.SSLBestPractices" >}}
Expand Down
8 changes: 8 additions & 0 deletions content/en/docs/2024.3/FAQs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "FAQs"
linkTitle: "FAQs"
description: "Answers to our most frequently asked questions."
weight: 10000
---

{{< workinprogress >}}
6 changes: 6 additions & 0 deletions content/en/docs/2024.3/Guides/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Guides"
linkTitle: "Guides"
description: "This section includes all guides for the {{% ctx %}} Innovation platform."
weight: 10
---
8 changes: 8 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-gateway/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "CORTEX Gateway"
linkTitle: "CORTEX Gateway"
description: "The centralised web-based portal for accessing all user applications and tooling in the {{% ctx %}} Innovation platform."
weight: 1
---

{{< workinprogress >}}
7 changes: 7 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-gateway/help/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Help"
linkTitle: "Help"
description: "System level help"
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Release Notes"
linkTitle: "Release Notes"
description: "Release notes for all currently available {{% ctx %}} Versions."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "CORTEX Gateway Management"
linkTitle: "CORTEX Gateway Management"
description: "{{% ctx %}} Gateway and Studio Management tools and settings"
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "LDAP Authorisation"
linkTitle: "LDAP Authorisation"
description: "Configure RBAC by assining roles to security groups."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "LDAP Connection"
linkTitle: "LDAP Connection"
description: "Connect to an Active Directory using LDAP."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "License Consumption"
linkTitle: "License Consumption"
description: "Review current license consumption of flows in master."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Packages"
linkTitle: "Packages"
description: "Create and Manage {{% ctx %}} Innovation Packages"
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Studio Authorisation"
linkTitle: "Studio Authorisation"
description: "Assign access rights to flows based on security groups."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Studio Export"
linkTitle: "Studio Export"
description: "Create {{% ctx %}} Studio Packages by exporting flows."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Studio Hierarchy"
linkTitle: "Studio Hierarchy"
description: "Manage the location of flows in the Flow Hierarchy."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Studio Import"
linkTitle: "Studio Import"
description: "Import {{% ctx %}} Studio Packages."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Version Control"
linkTitle: "Version Control"
description: "High level view of flows out of sync with master. Allow for mass Commit or Get Master"
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Welcome Page"
linkTitle: "Welcome Page"
description: "Welcome Page"
---

{{< workinprogress >}}

## Summary

## Recently Edited Flows

TODO: Summary, Screenshots
6 changes: 6 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-innovation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "CORTEX Innovation"
linkTitle: "CORTEX Innovation"
description: "The {{% ctx %}} Innovation platform."
weight: 300
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Core Application"
linkTitle: "Core Application"
description: "The Core Application."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Services"
linkTitle: "Services"
description: "The Core Application Services."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "API Gateway Service"
linkTitle: "API Gateway Service"
description: "The API Gateway Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Authorisation Service"
linkTitle: "Authorisation Service"
description: "The Authorisation Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Concurrency Management Service"
linkTitle: "Concurrency Management Service"
description: "The Concurrency Management Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Configuration Management Service"
linkTitle: "Configuration Management Service"
description: "The Configuration Management Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Data Storage Service"
linkTitle: "Data Storage Service"
description: "The Data Storage Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Execution Management Service"
linkTitle: "Execution Management Service"
description: "The Execution Management Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Licence Management Service"
linkTitle: "Licence Management Service"
description: "The Licence Management Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Package Management Service"
linkTitle: "Package Management Service"
description: "The Package Management Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Provisioning Service"
linkTitle: "Provisioning Service"
description: "The Provisioning Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Scheduling Service"
linkTitle: "Scheduling Service"
description: "The Scheduling Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Triggers Service"
linkTitle: "Triggers Service"
description: "The Triggers Service."
---

{{< workinprogress >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Execution Application"
linkTitle: "Execution Application"
description: "The Execution Application."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Services"
linkTitle: "Services"
description: "The Execution Application Services."
weight: 1
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Execution Service"
linkTitle: "Execution Service"
description: "The Execution Service."
---

{{< workinprogress >}}
10 changes: 10 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-interaction-portal/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "CORTEX Interaction Portal"
linkTitle: "CORTEX Interaction Portal"
description: "A web application that provides Human-in-the-Loop capabilities to the {{% ctx %}} Innovation platform."
weight: 400
---

* {{< filelink src="/pdf/Cortex Interaction Portal User Guide.pdf" name="CORTEX Interaction Portal User Guide" >}}
* {{< filelink src="/pdf/Cortex Interaction Portal Developer Guide.pdf" name="CORTEX Interaction Portal Developer Guide" >}}
* {{< filelink src="/pdf/Cortex Interaction Portal Merging Guide.pdf" name="CORTEX Interaction Portal Merging Guide" >}}
8 changes: 8 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-studio/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
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
---

{{< workinprogress >}}
20 changes: 20 additions & 0 deletions content/en/docs/2024.3/Guides/cortex-studio/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Debugging"
linkTitle: "Debugging"
description: ""
weight: 1
---

{{< workinprogress >}}

## Summary

## Property Viewer

## Remarks

### Known Limitations

## See Also

### Related Concepts
Loading

0 comments on commit 1036b42

Please sign in to comment.