Merge branch 'main' into feat/release-notes-for-v3.1.0

Author: MattDodsonEnglish

config/_default/hugo.yaml

@@ -12,7 +12,7 @@ menu:
   main:
     - name: Docs
       weight: 1
-      url: /introduction
+      url: /get-started/introduction
     - name: Learn ISA-95
       weight: 5
       url: /isa-95
@@ -48,7 +48,9 @@ markup:
   goldmark:
     renderer:
       unsafe: true
-
+    renderHooks:
+      link:
+        enableDefault: true
   # enable hextra syntax highlight
   highlight:
     noClasses: false

content/deploy/backup/binary.md

@@ -14,7 +14,7 @@ Before you start, ensure you have the following:
 
 
 - A designated S3 backup location, for example `s3://s3.<AWS-REGION>.amazonaws.com/<AWS-BUCKET-NAME>`.
-- Access to your [Rhize Kubernetes Environment]({{< relref "install" >}})
+- Access to your [Rhize Kubernetes Environment]({{< relref "../install" >}})
 {{% param pre_reqs %}}.
 
 

content/deploy/backup/graphdb.md

@@ -15,7 +15,7 @@ Before you start, ensure you have the following:
 
 
 - A designated backup location, for example `~/rhize-backups/database`.
-- Access to your [Rhize Kubernetes Environment]({{< relref "install" >}})
+- Access to your [Rhize Kubernetes Environment]({{< relref "../install" >}})
 {{% param pre_reqs %}}.
 
 

content/deploy/install/keycloak.md

