Skip to content

Conversation

@sean-freeman
Copy link
Contributor

Where the new style has a chapter break to differentiate between IPI and UPI, some chapter titles are identical which will cause difficulties with SEO and end-user usage (finding the page, and not ignoring the page as a duplicate when there is different content on the page). In addition, VMware vSphere chapter titles do this inconsistently and with the long name even though the chapter menu uses the full name - so rebaseline to with IPI and with UPI across all vendor content.

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
Copy link
Contributor Author

@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.

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 11, 2024
@openshift-ci
Copy link

openshift-ci bot commented Oct 11, 2024

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.

@sean-freeman
Copy link
Contributor Author

@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.

@bscott-rh
Copy link
Contributor

The decision was made during the 4.16 reorgs to remove "with installer-provisioned infrastructure" and "with user-provisioned infrastructure" from the assembly titles to improve readability.

@bscott-rh
Copy link
Contributor

@sean-freeman my apologies, I closed this PR with a misunderstanding about what you were doing. The phrase "with installer-provisioned infrastructure" and "with user-provisioned infrastructure" is being removed from the topic map (left hand TOC) assembly names, but the headings inside the actual assemblies can still have that phrase for SEO reasons.

Note that the full phrase should be used, not the acronym "UPI" or "IPI".

@sean-freeman
Copy link
Contributor Author

@bscott-rh Prior to any changes to this PR, please confirm below.

Reference descriptions:

https://docs.openshift.com/container-platform/4.17/installing/overview/index.html#installation-overview_ocp-installation-overview

Results in below accurate terminology and phrasing:

  • Installing on TARGET with the Interactive Assisted Installer
  • Installing on TARGET with the Local Agent-based Installer
  • Installing on TARGET with the Automated (IPI) Installer
  • Installing on TARGET with the Full Control (UPI) Installer

Throughout documentation, short references used are:

  • Assisted install cluster
  • Agent-based install cluster
  • IPI cluster
  • UPI cluster

@sean-freeman
Copy link
Contributor Author

@bscott-rh Prior to any changes to this PR, please confirm below.

See prior message @bscott-rh , please confirm before PR is amended

@bscott-rh
Copy link
Contributor

@bscott-rh Prior to any changes to this PR, please confirm below.

See prior message @bscott-rh , please confirm before PR is amended

I understand that there are some places where UPI and IPI are still present in the documentation. I am OK with adding "with user-provisioned infrastructure" and "with installer-provisioned infrastructure" to the headings of the "Preparing to install a cluster" assemblies so that they are consistent with vSphere

@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 4, 2025
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 4, 2025
@openshift-merge-robot
Copy link

PR needs rebase.

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-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 7, 2025
@sean-freeman
Copy link
Contributor Author

Refer to #88715

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants