Merge branch 'main' into RHIDP-7849

Author: themr0c

assemblies/assembly-configuring-techdocs.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 :context: configuring-techdocs
 [id="{context}"]
-= TechDocs configuration
+= Configuring TechDocs
 
 The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
 
@@ -19,22 +19,23 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
 
 * For more information, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
 
+//configuring storage
 include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
 
+//configuring storage - Amazon S3
+include::modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc[leveloffset=+2]
+
+//configuring storage - ODF
 include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
 
-include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
+include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+3]
 
-include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
+include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+4]
 
-include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
+include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+3]
 
-include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
+include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+4]
 
+//configuring CI/CD
 include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]
 
-include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
-
-include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]
-
-include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2]

assemblies/assembly-log-levels.adoc

@@ -0,0 +1,18 @@
+[id="assembly-log-levels_{context}"]
+= Log Levels
+
+Logging is an essential part of monitoring and debugging software applications. It provides insight into how the application is functioning at runtime and can help you detect and diagnose issues. By adjusting the log level, you can control the amount and type of information displayed in the logs, ranging from highly detailed diagnostic output to the most critical errors. With this flexibility, you can customize logging output to match your current requirements, whether during development, testing, or production.
+
+You can choose from the following log levels, listed in order of decreasing verbosity:
+
+- `debug`: Detailed information, typically useful only when troubleshooting.
+- `info`: General information about the operation of the application. This is the default level.
+- `warn`: Indicates potential issues or situations that might require attention.
+- `error`: Indicates errors that have occurred but might not prevent the application from continuing.
+- `critical`: Indicates critical errors that require immediate attention and are likely to prevent the application from functioning correctly.
+
+You can control the verbosity of the logging by setting the log level. The log level determines the minimum severity level of events displayed in the console. For example, if the log level is set to 'info', events with a severity level of 'debug' are ignored.
+
+To increase the log level, you can set the `LOG_LEVEL` environment variable to a higher severity level, such as 'warn' or 'error'. However, increasing the log level might not result in more output if the existing code primarily emits logs at lower severity levels, for example, 'debug' or 'info'. In such a case, adjust the logging statements within the code to use higher severity levels to see more output.
+
+No additional steps are required beyond setting the `LOG_LEVEL` environment variable, but its effectiveness depends on the existing logging statements in the code.

assemblies/assembly-logging-with-amazon-cloudwatch.adoc

@@ -2,9 +2,6 @@
 = Logging with Amazon CloudWatch
 
 Logging within the {product} relies on the link:https://github.com/winstonjs/winston[Winston library].
-The default logging level is `info`.
-To have more detailed logs, set the `LOG_LEVEL` environment variable to `debug` in your {product} instance.
-
 
 include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc[leveloffset=+1]
 

assemblies/assembly-using-techdocs.adoc

@@ -12,3 +12,9 @@ include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1]
 include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1]
 
 include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1]
+
+//embedding videos
+include::modules/techdocs/proc-techdocs-embed-videos.adoc[leveloffset=+1]
+
+//generating pipelines with GitHub Actions
+include::modules/techdocs/proc-techdocs-pipeline-github-actions.adoc[leveloffset=+1]

modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-operator-deployment.adoc

@@ -16,10 +16,12 @@ kind: Backstage
 metadata: 
   name: _<your_yaml_file>_ 
 spec:
-  application: 
-    ... 
-    replicas: _<replicas_value>_ <1>
-    ...
+  deployment:
+    patch:
+      spec: 
+        ... 
+        replicas: _<replicas_value>_ <1>
+        ...
 ----
 ====
 <1> Set the number of replicas based on the number of backup instances that you want to configure.

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

@@ -31,10 +31,9 @@ spec:
          - name: {my-app-config-config-map}
     extraEnvs:
       secrets:
-         - name: `_<my_product_secrets>_`
+         - name: _<my_product_secrets>_
     extraFiles:
       mountPath: /opt/app-root/src
-    replicas: 1
     route:
       enabled: true
   database:
@@ -60,14 +59,13 @@ spec:
     dynamicPluginsConfigMapName: dynamic-plugins-rhdh
     extraEnvs:
       secrets:
-         - name: `_<my_product_secrets>_`
+         - name: _<my_product_secrets>_
          - name: {my-product-database-secrets}
     extraFiles:
       mountPath: /opt/app-root/src
       secrets:
         - name: {my-product-database-certificates-secrets}
           key: postgres-crt.pem, postgres-ca.pem, postgres-key.key
-    replicas: 1
     route:
       enabled: true
   database:
@@ -144,7 +142,7 @@ spec:
   application:
     extraEnvs:
       secrets:
-         - name: `_<my_product_secrets>_`
+         - name: _<my_product_secrets>_
 ----
 ====
 +
@@ -156,7 +154,7 @@ spec:
   application:
     extraEnvs:
       secrets:
-         - name: `_<my_product_secrets>_`
+         - name: _<my_product_secrets>_
          - name: {my-product-database-secrets}
 ----
 ====

modules/customizing-techdocs/con-techdocs-config-cicd.adoc

@@ -1,3 +1,5 @@
+// ARCHIVED
+
 :_mod-docs-content-type: CONCEPT
 [id="con-techdocs-config-cicd_{context}"]
 = Configuring CI/CD to generate and publish TechDocs sites

modules/customizing-techdocs/con-techdocs-configure-storage.adoc

@@ -2,4 +2,4 @@
 [id="con-techdocs-configure-storage_{context}"]
 = Configuring storage for TechDocs files
 
-The TechDocs publisher stores generated files in local storage or in cloud storage, such as {odf-name}, Google GCS, AWS S3, or Azure Blob Storage.
+The TechDocs publisher stores generated files in local storage or in cloud storage, such as AWS S3 or {odf-name}.

modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc

@@ -1,3 +1,5 @@
+// ARCHIVED
+
 :_mod-docs-content-type: PROCEDURE
 [id="proc-techdocs-config-cicd-prep-repo_{context}"]
 = Preparing your repository for CI

modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc

@@ -25,7 +25,7 @@ These variables are then used in the TechDocs plugin configuration.
 +
 [source,yaml]
 ----
-apiVersion: objectbucket.io/v1alpha1
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
  name: <name>