@@ -12,8 +12,8 @@ Rhize uses [Keycloak](https://keycloak.org) as an OpenID provider.
 In your cluster, the Keycloak server to authenticate users, services, and manage Role-based access controls.
 
 This topic describes how to set up Keycloak in your Rhize cluster.
-For a conceptual overview of the authentication flow, read [About OpenID Connect]({{< relref "../../explanations/about-openidconnect.md" >}})
-
+For a conceptual overview of the authentication flow,
+read [About OpenID Connect](/explanations/about-openidconnect)
 
 ## Prerequisites
 
@@ -65,7 +65,7 @@ Other clients, such as the UI and Dashboard, use the standard flow to coordinate
 
 {{< callout type="info" >}}
 Each standard-flow client has its own subdomain.
-Refer to [Default URLs and Ports]({{< relref "/reference/default-ports" >}}) for our recommended conventions.
+Refer to [Default URLs and Ports]({{< relref "../../reference/default-ports" >}}) for our recommended conventions.
 {{< /callout >}}
 
 #### Create DB client

content/deploy/install/services.md

@@ -11,7 +11,7 @@ The final installation step is to install the Rhize services in your Kubernetes
 ## Prerequisites
 
 This topic assumes you have done the following:
-- [Set up Kubernetes](/deploy/install/setup-kubernetes) and [Configured Keycloak]({{< relref "keycloak" >}}). All the prerequisites for those topics apply here.
+- [Set up Kubernetes]({{< relref "setup-kubernetes" >}}) and [Configured Keycloak]({{< relref "keycloak" >}}). All the prerequisites for those topics apply here.
 - Configured load balancing for the following DNS records:
 
     {{< reusable/default-urls >}}
@@ -123,7 +123,7 @@ If enabling the Audit Trail, also the include the configuration in [Enable chang
 1. Go to Keycloak UI and add all new {{< param db >}} roles to the `ADMIN` group.
 
 If the install is successful, the Keycloak UI is available on its
-[default port]({{< ref "default-ports" >}}).
+[default port]({{< relref "../../reference/default-ports" >}}).
 
 
 ## Install services
@@ -232,7 +232,7 @@ Install the router with these steps:
     ```
 
 If the install is successful, the Router explorer is available on its
-[default port]({{< ref "default-ports" >}}).
+[default port]({{< relref "../../reference/default-ports" >}}).
 
 ### Grafana
 
@@ -254,7 +254,7 @@ Install Grafana with these steps:
     ```
 
 If the install is successful, the Grafana service is available on its
-[default port]({{< ref "default-ports" >}}).
+[default port]({{< relref "../../reference/default-ports" >}}).
 
 ### Agent
 
@@ -274,7 +274,7 @@ Install the agent with these steps:
 
 ## Install UI
 
-The UI is the graphical frontend to [handle events]({{< relref "/how-to/bpmn" >}}) and [define work masters]({{< relref "/how-to/model" >}}).
+The UI is the graphical frontend to [handle events]({{< relref "../../how-to/bpmn" >}}) and [define work masters]({{< relref "../../how-to/model" >}}).
 
 > **Requirements:** The UI requires the [GraphDB](#db), [BPMN](#bpmn), [Core](#core), and [Router](#router) services.
 
@@ -290,12 +290,12 @@ After installing all other services, install the UI with these steps:
     ```
 
 If the install is successful, the UI is available on its
-[default port]({{< ref "default-ports" >}}).
+[default port]({{< relref "../../reference/default-ports" >}}).
 
 ## Optional: Audit Trail service
 
 
-The Rhize [Audit]({{< relref "/how-to/audit" >}}) service provides an audit trail for database changes to install. The Audit service uses PostgreSQL for storage.
+The Rhize [Audit]({{< relref "../../how-to/audit" >}}) service provides an audit trail for database changes to install. The Audit service uses PostgreSQL for storage.
 
 Install Audit Service with these steps:
 
@@ -314,11 +314,11 @@ Install Audit Service with these steps:
     select partman.create_parent( p_parent_table := 'public.audit_log', p_control := 'time',  p_interval := '1 Month', p_template_table := 'public.audit_log_partition');
     ```
 
-For details about maintaining the Audit trail, read [Archive the PostgresQL Audit trail]({{< relref "/deploy/maintain/audit/" >}}).
+For details about maintaining the Audit trail, read [Archive the PostgresQL Audit trail]({{< relref "../maintain/audit/" >}}).
 
 ### Enable change data capture
 
-The Audit trail requires [change data capture (CDC)]({{< ref "track-changes" >}}) to function. To enable CDC in {{< param application_name >}} BAAS, include the following values for the Helm chart overrides:
+The Audit trail requires [change data capture (CDC)]({{< relref "../../how-to/publish-subscribe/track-changes" >}}) to function. To enable CDC in {{< param application_name >}} BAAS, include the following values for the Helm chart overrides:
 
 ```yaml
 alpha:
@@ -363,7 +363,7 @@ $ helm upgrade --install router -f router.yaml {{< param application_name >}}/ro
 
 ## Optional: calendar service
 
-The [{{< param brand_name >}} calendar service]({{< relref "/how-to/work-calendars">}}) monitors work calendar definitions and creates work calendar entries in real time, both in the [Graph](#db) and time-series databases.
+The [{{< param brand_name >}} calendar service]({{< relref "../../how-to/work-calendars">}}) monitors work calendar definitions and creates work calendar entries in real time, both in the [Graph](#db) and time-series databases.
 
 > **Requirements:** The calendar service requires the [GraphDB](#db), [Keycloak](#keycloak), and [NATS](#nats) services.
 
@@ -452,7 +452,7 @@ Install the calendar service with these steps:
 ## Optional: change service configuration
 
 The services installed in the previous step have many parameters that you can configure for your performance and deployment requirements.
-Review the full list in the [Service configuration]({{< relref "/reference/service-config" >}}) reference.
+Review the full list in the [Service configuration]({{< relref "../../reference/service-config" >}}) reference.
 
 ## Troubleshoot
 
@@ -473,7 +473,7 @@ For particular problems, try these commands:
 - **Access service through browser**
 
     Some services are accessible through the browser.
-    To access them, visit local host on the service's [default port]({{< ref "default-ports" >}}).
+    To access them, visit local host on the service's [default port]({{< relref "../../reference/default-ports" >}}).
 
 - **I installed a service too early**.
     If you installed a service too early, use Helm to uninstall:

content/deploy/maintain/audit.md

@@ -6,7 +6,7 @@ description: How to archive a partition of the Audit trail on your Rhize deploym
 weight: 100
 ---
 
-The [audit trial]({{< relref "/how-to/audit" >}}) can generate a high volume of data, so it is a good practice to periodically _archive_ portions of it.
+The [audit trail]({{< relref "../../how-to/audit" >}}) can generate a high volume of data, so it is a good practice to periodically _archive_ portions of it.
 An archive separates a portion of the data from the database and keeps it for long-term storage. This process involves the use of PostgreSQL [Table Partitions](https://www.postgresql.org/docs/current/ddl-partitioning.html).
 
 Archiving a partition improves query speed for current data, while providing a cost-effective way to store older.
@@ -17,7 +17,7 @@ Archiving a partition improves query speed for current data, while providing a c
 Before you start, ensure you have the following:
 
 - A designated backup location, for example `~/rhize-archives/libre-audit`.
-- Access to the [Rhize Kubernetes Environment](/deploy/install/setup-kubernetes) {{% param pre_reqs %}}
+- Access to the [Rhize Kubernetes Environment]({{< relref "../install/setup-kubernetes" >}}) {{% param pre_reqs %}}
 
 Also, before you start, confirm you are in the right context and namespace.
 
@@ -66,7 +66,7 @@ To archive the PostgreSQL Audit trail, follow these steps:
 ## Next Steps
 
 - For full backups or Rhize services, read how to back up:
-  - [Keycloak]({{< relref "/deploy/backup/keycloak" >}})
-  - [The Audit trail]({{< relref "/deploy/backup/audit" >}})
-  - [Grafana]({{< relref "/deploy/backup/grafana" >}})
-  - [The Graph Database]({{< relref "/deploy/backup/graphdb" >}})
+  - [Keycloak]({{< relref "../backup/keycloak" >}})
+  - [The Audit trail]({{< relref "../backup/audit" >}})
+  - [Grafana]({{< relref "../backup/grafana" >}})
+  - [The Graph Database]({{< relref "../backup/graphdb" >}})

content/deploy/maintain/bpmn-nodes.md

@@ -6,7 +6,7 @@ description: >-
 categories: ["concepts"]
 ---
 
-[{{< abbr "BPMN" >}} processes]({{< relref "/how-to/bpmn" >}}) often have longer execution durations and many steps.
+[{{< abbr "BPMN" >}} processes]({{< relref "../../how-to/bpmn" >}}) often have longer execution durations and many steps.
 If a BPMN node suddenly fails (for example through a panic or loss of power),
 Rhize needs to ensure that the workflow completes.
 
@@ -42,4 +42,4 @@ To learn more, read the NATS topic on [Disaster recovery](https://docs.nats.io/r
 If an element in a BPMN workflow takes longer than 10 minutes, NATS ages the workflow out of the queue. The process continues, but if the pod executing the element dies or is interrupted, that workflow is permanently dropped.
 
 This ten-minute execution limit should be sufficient for any element in a BPMN process.
-Processes that take longer, such as cooling or fermentation periods, should be implemented as [BPMN event triggers]({{< relref "/how-to/bpmn/bpmn-elements" >}}) or as polls that periodically check data sources between intervals of sleep.
+Processes that take longer, such as cooling or fermentation periods, should be implemented as [BPMN event triggers]({{ relref "../../how-to/bpmn/bpmn-elements" >}}) or as polls that periodically check data sources between intervals of sleep.

content/explanations/manufacturing-data-hub.md

@@ -13,7 +13,7 @@ This article explains what the components of a _Manufacturing Data Hub_ (MDH) ar
 
 In another phrasing, this article explains why Rhize made the choices it did to become the world's first manufacturing data hub.
 For introductory explanations about Rhize in particular,
-read [What is Rhize?]({{< relref "/get-started/introduction" >}}) and [How Rhize works]({{< relref "/get-started/how-rhize-works" >}}).
+read [What is Rhize?]({{< relref "../get-started/introduction" >}}) and [How Rhize works]({{< relref "../get-started/how-rhize-works" >}}).
 
 ## What is an MDH?
 

content/get-started/how-rhize-works.md

@@ -49,9 +49,9 @@ To make the next sections less abstract, consider these examples of how Rhize cr
 
 A manufacturing data hub is useless without manufacturing data.
 
-The [Rhize agent]({{< relref "agent-configuration" >}}) collects data from MQTT brokers and devices, OPC-UA servers.
-You can also send data and documents over HTTP through a [GraphQL call]({{< ref "call-the-graphql-api" >}}).
-The Rhize UI also has a graphical interface to [model production]({{< ref "model" >}}) objects.
+The Rhize agent collects data from MQTT brokers and devices, OPC-UA servers.
+You can also send data and documents over HTTP through a [GraphQL call]({{< relref "../how-to/gql/call-the-graphql-api" >}}).
+The Rhize UI also has a graphical interface to [model production]({{< relref "../how-to/model" >}}) objects.
 
 All this data is mapped to Rhize's ISA-95 schema, which creates a coherent model for all objects in the data hub.
 

content/get-started/introduction.md

@@ -7,7 +7,7 @@ description: A Hub to join all manufacturing data in place. Build manufacturing
 weight: 1
 ---
 
-Rhize is a real-time, event-driven [manufacturing data hub]({{< relref "/explanations/manufacturing-data-hub" >}}).
+Rhize is a real-time, event-driven [manufacturing data hub]({{< relref "../explanations/manufacturing-data-hub" >}}).
 It unites data analysis, event monitoring, and process execution in one platform.
 Its interface and architecture is designed to conform to your processes.
 We assume nothing about what your manufacturing workflows look like.
@@ -51,7 +51,7 @@ Some examples of the flexibility include:
 - **Low-code interface**. Model your schema and execute processes using BPMN, a visual programming language. The visual interface makes Rhize and your manufacturing automation accessible to the widest possible audience.
 - **Generic data collection**. Rhize receives data from all levels of the manufacturing process. The [NATS](https://nats.io) broker publishes and subscribes to low-level data from [MQTT](https://mqtt.org/) and [OPC-UA](https://opcfoundation.org/about/opc-technologies/opc-ua/), but the database can also receive ERP inventories and documents sent over HTTP.
 
-[Read about use cases]({{< relref "/use-cases" >}}).
+[Read about use cases]({{< relref "../use-cases" >}}).
 
 ## Modern IT for manufacturing
 

content/how-to/audit.md

@@ -19,7 +19,7 @@ To use the audit log, ensure you have the following:
     - The ability to [Use the Rhize GraphQL API]({{< relref "gql" >}})
     - A token configured so that `audience` includes `audit`, and the scopes contain `audit:query`.
 
-    This scope should be created by BaaS, not manually. For details, refer to [Set up Keycloak](/deploy/install/keycloak/).
+    This scope should be created by BaaS, not manually. For details, refer to [Set up Keycloak]({{< relref "../../deploy/install/keycloak/" >}}).
 
 
 ## Audit through the UI

content/how-to/bpmn/bpmn-elements.md

@@ -36,7 +36,7 @@ Every BPMN workflow and every element that the workflow contains have the follow
 
 | Parameter            | Description                                                                                                               |
 |----------------------|---------------------------------------------------------------------------------------------------------------------------|
-| ID                   | Mandatory unique ID. For guidance, follow the [BPMN naming conventions]({{< relref "/how-to/bpmn/naming-conventions" >}}). |
+| ID                   | Mandatory unique ID. For guidance, follow the [BPMN naming conventions]({{< relref "./naming-conventions" >}}). |
 | Name                 | Optional human readable name. If empty, takes ID value.                                                                              |
 | Documentation        | Optional freeform text for additional information                                                                                  |
 | Extension properties | Optional metadata to add to workflow or node                                                                              |
@@ -127,7 +127,7 @@ The parameters for an intermediate message event are as follows:
 | Parameter | Description                                                                                                                                                                      |
 |-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Message   | The topic the message publishes to on the Rhize Broker. The topic structure follows MQTT syntax                                                                                  |
-| Inputs    | Variables to send in the body. For messages to the Rhize broker, use the [special variable]({{< relref "/how-to/bpmn/variables">}}) `BODY`. Value can be JSON or JSONata. |
+| Inputs    | Variables to send in the body. For messages to the Rhize broker, use the [special variable]({{< relref "./variables">}}) `BODY`. Value can be JSON or JSONata. |
 | Headers   | {{< param boilerplate.headers >}}                                                                                                                                                |
 | Outputs   | JSON or JSONata. Optional variables to add to the {{< abbr "process variable context" >}}.                                                                                       |
 
@@ -209,7 +209,7 @@ Besides the call parameters, the Query task has following additional fields:
 
 | Parameter      | Description                                                                                                                                                                       |
 |----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Input response | {{% param boilerplate.jsonata_response %}}. For GraphQL operations, use this only to map values. Rely on [GQL filters]({{< relref "/how-to/gql/filter" >}}) to limit the payload. |
+| Input response | {{% param boilerplate.jsonata_response %}}. For GraphQL operations, use this only to map values. Rely on [GQL filters]({{< relref "../gql/filter" >}}) to limit the payload. |
 | Headers        | {{< param boilerplate.headers >}}                                                                                                                                                 |
 
 ### GraphQL Mutation
@@ -332,7 +332,7 @@ The outputs have the following parameters:
 |Local variable name | What to name the incoming data,  as it will be accessed in the parent process (that is, the key name) |
 | assignment value    | The value to pass from the child variable context                                                     |
 
-For a guide to reusing functions, read the [Reuse workflows section]({{< relref "/how-to/bpmn/create-workflow/#reuse-workflows" >}}) in the "Create workflow" guide.
+For a guide to reusing functions, read the [Reuse workflows section]({{< relref "./create-workflow/#reuse-workflows" >}}) in the "Create workflow" guide.
 
 ## Gateways