Adding snippets directory and all required symbolic links

[mjpytlak]

This PR is a follow on effort to enabling the use of text snippets. While PR 38393 updated the OpenShift documentation guidelines on how to use text snippets. This PR prepares the repository for their adoption.

Material changes.

1. technology-preview.adoc was moved from the top-level modules directory to a new top-level snippets directory.
2. All existing topics that include technology-preview.adoc have been updated to reference the new location. All files where tested locally and look good.
3. A symbolic link to the top-level snippets directory has been added to all remaining content directories, enabling the use of text snippets.

Doc preview of topics using technology-preview.adoc

• Driver Toolkit
• Special Resource Operator
• Using PTP hardware
• Using a virtual function in RDMA mode with a Mellanox NIC
• About the Kubernetes NMState Operator
• Deploying node health checks by using the Node Health Check Operator
• Converting a connected cluster to a disconnected cluster
• Deploying distributed units at scale in a disconnected environment
• Developing Golang functions
• Developing Node.js functions
• Developing Python functions
• Developing Quarkus functions
• Developing TypeScript functions
• About OpenShift Serverless Functions
• Using functions with Knative Eventing
• Getting started with functions
• Functions development reference guide
• Setting up OpenShift Serverless Functions
• Using kn CLI in offline mode
• CSI inline ephemeral volumes
• AWS Elastic File Service CSI Driver Operator
• Azure Disk CSI Driver Operator
• CSI automatic migration
• VMware vSphere CSI Driver Operator
• Importing RHEL Simple Content Access certificates with Insights Operator
• Configuring your cluster for OpenShift Virtualization
• Configuring automatic workload updates
• Hot-plugging virtual disks
• About the web terminal in the web console

[netlify]

✔️ Deploy Preview for osdocs ready!

🔨 Explore the source changes: 2e9b9d8

🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/61fadd697402d80007075a8e

😎 Browse the preview: https://deploy-preview-39854--osdocs.netlify.app

[mjpytlak]

@vikram-redhat Given the nature of this change, I am asking that you peer review this. I was thinking that it might be a good idea to begin adoption of text snippets with 4.10 to avoid any issues that might arise going as far back as 4.6. WDYT?

[vikram-redhat]

@mjpytlak this works for me.

Do you mean to say that you will merge this only for 4.10?

[mjpytlak]

Yes. I am proposing that we adopt text snippets as of 4.10. I was concerned about back porting and running into issues. Am I overthinking it?

[jboxman-rh]

@vikram-redhat, this doesn't count as a module in the CCS guidelines and is thus permissible? Or are we not concerned about that any longer. For all intents in purposes, this is just structured use of an include. And if we were just docs.openshift.com, I'd say go for it. But because we have other concerns, I wonder about this if adopted at scale.

[mjpytlak]

Good morning, @jboxman-rh. If you have not had a chance, PTAL at #38393. I had updated our guidelines around usage.

[vikram-redhat]

@jboxman I don't think there are any issues around using text snippets, in any platform. @kalexand-rh can you confirm if Jupiter has any restrictions on this?

@mjpytlak if we do merge it, I think we should backport it to avoid conflicts.

[jboxman]

@vikram-redhat, well, a snippet is just an include. So this all formalizes what to Asciidoctor is just a thing, that it does. But it isn't necessarily a thing every 'platform' will do, so I don't want to keep digging if it presents an issue.

[kalexand-rh]

@vikram-redhat, Jupiter doesn't care if you use snippets. It's just another include. I don't think they've decided if they're going to store it as a separate node, but they've confirmed that snippets will be transformed correctly during the ingest phase.

[vikram-redhat]

well, a snippet is just an include. So this all formalizes what to Asciidoctor is just a thing, that it does. But it isn't necessarily a thing every 'platform' will do, so I don't want to keep digging if it presents an issue.

You are right. We know how it can be with other "platforms" :).

[mjpytlak]

@kalexand-rh Rebased and resolved references to modules/technology-preview.adoc Based on Vikram's comments, I believe he was suggesting this be back ported, but he did not say how far back. I am presuming he meant all the way back to 4.6.

[kalexand-rh]

@mjpytlak, moving this back to 4.6 will be best.