openshift-docs
openshift-docs copied to clipboard
openshift
bugfix: descriptive titles accuracy
Address GH Issue #81621 for documentation titles with unclear descriptions. The commit is nonintrusive and does not alter the structure of any topic object; split commit from rejected PR #83244.
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
The following renames occured for fixing bad descriptions
Installing on bare metal
>>>
Installing on bare metal with the UPI Installer
Deploying installer-provisioned clusters on bare metal
>>>
Installing on bare metal with the IPI Installer
The following renames occured for consistency
Installing on-premise with Assisted Installer
>>>
Installing on-premise with the Assisted Installer
Installing an on-premise cluster with the Agent-based Installer
>>>
Installing on-premise with the Agent-based Installer
@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.
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](https://avatars.githubusercontent.com/in/91280?v=4 "Published by a pub.dev verified publisher"){kind=small}
@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.
🤖 Tue Oct 29 15:37:23 - Prow CI generated the docs preview: https://83333--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt
As requested, amendment is now "Deploying installer-provisioned clusters on bare metal" > "Installing on bare metal as IPI cluster"
In addition, it should be recorded somewhere for posterity.....
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: 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.
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
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.
The branch/enterprise-4.19 label has been added to this PR.
This is because your PR targets the main branch and is labeled for enterprise-4.18. And any PR going into main must also target the latest version branch (enterprise-4.19).
If the update in your PR does NOT apply to version 4.19 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.
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
@sean-freeman: The lifecycle/frozen label cannot be applied to Pull Requests.
In response to this:
/lifecycle frozen
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.