doc: create markdown doc for supported variations

[imprateeksh]

Description

Issue Reference - #15761

Release required?

• No release
• Patch release (x.x.X)
• Minor release (x.X.x)
• Major release (X.x.x)

Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

• If relevant, a test for the change is included or updated with this PR.
• If relevant, documentation for the change is included or updated with this PR.

For mergers

• Use a conventional commit message to set the release level. Follow the guidelines.
• Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
• Use the Squash and merge option.

[ocofaigh]

The folder needs to be named reference-architectures

[ocofaigh]

@imprateeksh A few things to fix please

[ocofaigh]

I have been including all the variations in here, so suggest to also add:

  - title: "Landing zone for containerized applications with OpenShift (Standard - Integrated setup with configurable services)"
    url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-ocp-fully-configurable"
    description: "A deployable architecture that delivers a scalable and flexible Red Hat OpenShift environment on IBM Cloud Virtual Private Cloud (VPC), with seamless integration to security, observability, and other foundational services for containerized workloads."
  - title: "Landing zone for containerized applications with OpenShift (QuickStart - Basic and simple)"
    url: "https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-ocp-ra-qs"
    description: "A deployable architecture solution that is based on the IBM Cloud for Financial Services reference architecture. This solution delivers a scalable and flexible Red Hat OpenShift environment on IBM Cloud Virtual Private Cloud (VPC), with seamless integration to security, observability, and other foundational services for containerized workloads."
  - title: "Landing zone for containerized applications with OpenShift (Standard - Financial Services edition)"
    url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-ocp-ra"
    description: "A deployable architecture that creates a secure and compliant Red Hat OpenShift Container Platform workload clusters on a Virtual Private Cloud (VPC) network based on the IBM Cloud for Financial Services reference architecture."
  - title: "Landing zone for containerized applications with OpenShift (QuickStart - Financial Services edition)"
    url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-roks-ra-qs"
    description: "An introductory, non-certified deployment aligned with the Financial Services Cloud VPCs topology. Not suitable for production workloads or upgrade paths."

[imprateeksh]

So all these will be part of related links? And does Quickstart variation should also have these links under related_links?

Also, I made change to name for fully configurable as:
Landing zone for containerized applications with OpenShift - Standard - Integrated setup with configurable services
but above it is mentioned like:
"Landing zone for containerized applications with OpenShift (Standard - Integrated setup with configurable services)"

Similarly for Quick start variation, I am using name as :
Landing zone for containerized applications with OpenShift - QuickStart variation
But above we have two titles:
a) "Landing zone for containerized applications with OpenShift (QuickStart - Basic and simple)"
b) "Landing zone for containerized applications with OpenShift (QuickStart - Financial Services edition)"

What should be done here @ocofaigh ?

[ocofaigh]

That is what we have everywhere else currently yes - We can double check with the docs contact to confirm, but right now lets be consistent with the other reference architectures.

[imprateeksh]

I have added this in both variations for now. I am not sure about what the correct links should be.

e.g Last one points to VPC (LZ) quick start page -

url: "https://cloud.ibm.com/docs/deployable-reference-architectures?topic=deployable-reference-architectures-roks-ra-qs"

[ocofaigh]

@imprateeksh Please work with Pranjali to review this. Once content team approve, I'll merge

[ocofaigh]

@imprateeksh version is final - it must be updated in the docs here to 3.58.1 please

[imprateeksh]

Addressed all review comments. One point was suggested by @pranjali-mundra about having same columns as in other documents.
In this case the last column would be Alternative choice, which is done at one place in fully configurable.
Is this fine or do we need to make more changes here?
@ocofaigh @maheshwarishikha

[ocofaigh]

@imprateeksh Sorry we had to create patch release 3.58.2 - please update

[imprateeksh]

/run pipeline

addressed

[terraform-ibm-modules-ops]

🎉 This PR is included in version 3.59.0 🎉

The release is available on:

• GitHub release
• v3.59.0

Your semantic-release bot 📦🚀