OSSM-8759 Pre-migration checklist for product docs

[gwynnemonahan]

OSSM 3.0 GA

Per Kathryn, used this as an example: https://docs.openshift.com/container-platform/4.17/migrating_from_ocp_3_to_4/premigration-checklists-3-4.html

Merge to: https://github.com/openshift/openshift-docs/tree/service-mesh-docs-main
Cherry pick to: https://github.com/openshift/openshift-docs/tree/service-mesh-docs-3.0

This PR is part of the standalone doc set for the OpenShift Service Mesh project.

Version(s):
OSSM 3.0 GA

OSSM 3.0 is moving to stand alone format so it will not be cherry-picked back to OCP core branches.

Issue:
https://issues.redhat.com/browse/OSSM-8759

Link to docs preview:
https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/checklists/ossm-migrating-network-policies-assembly.html
https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/checklists/ossm-migrating-premigration-checklists-assembly.html
https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/ossm-migrating-from-service-mesh-2-to-3-assembly.html

QE review:

• QE has approved this change.

Additional information:
IA PR for reference: #86912

[ocpdocs-previewbot]

🤖 Tue Mar 04 20:58:59 - Prow CI generated the docs preview:

https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/checklists/ossm-migrating-network-policies-assembly.html
https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/checklists/ossm-migrating-premigration-checklists-assembly.html
https://88198--ocpdocs-pr.netlify.app/openshift-service-mesh/latest/migrating/ossm-migrating-from-service-mesh-2-to-3-assembly.html

[nrfox]

Looks great overall! Just a few comments.

[FilipB]

Left a few comments

[FilipB]

@gwynnemonahan should we wait for missing links before approval or there will be another PR for adding links so it will be reviewed again there?

[gwynnemonahan]

@gwynnemonahan should we wait for missing links before approval or there will be another PR for adding links so it will be reviewed again there?

Hey @FilipB ,

Thanks for asking!

At the moment, I'm OK with waiting on this PR. It is looking like this will be the last, or one of the last PRs for Migration content to be merged so that the links can be added and checked that they work. There's also a change I need to make regarding the checker script.

[FilipB]

A few suggestions. Also we are still waiting for the links to be working before final approval.

[nrfox]

Couple formatting nits but otherwise LGTM

[michaelryanpeter]

I think that this content is in between content types. As a result, it has an unfinished feeling to it.

I think that as a rule of thumb, a checklist should be part of an assembly and link/xref out to the relevant procedures. And if links are not necessary and the content is intended for reuse, the checklist should be a reference module.

For most of my comments, a slight refactoring of content to align that suggestion will solve the issues. But a few of these modules are procedure or reference modules (and not checklists), and should be used in that way.

That said, I don't it will take too much to get this into shape. Please reach out if you have questions. I am happy to hop on a call to discuss.

[gwynnemonahan]

Rebased night 03/03/2025.

[gwynnemonahan]

Rebased morning 03/04/2025

[gwynnemonahan]

/label merge-review-needed

[skrthomas]

Just a couple comments about minimalism here before merging.

[openshift-ci]

@gwynnemonahan: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[skrthomas]

I won't hold merge on this, but after some discussion with the reviewers of this PR and @kalexand-rh, we've decided that the best course of action is a re-evaluation of some of the minimalism and modularization comments in the review that weren't addressed, or were ACK'd pending user feedback. A Jira task has been created to ensure that this content is re-evaluated for consistency with these standards because, as is, this checklist does not align: https://issues.redhat.com/browse/OSSM-9002

[skrthomas]

/cherrypick service-mesh-docs-3.0

[openshift-cherrypick-robot]

@skrthomas: new pull request created: #89563

In response to this:

/cherrypick service-mesh-docs-3.0

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.