Adding snippets folder and all required symbolic links

adellape · Feb 2, 2022 · 2e9b9d8 · 2e9b9d8
1 parent d1672c0
commit 2e9b9d8
Show file tree

Hide file tree

Showing 116 changed files with 117 additions and 46 deletions.
diff --git a/adding_service_cluster/snippets b/adding_service_cluster/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/administering_a_cluster/snippets b/administering_a_cluster/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/applications/snippets b/applications/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/architecture/snippets b/architecture/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/authentication/snippets b/authentication/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/...cation_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc b/...cation_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
@@ -11,7 +11,7 @@ You back up applications by creating a xref:../../../backup_and_restore/applicat
 The `Backup` CR creates backup files for Kubernetes resources and internal images, on S3 object storage, and snapshots for persistent volumes (PVs), if the cloud provider uses a native snapshot API or the xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI)] to create snapshots, such as OpenShift Container Storage 4. For more information, see xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots].
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 If your cloud provider has a native snapshot API or supports xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#oadp-backing-up-pvs-csi_backing-up-applications[Container Storage Interface (CSI) snapshots], the `Backup` CR backs up persistent volumes by creating snapshots. For more information, see the xref:../../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots-overview_persistent-storage-csi-snapshots[Overview of CSI volume snapshots] in the {product-title} documentation.
 

diff --git a/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/snippets b/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/snippets
@@ -0,0 +1 @@
+../../../snippets/
diff --git a/...nd_restore/application_backup_and_restore/installing/about-installing-oadp.adoc b/...nd_restore/application_backup_and_restore/installing/about-installing-oadp.adoc
@@ -17,7 +17,7 @@ To back up Kubernetes resources and internal images, you must have object storag
 * S3-compatible object storage, such as Noobaa or Minio
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 You can back up persistent volumes (PVs) by using snapshots or Restic.
 

diff --git a/..._and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/..._and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
@@ -12,7 +12,7 @@ toc::[]
 You install the Openshift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator, configuring AWS for Velero, and then installing the Data Protection Application.
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
 

diff --git a/...nd_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/...nd_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
@@ -12,7 +12,7 @@ toc::[]
 You install the Openshift API for Data Protection (OADP) with Microsoft Azure by installing the OADP Operator, configuring Azure for Velero, and then installing the Data Protection Application.
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
 

diff --git a/..._and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/..._and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
@@ -12,7 +12,7 @@ toc::[]
 You install the Openshift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator, configuring GCP for Velero, and then installing the Data Protection Application.
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 To install the OADP Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
 

diff --git a/..._and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/..._and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
@@ -14,7 +14,7 @@ You install the Openshift API for Data Protection (OADP) with Multicloud Object
 MCG is a component of OpenShift Container Storage (OCS). You configure MCG as a backup location in the `DataProtectionApplication` custom resource (CR).
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 If your cloud provider has a native snapshot API, configure a snapshot location. If your cloud provider does not support snapshots or if your storage is NFS, you can create backups with Restic.
 

diff --git a/..._and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/..._and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
@@ -14,7 +14,7 @@ You install the Openshift API for Data Protection (OADP) with OpenShift Containe
 You can configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] or any S3-compatible object storage as a backup location in the `DataProtectionApplication` custom resource (CR).
 
 :FeatureName: The `CloudStorage` API for S3 storage
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 If the cloud provider has a native snapshot API, you can configure cloud storage as a snapshot location in the `DataProtectionApplication` CR. You do not need to specify a snapshot location for Restic or Container Storage Interface (CSI) snapshots.
 

diff --git a/backup_and_restore/application_backup_and_restore/installing/snippets b/backup_and_restore/application_backup_and_restore/installing/snippets
@@ -0,0 +1 @@
+../../../snippets/
diff --git a/backup_and_restore/application_backup_and_restore/snippets b/backup_and_restore/application_backup_and_restore/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/backup_and_restore/index.adoc b/backup_and_restore/index.adoc
@@ -51,7 +51,7 @@ As a cluster administrator, you can back up and restore applications running on
 // ** S3-compatible object storage, such as Noobaa or Minio
 //
 // :FeatureName: The `CloudStorage` API for S3 storage
