Merge pull request #11 from boozallen/5-migrate-documentation

d-ryan-ashcraft · web-flow · commit 12a955d38f71 · 2024-04-30T07:05:01.000-04:00
#5 📝 some initial documentation tweaks
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -2,7 +2,7 @@ name: Publish to GitHub Pages
 on:
   workflow_dispatch:
   push:
-    branches: [dev, master]
+    branches: [dev]
 jobs:
   build:
     runs-on: ubuntu-latest
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE
+# aiSSEMBLE&trade;
 
 ## aiSSEMBLE Overview
 
diff --git a/docs/README.md b/docs/README.md
@@ -1,2 +1,66 @@
-# aiSSEMBLE Documentation
-aiSSEMBLE(TM) Documentation will be published: https://github.com/boozallen/aissemble/issues/5
+# aiSSEMBLE&trade; Documentation
+## Contributing to Docs
+Please refer to [CONTRIBUTING.md](CONTRIBUTING.md). 
+
+## Previewing Documentation Updates
+Prior to merging with the dev branch, all documentation updates should be viewed locally via a web server to verify all 
+features are functioning properly. In order to accomplish this, utilize the *http-server* package for Node.js. 
+
+### Pre-requisites: 
+1. Install Node.js
+2. Install *http-server* and *antora* packages
+    ```bash
+    npm i http-server antora
+   ```
+
+### Steps:
+1. In a terminal, navigate to `docs/`.
+2. Run antora build:
+   ```bash
+    npx antora antora-playbook-local.yml --to-dir=site
+   ```
+3. Start local web server: 
+   ```bash
+   npx http-server site -c-1 
+   ```
+4. Access webpage from a browser http://localhost:8080/
+5. Change version to current snapshot to view changes.
+
+For further information on running *http-server*, check out Antora [docs](https://docs.antora.org/antora/latest/preview-site/).
+
+### Steps to build preview UI (test the Antora UI source changes):
+1. In a terminal, navigate to `docs/antora-aissemble-ui` and run:
+      ```bash
+      npm install
+      ```
+2. Run "npx gulp preview:build" to build the UI once for preview.
+3. Run the following gulp preview command to have it run continuously. This task also launches a local HTTP server so updates get synchronized with the browser (i.e., “live reload”).:
+      ```bash
+      npx gulp preview
+      ```
+4. Access webpage from a browser http://localhost:5252/
+
+For further information on build and preview UI, check out Antora [docs](https://docs.antora.org/antora-ui-default/build-preview-ui/).
+
+### Package for previewing:
+1. To bundle the UI in order to preview the UI on the real site in local development, run the following command:
+    ```bash
+    npx gulp bundle
+   ```
+2. The UI bundle will be available at `build/ui-bundle.zip`.
+   _Note: this zip will need to be committed after the changes have been made_
+
+For further information on packaging for previewing, check out Antora [docs](https://docs.antora.org/antora-ui-default/build-preview-ui/).
+
+## Releasing a Fixed Version
+TODO: update with content
+
+## GitHub Actions - Documentation Update Workflow
+
+GitHub actions is a CI/CD platform that automates the build, test, and deployment pipeline. It allows
+you to run workflows with event triggers.  A workflow is a configurable, automated process that
+will run one or more jobs. Within the aiSSEMBLE repository, a workflow has been established to 
+deploy all documentation upon merging with the dev branch and is defined in the `.github/workflows/publish.yml` file.
+
+For more information about GitHub actions, see [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions).
+
diff --git a/extensions/extensions-docker/aissemble-jenkins/README.md b/extensions/extensions-docker/aissemble-jenkins/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Ready Jenkins Deployment
+# aiSSEMBLE&trade; Ready Jenkins Deployment
 The containers in this project provide an instance of Jenkins that 
 requires minimal setup for aiSSEMBLE projects.  It comes preconfigured 
 the plugins and configuration files you need to quickly setup up Jenkins
diff --git a/extensions/extensions-docker/aissemble-model-training-api-containers/README.md b/extensions/extensions-docker/aissemble-model-training-api-containers/README.md
@@ -1,4 +1,4 @@
-## aiSSEMBLE Model Training API
+## aiSSEMBLE&trade; Model Training API
 
 This module contains the implementation and baseline Docker image for the aiSSEMBLE model training and model training sagemaker service. This service allows you to submit sagemaker model training jobs and retrieves the status of a specific sagemaker traning job
 
diff --git a/extensions/extensions-docker/aissemble-nvidia/README.md b/extensions/extensions-docker/aissemble-nvidia/README.md
@@ -1,4 +1,4 @@
-This module builds an aiSSEMBLE extension of the [Nvidia CUDA docker image](https://hub.docker.com/r/nvidia/cuda). The
+This module builds an aiSSEMBLE&trade; extension of the [Nvidia CUDA docker image](https://hub.docker.com/r/nvidia/cuda). The
 base image has a strict EOL policy for tags, so this module will need to be updated as new versions are released. Read
 the [official policy](https://gitlab.com/nvidia/container-images/cuda/-/blob/master/doc/support-policy.md) for more
 details.
diff --git a/extensions/extensions-docker/aissemble-policy-decision-point/README.md b/extensions/extensions-docker/aissemble-policy-decision-point/README.md
@@ -7,7 +7,7 @@ To start this container run
 
 `docker run -p 8780:8080 boozallen/aissemble-policy-decision-point:AISSEMBLE_VERSION`
 
-substituting the current aiSSEMBLE version for `AISSEMBLE_VERSION`, ie 1.2.0-SNAPSHOT
+substituting the current aiSSEMBLE&trade; version for `AISSEMBLE_VERSION`, ie 1.2.0-SNAPSHOT
 
 To make a call to the decision point use the following REST endpoint
 
diff --git a/extensions/extensions-docker/aissemble-spark-operator/README.md b/extensions/extensions-docker/aissemble-spark-operator/README.md
@@ -1,6 +1,6 @@
 # Overview
 This module serves as a mechanism for building the `spark-operator` docker image for
-aiSSEMBLE with tight coupling with the aiSSEMBLE supported Spark version(s).  The 
+aiSSEMBLE&trade; with tight coupling with the aiSSEMBLE supported Spark version(s).  The 
 `spark-operator` source code, written primarily in Go, is largely created and supported
 through the official repository at https://github.com/kubeflow/spark-operator/tree/master.
 This repository is cloned with each build to guarantee that aiSSEMBLE is always using the
diff --git a/extensions/extensions-docker/aissemble-vault/README.md b/extensions/extensions-docker/aissemble-vault/README.md
@@ -2,5 +2,5 @@
 
 Whenever the Vault server initializes, new unseal and root keys are created, so the configuration will need to be updated.
 The [technical documentation](https://boozallen.github.io/aissemble/current-dev/data-encryption.html#_vault_encryption)
-has more information on how to configure Vault encryption. Note: the aiSSEMBLE Vault image installs HashiCorp tools in
+has more information on how to configure Vault encryption. Note: the aiSSEMBLE&trade; Vault image installs HashiCorp tools in
 order to provide encryption service. Setup of the Vault server is based off of the official Hashicorp vault image.
diff --git a/extensions/extensions-docker/aissemble-versioning/README.md b/extensions/extensions-docker/aissemble-versioning/README.md
@@ -1,4 +1,4 @@
-## aiSSEMBLE Versioning
+## aiSSEMBLE&trade; Versioning
 
 This module contains the baseline Docker image for the aiSSEMBLE versioning service. The service provides the ability to version artifacts produced by a Solution Baseline machine-learning pipeline, and uses Maven to package and deploy the artifacts to Nexus.
 
diff --git a/extensions/extensions-encryption/aissemble-extensions-encryption-vault-python/README.md b/extensions/extensions-encryption/aissemble-extensions-encryption-vault-python/README.md
@@ -73,7 +73,7 @@ The following example illustrates how to perform encryption.
     # decrypt cipher text data using AES CBC
     decrypted_value = aes_gcm_96.decrypt(encrypted_value)
     ```
-## AISSEMBLE Data Encryption
+## AISSEMBLE&trade; Data Encryption
 
 This package includes one security client for calling the "Secrets as a Service" encryption service.
 
diff --git a/extensions/extensions-helm/README.md b/extensions/extensions-helm/README.md
@@ -1,5 +1,5 @@
 # Extensions Helm
-Parent module for aiSSEMBLE Helm charts. 
+Parent module for aiSSEMBLE&trade; Helm charts. 
 
 ## Requirements
 Each aiSSEMBLE Helm chart should contain the following
diff --git a/extensions/extensions-helm/aissemble-airflow-chart/README.md b/extensions/extensions-helm/aissemble-airflow-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Airflow Helm Chart
+# aiSSEMBLE&trade; Airflow Helm Chart
 Baseline Helm chart for packaging and deploying Airflow. Built on the [official Helm chart](https://airflow.apache.org/docs/helm-chart/stable) and managed during the 
 normal Maven build lifecycle and placed in the **target/helm/repo** directory. See 
 [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
diff --git a/extensions/extensions-helm/aissemble-data-access-chart/README.md b/extensions/extensions-helm/aissemble-data-access-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Data Access Helm Chart
+# aiSSEMBLE&trade; Data Access Helm Chart
 Baseline Helm chart for packaging and deploying aiSSEMBLE Data Access module. Built on the extension-helm-quarkus module and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-elasticsearch-chart/README.md b/extensions/extensions-helm/aissemble-elasticsearch-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Elasticsearch Helm Chart
+# aiSSEMBLE&trade; Elasticsearch Helm Chart
 Baseline Helm chart for packaging and deploying Elasticsearch. Built on the [ECK Stack Helm chart](https://github.com/elastic/cloud-on-k8s/tree/main/deploy/eck-stack) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-elasticsearch-operator-chart/README.md b/extensions/extensions-helm/aissemble-elasticsearch-operator-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Elasticsearch Operator Helm Chart
+# aiSSEMBLE&trade; Elasticsearch Operator Helm Chart
 Baseline Helm chart for packaging and deploying Elasticsearch Operator. Built on the [EKC Operator Helm chart](https://github.com/elastic/cloud-on-k8s/tree/main/deploy/eck-operator) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-fastapi-chart/README.md b/extensions/extensions-helm/aissemble-fastapi-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE FastAPI Helm Chart
+# aiSSEMBLE&trade; FastAPI Helm Chart
 Baseline Helm chart for packaging and deploying FastAPI web applications. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-inference-chart/README.md b/extensions/extensions-helm/aissemble-inference-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Inference Helm Chart
+# aiSSEMBLE&trade; Inference Helm Chart
 Baseline Helm chart for packaging and deploying inference applications. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-jenkins-chart/README.md b/extensions/extensions-helm/aissemble-jenkins-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Jenkins Helm Chart
+# aiSSEMBLE&trade; Jenkins Helm Chart
 Baseline Helm chart for packaging and deploying Jenkins. Built on the [official Helm chart](https://github.com/jenkinsci/helm-charts)
 and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See the 
 [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
diff --git a/extensions/extensions-helm/aissemble-kafka-chart/README.md b/extensions/extensions-helm/aissemble-kafka-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Apache Kafka Helm Chart
+# aiSSEMBLE&trade; Apache Kafka Helm Chart
 Baseline Helm chart for packaging and deploying Kafka. Built on the [Bitnami Helm chart](https://bitnami.com/stack/kafka/helm) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-keycloak-chart/README.md b/extensions/extensions-helm/aissemble-keycloak-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Apache Keycloak Helm Chart
+# aiSSEMBLE&trade; Apache Keycloak Helm Chart
 Baseline Helm chart for packaging and deploying Keycloak. Built on the [Bitnami Helm chart](https://bitnami.com/stack/keycloak/helm) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-lineage-http-consumer-chart/README.md b/extensions/extensions-helm/aissemble-lineage-http-consumer-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Lineage HTTP Consumer Helm Chart
+# aiSSEMBLE&trade; Lineage HTTP Consumer Helm Chart
 Baseline Helm chart for packaging and deploying the [aiSSEMBLE lineage HTTP consumer](https://boozallen.github.io/aissemble/current/lineage-medatada-capture-overview.html#_http_consumer). Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-localstack-chart/README.md b/extensions/extensions-helm/aissemble-localstack-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Localstack Helm Chart
+# aiSSEMBLE&trade; Localstack Helm Chart
 
 Baseline Helm chart for packaging and deploying localstack. The chart is built and managed during the normal Maven build
 lifecycle and placed in the **target/helm/repo** directory.
diff --git a/extensions/extensions-helm/aissemble-metadata-chart/README.md b/extensions/extensions-helm/aissemble-metadata-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Metadata Helm Chart
+# aiSSEMBLE&trade; Metadata Helm Chart
 Baseline Helm chart for packaging and deploying metadata service. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-mlflow-chart/README.md b/extensions/extensions-helm/aissemble-mlflow-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE MLflow Helm Chart
+# aiSSEMBLE&trade; MLflow Helm Chart
 Baseline Helm chart for packaging and deploying MLflow. Built on the [Bitnami Helm chart](https://bitnami.com/stack/mlflow/helm) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-policy-decision-point-chart/README.md b/extensions/extensions-helm/aissemble-policy-decision-point-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Policy Decision Point Helm Chart
+# aiSSEMBLE&trade; Policy Decision Point Helm Chart
 Baseline Helm chart for packaging and deploying policy decision point service. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-quarkus-chart/README.md b/extensions/extensions-helm/aissemble-quarkus-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Quarkus Helm Chart
+# aiSSEMBLE&trade; Quarkus Helm Chart
 Baseline Helm chart for packaging and deploying Quarkus web applications. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-sealed-secrets-chart/README.md b/extensions/extensions-helm/aissemble-sealed-secrets-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE SealedSecrets Helm Chart
+# aiSSEMBLE&trade; SealedSecrets Helm Chart
 
 Baseline Helm chart for packaging and deploying SealedSecrets. Built on the [official Helm chart](https://github.com/bitnami-labs/sealed-secrets/tree/main/helm/sealed-secrets) and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
diff --git a/extensions/extensions-helm/aissemble-spark-application-chart/README.md b/extensions/extensions-helm/aissemble-spark-application-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Spark Application Helm Chart
+# aiSSEMBLE&trade; Spark Application Helm Chart
 Baseline Helm chart for packaging and deploying spark applications. The chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/aissemble-spark-operator-chart/README.md b/extensions/extensions-helm/aissemble-spark-operator-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Spark Operator Helm Chart
+# aiSSEMBLE&trade; Spark Operator Helm Chart
 Baseline Helm chart for deploying the Spark Kubernetes Operator. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details.
 
 This chart is based heavily upon the original spark-On-k8s-operator upstream chart, available at https://github.com/kubeflow/spark-operator/blob/master/charts/spark-operator-chart/README.md.
diff --git a/extensions/extensions-helm/aissemble-vault-chart/README.md b/extensions/extensions-helm/aissemble-vault-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Vault Helm Chart
+# aiSSEMBLE&trade; Vault Helm Chart
 Baseline Helm chart for packaging and deploying Vault. Built on the [official Helm chart](https://github.com/hashicorp/vault-helm)
 and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See the
 [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
diff --git a/extensions/extensions-helm/aissemble-versioning-chart/README.md b/extensions/extensions-helm/aissemble-versioning-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Versioning Helm Chart
+# aiSSEMBLE&trade; Versioning Helm Chart
 Baseline Helm chart for packaging and deploying aiSSEMBLE Versioning module. Built on the extension-helm-fastapi module and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See [Helm Maven Plugin](https://github.com/kokuwaio/helm-maven-plugin) for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/extensions-helm-hive/aissemble-hive-metastore-db-chart/README.md b/extensions/extensions-helm/extensions-helm-hive/aissemble-hive-metastore-db-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Hive Metastore DB Helm Chart
+# aiSSEMBLE&trade; Hive Metastore DB Helm Chart
 Baseline Helm chart for packaging and deploying Hive Metastore MySql Databases. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/extensions-helm-hive/aissemble-hive-metastore-service-chart/README.md b/extensions/extensions-helm/extensions-helm-hive/aissemble-hive-metastore-service-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Hive Metastore Service Helm Chart
+# aiSSEMBLE&trade; Hive Metastore Service Helm Chart
 Baseline Helm chart for packaging and deploying Hive Metastore Services. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details. 
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/extensions-helm-pipeline-invocation/aissemble-pipeline-invocation-app-chart/README.md b/extensions/extensions-helm/extensions-helm-pipeline-invocation/aissemble-pipeline-invocation-app-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Pipeline Invocation Helm Chart
+# aiSSEMBLE&trade; Pipeline Invocation Helm Chart
 Baseline Helm chart for packaging and deploying a pipeline invocation service. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details.
 
 # Basic usage with Helm CLI
diff --git a/extensions/extensions-helm/extensions-helm-pipeline-invocation/extensions-helm-pipeline-invocation-lib/aissemble-pipeline-invocation-lib-src-chart/README.md b/extensions/extensions-helm/extensions-helm-pipeline-invocation/extensions-helm-pipeline-invocation-lib/aissemble-pipeline-invocation-lib-src-chart/README.md
@@ -1,4 +1,4 @@
-# aiSSEMBLE Library Helm Chart
+# aiSSEMBLE&trade; Library Helm Chart
 Baseline Helm chart containing helper functions and libraries for use in other aiSSEMBLE-produced charts. Chart is built and managed during the normal Maven build lifecycle and placed in the **target/helm/repo** directory. See https://github.com/kokuwaio/helm-maven-plugin for more details.
 
 # Provided Charts
diff --git a/foundation/README.md b/foundation/README.md
@@ -1,5 +1,5 @@
 # Foundation
-Foundational components for aiSSEMBLE efforts
+Foundational components for aiSSEMBLE&trade; efforts
 
 
 ## Build
diff --git a/foundation/aissemble-foundation-model-training-api/README.md b/foundation/aissemble-foundation-model-training-api/README.md
@@ -1,4 +1,4 @@
-## aiSSEMBLE Model Training API
+## aiSSEMBLE&trade; Model Training API
 
 This module contains the implementation and baseline Docker image for the aiSSEMBLE model training service. This service allows you to create model training jobs, list jobs, retrieve job logs, and kill jobs.
 
diff --git a/foundation/aissemble-foundation-versioning-service/README.md b/foundation/aissemble-foundation-versioning-service/README.md
@@ -1,4 +1,4 @@
-## aiSSEMBLE Versioning
+## aiSSEMBLE&trade; Versioning
 
 This module contains the implementation for the aiSSEMBLE versioning service. The service provides the ability to version artifacts produced by a Solution Baseline machine-learning pipeline, and uses Maven to package and deploy the artifacts to Nexus.
 
diff --git a/foundation/foundation-configuration-store/README.md b/foundation/foundation-configuration-store/README.md
@@ -3,7 +3,7 @@ This module serves as a tool that enables the various configurations for a proje
 
 This README is intended to provide technical insight into the
 implementation of this package.  For consumption guidance,
-please refer to the [aiSSEMBLE Github Pages](https://boozallen.github.io/aissemble/current/guides/guides-configuration-store.html).
+please refer to the [aiSSEMBLE&trade; Github Pages](https://boozallen.github.io/aissemble/current/guides/guides-configuration-store.html).
 
 ## Developer Guidance
 
diff --git a/foundation/foundation-lineage/aissemble-foundation-model-lineage/README.md b/foundation/foundation-lineage/aissemble-foundation-model-lineage/README.md
@@ -1,7 +1,7 @@
 # aissemble-foundation-model-lineage-python
 This module serves as a generic wrapper for model lineage 
 types, objects, and functions.  While it is designed to be 
-leveraged through the aiSSEMBLE ecosystem, it is not dependent
+leveraged through the aiSSEMBLE&trade; ecosystem, it is not dependent
 on aiSSEMBLE for execution.  It is intentionally designed for 
 portability.
 
diff --git a/foundation/foundation-lineage/foundation-data-lineage/aissemble-foundation-data-lineage-python/README.md b/foundation/foundation-lineage/foundation-data-lineage/aissemble-foundation-data-lineage-python/README.md
@@ -1,7 +1,7 @@
 # aissemble-foundation-data-lineage-python
 This module serves as a generic wrapper for data lineage 
 types, objects, and functions.  While it is designed to be 
-leveraged through the aiSSEMBLE ecosystem, it is not dependent
+leveraged through the aiSSEMBLE&trade; ecosystem, it is not dependent
 on aiSSEMBLE for execution.  It is intentionally designed for 
 portability.
 
diff --git a/foundation/foundation-lineage/foundation-data-lineage/foundation-data-lineage-java/README.md b/foundation/foundation-lineage/foundation-data-lineage/foundation-data-lineage-java/README.md
@@ -1,7 +1,7 @@
 # foundation-data-lineage-java
 This module serves as a generic wrapper for data lineage 
 types, objects, and functions.  While it is designed to be 
-leveraged through the aiSSEMBLE ecosystem, it is not dependent
+leveraged through the aiSSEMBLE&trade; ecosystem, it is not dependent
 on aiSSEMBLE for execution.  It is intentionally designed for 
 portability.
 
diff --git a/foundation/foundation-maven-plugins/artifacts-maven-plugin/pom.xml b/foundation/foundation-maven-plugins/artifacts-maven-plugin/pom.xml
diff --git a/foundation/foundation-mda/README.md b/foundation/foundation-mda/README.md
diff --git a/foundation/foundation-messaging/foundation-messaging-python/aissemble-foundation-messaging-python-client/README.md b/foundation/foundation-messaging/foundation-messaging-python/aissemble-foundation-messaging-python-client/README.md
diff --git a/foundation/foundation-messaging/foundation-messaging-python/foundation-messaging-python-service/README.md b/foundation/foundation-messaging/foundation-messaging-python/foundation-messaging-python-service/README.md
diff --git a/test/src/test/resources/README.md b/test/src/test/resources/README.md
diff --git a/test/test-mda-models/aissemble-test-data-delivery-pyspark-model-basic/README.md b/test/test-mda-models/aissemble-test-data-delivery-pyspark-model-basic/README.md
diff --git a/test/test-mda-models/aissemble-test-data-delivery-pyspark-model/README.md b/test/test-mda-models/aissemble-test-data-delivery-pyspark-model/README.md
