openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

structure: subdir ibmcloud ipi

Open sean-freeman opened this issue 1 year ago • 7 comments

Create sub-directory for IPI under IBM Cloud infrastructure platform vendor-specific documentation. This includes re-writing of all filename references within the repository and fixes to chapter titles/introductions to follow sentence format used elsewhere (i.e. AWS, AZ).

Output structure after subdir creation

  • Installing on IBM Cloud
    • Installer-provisioned infrastructure
      • Installing a cluster with customizations on IBM Cloud
      • Installing a cluster with network customizations on IBM Cloud
      • Installing a cluster with an existing VPC network on IBM Cloud
      • Installing a private cluster with an existing VPC network on IBM Cloud
      • Installing a cluster with a restricted VPC network on IBM Cloud

Version(s): 4.17, do not cherry pick as this file is likely to have changed between each version

Issue:

  • None (GH or Jira), this is community author contribution

QE review:

  • [ ] QE has approved this change.

Additional information:

  • n/a

sean-freeman avatar Oct 11 '24 19:10 sean-freeman

@kalexand-rh @bscott-rh @sheriff-rh Mentioning you all, as GH Issue template requests @openshift/team-documentation [which does not work] is mentioned after PR is raised.

sean-freeman avatar Oct 11 '24 19:10 sean-freeman

Hi @sean-freeman. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

openshift-ci[bot] avatar Oct 11 '24 19:10 openshift-ci[bot]

@kalexand-rh @bscott-rh @sheriff-rh Can you please review this PR? I would prefer to avoid merge conflicts which is more likely the longer this PR is open.

sean-freeman avatar Oct 21 '24 15:10 sean-freeman

I am holding this PR until I can discuss with the docs program manager. This PR has the potential to affect the publishing system for the new docs site due to the topic map changes.

/ok-to-test

bscott-rh avatar Oct 24 '24 19:10 bscott-rh

🤖 Thu Oct 24 20:04:05 - Prow CI generated the docs preview: https://83420--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-previewbot avatar Oct 24 '24 20:10 ocpdocs-previewbot

@sean-freeman: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-portal 71cb40037cee58363666f1e3640b15a0e819a83e link true /test validate-portal

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.

openshift-ci[bot] avatar Oct 24 '24 20:10 openshift-ci[bot]

@bscott-rh If changes are made to GCP structure (as described in another PR) in the new docs site, I would request this PR to be accepted also. Otherwise this conflicts with vendor neutrality

sean-freeman avatar Oct 24 '24 20:10 sean-freeman

@sean-freeman after discussing with @kalexand-rh we are rejecting this PR. Aside from the additional work it generates on the customer portal, the change is not justified because there is no corresponding UPI installation process. Therefore this is simply adding an extra layer of directories, complicating the left hand TOC.

bscott-rh avatar Nov 05 '24 20:11 bscott-rh