-// include::modules/technology-preview.adoc[]
+// include::snippets/technology-preview.adoc[]
 //
 // * To back up PVs with snapshots, you must have cloud storage that has a native snapshot API or supports Container Storage Interface (CSI) snapshots, such as the following providers:
 //

diff --git a/backup_and_restore/snippets b/backup_and_restore/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/cicd/snippets b/cicd/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/cli_reference/snippets b/cli_reference/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/cloud_infrastructure_access/snippets b/cloud_infrastructure_access/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc
@@ -658,7 +658,7 @@ You must get approval from the Engineering, QE, and Docs teams before embedding
 == Indicating Technology Preview features
 
 To indicate that a feature is in Technology Preview, include the
-`modules/technology-preview.adoc` file in the feature's assembly to keep the
+`snippets/technology-preview.adoc` file in the feature's assembly to keep the
 supportability wording consistent across Technology Preview features and provide a value for the :FeatureName: variable before you include this module.
 
 See link:https://github.com/openshift/openshift-docs/pull/13878/files#diff-615ba1bf3b09d11a9c2604b775aa32f2[an example] of how this is applied.

diff --git a/contributing_to_docs/snippets b/contributing_to_docs/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/getting_started/snippets b/getting_started/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/hardware_enablement/psap-driver-toolkit.adoc b/hardware_enablement/psap-driver-toolkit.adoc
@@ -9,7 +9,7 @@ toc::[]
 Learn about the Driver Toolkit and how you can use it as a base image for driver containers for enabling special software and hardware devices on Kubernetes.
 
 :FeatureName: The Driver Toolkit
-include::modules/technology-preview.adoc[leveloffset=+0]
+include::snippets/technology-preview.adoc[leveloffset=+0]
 
 include::modules/psap-driver-toolkit.adoc[leveloffset=+1]
 

diff --git a/hardware_enablement/psap-special-resource-operator.adoc b/hardware_enablement/psap-special-resource-operator.adoc
@@ -10,7 +10,7 @@ Learn about the Special Resource Operator (SRO) and how you can use it to build
 
 
 :FeatureName: The Special Resource Operator
-include::modules/technology-preview.adoc[leveloffset=+0]
+include::snippets/technology-preview.adoc[leveloffset=+0]
 
 include::modules/psap-special-resource-operator.adoc[leveloffset=+1]
 

diff --git a/hardware_enablement/snippets b/hardware_enablement/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/identity_providers/snippets b/identity_providers/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/installing/snippets b/installing/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/jaeger/snippets b/jaeger/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/logging/snippets b/logging/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/machine_management/snippets b/machine_management/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/metering/snippets b/metering/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/metrics/snippets b/metrics/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/migrating_from_ocp_3_to_4/snippets b/migrating_from_ocp_3_to_4/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/migration_toolkit_for_containers/snippets b/migration_toolkit_for_containers/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/mod_docs_guide/snippets b/mod_docs_guide/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/monitoring/application-monitoring.adoc b/monitoring/application-monitoring.adoc
@@ -9,7 +9,7 @@ toc::[]
 You can configure custom metrics scraping for your applications. For that, you deploy the Prometheus Operator and a custom Prometheus instance and Alertmanager instance in the namespace where your application is.
 
 :FeatureName: Application monitoring
-include::modules/technology-preview.adoc[leveloffset=+0]
+include::snippets/technology-preview.adoc[leveloffset=+0]
 
 include::modules/monitoring-configuring-cluster-for-application-monitoring.adoc[leveloffset=+1]
 include::modules/monitoring-configuring-monitoring-for-an-application.adoc[leveloffset=+1]

diff --git a/monitoring/configuring-hpa-for-an-application.adoc b/monitoring/configuring-hpa-for-an-application.adoc
@@ -9,7 +9,7 @@ toc::[]
 You can configure Horizontal Pod Autoscaling (HPA) for an application that exports metrics.
 
 :FeatureName: Horizontal Pod Autoscaling for an application
