rename titles

sartography · Jan 11, 2025 · 3321e4b · 3321e4b
1 parent bda9d61
commit 3321e4b
Show file tree

Hide file tree

Showing 16 changed files with 32 additions and 26 deletions.
diff --git a/docs/how_to_guides/building_diagrams/builtin_examples_overview.md b/docs/how_to_guides/building_diagrams/builtin_examples_overview.md
@@ -1,4 +1,4 @@
-# Built-in Examples Overview
+# Overview of Built-in Examples
 
 When logging into the dashboard, it is crucial to familiarize yourself with the functions it offers and how the underlying engine operates.
 In the demo website, we will explore two examples: the Minimal Example and the Essential Example, to provide a clear understanding of the process.

diff --git a/docs/how_to_guides/building_diagrams/displaying_content.md b/docs/how_to_guides/building_diagrams/displaying_content.md
@@ -1,4 +1,4 @@
-# Displaying Content
+# Display Content
 
 The SpiffArena platform offers powerful features for displaying content within your BPMN processes.
 Follow the steps below to effectively display content in your processes.

diff --git a/docs/how_to_guides/building_diagrams/executable_and_nonexecutable_tasks.md b/docs/how_to_guides/building_diagrams/executable_and_nonexecutable_tasks.md
@@ -1,4 +1,4 @@
-# Executable and Non-Executable Tasks
+# Use Executable and Non-Executable Tasks
 
 In SpiffWorkflow, a process model can be either **Executable** or **Non-Executable**, and the designation impacts how the workflow behaves:
 - **Executable Process**: Configured for automation and execution by the workflow engine. All tasks within the process are actionable and designed to run dynamically.

diff --git a/docs/how_to_guides/building_diagrams/how_to_create_a_bpmn_diagram.md b/docs/how_to_guides/building_diagrams/how_to_create_a_bpmn_diagram.md
@@ -1,4 +1,4 @@
-# How to Create a BPMN Diagram
+# Create a BPMN Diagram
 
 Starting to model a business process can indeed be a challenging task, especially when multiple departments and users are involved.
 Here are some helpful tips to guide you through the process and create effective process models:

diff --git a/docs/how_to_guides/building_diagrams/user_tasks_and_forms.md b/docs/how_to_guides/building_diagrams/user_tasks_and_forms.md
@@ -1,4 +1,4 @@
-# User Tasks and Forms
+# Use User Tasks and Forms
 User Tasks are a key feature in BPMN (Business Process Model and Notation) workflows where human interaction is required to complete a process. In SpiffWorkflow, User Tasks are closely integrated with Forms, which are used to collect input or display information to users during process execution.
 
 Some key features of user tasks are:

diff --git a/docs/how_to_guides/custom_process_metadata.md b/docs/how_to_guides/custom_process_metadata.md
@@ -1,4 +1,4 @@
-# Custom Process Metadata
+# Use Custom Process Metadata
 
 This guide will walk you through the steps to create a process model that generates custom metadata using a metadata extraction path and how to query that metadata using process instance filtering.
 

diff --git a/docs/how_to_guides/deployment/admin_and_permissions.md b/docs/how_to_guides/deployment/admin_and_permissions.md
@@ -1,4 +1,4 @@
-# Admin and Permissions
+# Manage Permissions
 
 Permissions can be defined and managed at different levels such as process groups, individual processes, or users.
 

diff --git a/docs/how_to_guides/deployment/configuring_okta_as_an_openid_provider.md b/docs/how_to_guides/deployment/configuring_okta_as_an_openid_provider.md
@@ -1,4 +1,4 @@
-# Configuring Okta as an OpenID Provider
+# Configure Okta as an OpenID Provider
 This guide provides steps to configure Okta as an OpenID Provider (alternative to Keycloak) for SpiffWorkflow. 
 
 The setup involves creating an OpenID Connect (OIDC) application, configuring environment variables, and ensuring group information is passed through correctly.  