-include::modules/technology-preview.adoc[leveloffset=+0]
+include::snippets/technology-preview.adoc[leveloffset=+0]
 
 == Prerequisites
 

diff --git a/monitoring/enabling-alert-routing-for-user-defined-projects.adoc b/monitoring/enabling-alert-routing-for-user-defined-projects.adoc
@@ -6,8 +6,8 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-:FeatureName: Alert routing for user-defined projects 
-include::modules/technology-preview.adoc[leveloffset=+1]
+:FeatureName: Alert routing for user-defined projects
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 [role="_abstract"]
 In {product-title} {product-version}, a cluster administrator can enable alert routing for user-defined projects.
@@ -21,7 +21,7 @@ include::modules/monitoring-enabling-alert-routing-for-user-defined-projects.ado
 // Granting users permission to configure alert routing for user-defined projects
 include::modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
 
-// Disabling alert routing for user-defined projects 
+// Disabling alert routing for user-defined projects
 include::modules/monitoring-disabling-alert-routing-for-user-defined-projects.adoc[leveloffset=+1]
 
 .Additional resources
@@ -32,5 +32,3 @@ include::modules/monitoring-disabling-alert-routing-for-user-defined-projects.ad
 == Next steps
 
 * xref:../monitoring/managing-alerts.adoc#creating-alert-routing-for-user-defined-projects_managing-alerts[Creating alert routing for user defined projects]
-
-
diff --git a/monitoring/snippets b/monitoring/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/networking/hardware_networks/snippets b/networking/hardware_networks/snippets
@@ -0,0 +1 @@
+../../snippets
diff --git a/networking/hardware_networks/using-dpdk-and-rdma.adoc b/networking/hardware_networks/using-dpdk-and-rdma.adoc
@@ -19,7 +19,7 @@ include::modules/nw-sriov-dpdk-example-mellanox.adoc[leveloffset=+1]
 == Using a virtual function in RDMA mode with a Mellanox NIC
 
 :FeatureName: RDMA over Converged Ethernet (RoCE)
-include::modules/technology-preview.adoc[leveloffset=+0]
+include::snippets/technology-preview.adoc[leveloffset=+0]
 
 // Use a tag to skip header and include content only
 include::modules/nw-sriov-rdma-example-mellanox.adoc[tag=content]

diff --git a/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc b/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc
@@ -8,7 +8,7 @@ toc::[]
 
 The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster's nodes with NMState. The Kubernetes NMState Operator provides users with functionality to configure various network interface types, DNS, and routing on cluster nodes. Additionally, the daemons on the cluster nodes periodically report on the state of each node's network interfaces to the API server.
 
-include::modules/technology-preview.adoc[]
+include::snippets/technology-preview.adoc[]
 
 Before you can use NMState with {product-title}, you must install the Kubernetes NMState Operator.
 

diff --git a/networking/k8s_nmstate/snippets b/networking/k8s_nmstate/snippets
@@ -0,0 +1 @@
+../../snippets
diff --git a/networking/snippets b/networking/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/networking/using-ptp.adoc b/networking/using-ptp.adoc
@@ -7,7 +7,7 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 :FeatureName: Precision Time Protocol (PTP) hardware
-include::modules/technology-preview.adoc[leveloffset=+1]
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 [id="about-using-ptp-hardware"]
 == About PTP hardware

diff --git a/nodes/nodes/eco-node-health-check-operator.adoc b/nodes/nodes/eco-node-health-check-operator.adoc
@@ -14,7 +14,7 @@ xref:../../nodes/nodes/eco-poison-pill-operator.adoc#poison-pill-operator-remedi
 
 :FeatureName: Node Health Check Operator
 
-include::modules/technology-preview.adoc[leveloffset=+1]
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 include::modules/eco-node-health-check-operator-about.adoc[leveloffset=+1]
 

diff --git a/nodes/nodes/snippets b/nodes/nodes/snippets
@@ -0,0 +1 @@
+../../snippets
diff --git a/nodes/snippets b/nodes/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/openshift_images/snippets b/openshift_images/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/operators/snippets b/operators/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_architecture/snippets b/osd_architecture/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_cluster_create/snippets b/osd_cluster_create/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_notifications/snippets b/osd_notifications/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_planning/snippets b/osd_planning/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_policy/snippets b/osd_policy/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_private_connections/snippets b/osd_private_connections/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/osd_quickstart/snippets b/osd_quickstart/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/planning/snippets b/planning/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/post_installation_configuration/connected-to-disconnected.adoc b/post_installation_configuration/connected-to-disconnected.adoc
@@ -15,7 +15,7 @@ A disconnected cluster, also known as a restricted cluster, does not have an act
 This topic describes the general process for converting an existing, connected cluster into a disconnected cluster.    
 
 :FeatureName: The process for converting a cluster from connected to disconnected 
-include::modules/technology-preview.adoc[leveloffset=+1]
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
 

diff --git a/post_installation_configuration/snippets b/post_installation_configuration/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/registry/snippets b/registry/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/release_notes/snippets b/release_notes/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_architecture/snippets b/rosa_architecture/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_cli/snippets b/rosa_cli/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_getting_started/snippets b/rosa_getting_started/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_getting_started_sts/snippets b/rosa_getting_started_sts/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_planning/snippets b/rosa_planning/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_policy/snippets b/rosa_policy/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/rosa_support/snippets b/rosa_support/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/router/snippets b/router/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/sandboxed_containers/snippets b/sandboxed_containers/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/scalability_and_performance/snippets b/scalability_and_performance/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/scalability_and_performance/ztp-deploying-disconnected.adoc b/scalability_and_performance/ztp-deploying-disconnected.adoc
@@ -10,7 +10,7 @@ toc::[]
 Use zero touch provisioning (ZTP) to provision distributed units at new edge sites in a disconnected environment. The workflow starts when the site is connected to the network and ends with the CNF workload deployed and running on the site nodes.
 
 :FeatureName: ZTP for RAN deployments
-include::modules/technology-preview.adoc[leveloffset=+1]
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 include::modules/ztp-provisioning-edge-sites-at-scale.adoc[leveloffset=+1]
 

diff --git a/security/snippets b/security/snippets
@@ -0,0 +1 @@
+../snippets
diff --git a/serverless/develop/serverless-applications.adoc b/serverless/develop/serverless-applications.adoc
@@ -69,7 +69,7 @@ include::modules/serverless-https-redirect-service.adoc[leveloffset=+1]
 == Using kn CLI in offline mode
 
 :FeatureName: The offline mode of the kn CLI
-include::modules/technology-preview.adoc[leveloffset=+1]
+include::snippets/technology-preview.adoc[leveloffset=+1]
 
 include::modules/kn-service-offline-about.adoc[leveloffset=+2]
 include::modules/kn-service-offline-create.adoc[leveloffset=+2]
diff --git a/serverless/discover/serverless-functions-about.adoc b/serverless/discover/serverless-functions-about.adoc
@@ -8,7 +8,7 @@ include::modules/serverless-document-attributes.adoc[]
 toc::[]
 
 :FeatureName: {FunctionsProductName}
-include::modules/technology-preview.adoc[leveloffset=+2]
+include::snippets/technology-preview.adoc[leveloffset=+2]
 
 {FunctionsProductName} enables developers to create and deploy stateless, event-driven functions as a Knative service on {product-title}.
 

diff --git a/serverless/functions/serverless-developing-go-functions.adoc b/serverless/functions/serverless-developing-go-functions.adoc
@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 :FeatureName: {FunctionsProductName}
-include::modules/technology-preview.adoc[leveloffset=+2]
+include::snippets/technology-preview.adoc[leveloffset=+2]
 
 After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Golang function project], you can modify the template files provided to add business logic to your function.
 

diff --git a/serverless/functions/serverless-developing-nodejs-functions.adoc b/serverless/functions/serverless-developing-nodejs-functions.adoc
@@ -8,7 +8,7 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 :FeatureName: {FunctionsProductName}
-include::modules/technology-preview.adoc[leveloffset=+2]
+include::snippets/technology-preview.adoc[leveloffset=+2]
 
 After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a Node.js function project], you can modify the template files provided to add business logic to your function.