diff --git a/...w_to_guides/deployment/deploying_a_connector_proxy_as_an_aws_lambda_function.md b/...w_to_guides/deployment/deploying_a_connector_proxy_as_an_aws_lambda_function.md
@@ -1,4 +1,4 @@
-# Deploying a Connector Proxy as an AWS Lambda Function
+# Deploy a Connector Proxy as an AWS Lambda Function
 
 This guide shows you how to deploy the demo `Connector Proxy` as an `AWS Lambda Function` and integrate it with [SpiffArena](https://www.spiffworkflow.org/pages/spiffarena/).
 We will use the [Getting Started Guide](https://www.spiffworkflow.org/posts/articles/get_started/) as the basis for integration, but the steps should easily map to any custom installation.

diff --git a/docs/how_to_guides/deployment/deployment.md b/docs/how_to_guides/deployment/deployment.md
@@ -1,4 +1,4 @@
-# Deployment
+# Deploy
 
 The minimal deployment is to mimic the docker-compose.yml file at the root of spiff-arena.
 Steps for a more hardened production setup after that baseline include:
@@ -28,4 +28,5 @@ API, Celery Worker, Connector Proxy, and Frontend can run any number of replicas
 The Background container is like a cron container, so it should run only one replica.
 
 ```{tags} how_to_guide
+
 ```
diff --git a/docs/how_to_guides/deployment/how_to_configure_secrets_in_spiffarena.md b/docs/how_to_guides/deployment/how_to_configure_secrets_in_spiffarena.md
@@ -1,4 +1,4 @@
-# How to Configure Secrets in SpiffArena
+# Configure Secrets
 
 ## Introduction
 
@@ -18,36 +18,40 @@ Secrets are only used in service tasks.
 - **SpiffArena Admin**: Can add or configure secrets.
 - **External Service Admin**: For example, an admin in Bamboo HR can provide the API key that a SpiffArena admin would then configure as a secret.
 - **Diagram Author**: Can reference secrets in service tasks but cannot see the actual secret values.
+
 ---
 
 ## How to Configure Secrets
 
 ### Adding a New Secret
 
 1. **Navigate to the Configuration Section**: Go to the configuration section from the top panel and click on "Add a secret." Ensure you have admin access to SpiffArena.
-![Configuration Section](/images/Secrets_step_1.png)
+   ![Configuration Section](/images/Secrets_step_1.png)
 
 2. **Add New Secret**: Create a new secret by entering a key and its corresponding value. Once saved, the value will be encrypted.
-![Secrets Section](/images/Secrets_step_2.png)
+   ![Secrets Section](/images/Secrets_step_2.png)
 
 ### Using Secrets in Service Tasks
 
-1. **Open the BPMN Diagram**: Open the diagram where you want to configure the service task.
+1.  **Open the BPMN Diagram**: Open the diagram where you want to configure the service task.
+
+2.  **Configure Service Task**: Click on the service task you want to configure and in the service properties panel, search for the Operator ID that you want to add a secret for and mention the response variable to capture the result of the request.
 
-2. **Configure Service Task**: Click on the service task you want to configure and in the service properties panel, search for the Operator ID that you want to add a secret for and mention the response variable to capture the result of the request.
+3.  **Add Secret Reference**: In the parameters, you can reference the secret using the following format:
 
-3. **Add Secret Reference**: In the parameters, you can reference the secret using the following format:
+        ```xml
+        spiffworkflow:parameter id="headers" type="any" value="{ "Authorization": "Bearer SPIFF_SECRET:github_oauth" }"
+        ```
 
-    ```xml
-    spiffworkflow:parameter id="headers" type="any" value="{ "Authorization": "Bearer SPIFF_SECRET:github_oauth" }"
-    ```
+        Here, `SPIFF_SECRET:github_oauth` will be replaced by the actual, unencrypted value from the database when the service task runs.
+
+    ![Secrets Configuration](/images/Secrets_configure_2.png)
 
-    Here, `SPIFF_SECRET:github_oauth` will be replaced by the actual, unencrypted value from the database when the service task runs.
-![Secrets Configuration](/images/Secrets_configure_2.png)
 ---
 
 Configuring secrets in SpiffArena provides a secure way to handle sensitive information in your BPMN diagrams.
 It allows you to make your processes public without exposing critical data, thereby enhancing both transparency and security.
 
 ```{tags} how_to_guide
+
 ```
diff --git a/docs/how_to_guides/deployment/pathbased_routing.md b/docs/how_to_guides/deployment/pathbased_routing.md
@@ -1,4 +1,4 @@
-# Path-based Routing
+# Use Path-based Routing
 
 If you are using the frontend, the frontend and backend need to share cookies.
 The backend, in particular, sets a cookie, and the frontend needs to read it.

diff --git a/docs/how_to_guides/deployment/process_model_management.md b/docs/how_to_guides/deployment/process_model_management.md
@@ -1,4 +1,4 @@
-# Process Model Management
+# Manage Process Models
 
 Managing your process models is similar to managing your source code.
 As such, it is recommended to store these models in a version control system like Git so that you can track changes and collaborate with others.

diff --git a/docs/how_to_guides/deployment/redis_celery_broker.md b/docs/how_to_guides/deployment/redis_celery_broker.md
@@ -1,4 +1,4 @@
-# Redis Celery Broker
+# Work with Redis Celery Broker
 
 SpiffWorkflow can be configured to use Celery for efficient processing.
 Redis can be used as both a broker and backend for Celery.
@@ -41,4 +41,5 @@ echo 'keys celery-task-meta-\*' | redis-cli | sed 's/^/get /' | redis-cli
 ```
 
 ```{tags} how_to_guide, dev_docs
+
 ```
diff --git a/docs/how_to_guides/troubleshooting_locally.md b/docs/how_to_guides/troubleshooting_locally.md
@@ -1,4 +1,4 @@
-# Troubleshooting Locally
+# Troubleshoot Locally
 
 When setting up the SpiffWorkflow backend project locally, you might encounter issues related to the `sample-process-models` directory.
 This documentation aims to address those concerns.

diff --git a/docs/how_to_guides/welcome_messages.md b/docs/how_to_guides/welcome_messages.md
@@ -1,4 +1,4 @@
-# Welcome Messages
+# Manage Welcome Messages
 
 ## Introduction