Skip to content

bugfix: descriptive titles accuracy #83333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

bugfix: descriptive titles accuracy #83333

wants to merge 1 commit into from

Conversation

@sean-freeman
Copy link
Contributor

@sean-freeman sean-freeman commented Oct 10, 2024 •
edited by bscott-rh
Loading

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

@sean-freeman
Copy link
Contributor Author

sean-freeman commented Oct 10, 2024

@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/S Denotes a PR that changes 10-29 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 10, 2024
@openshift-ci
Copy link

openshift-ci bot commented Oct 10, 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

sean-freeman commented Oct 21, 2024

@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
bscott-rh requested changes Oct 24, 2024
View reviewed changes
Copy link
Contributor

@bscott-rh bscott-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

installing/overview/cluster-capabilities.adoc Outdated
[role="_additional-resources"]
.Additional resources
* xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal]
* xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Installing on bare metal with the IPI Installer]
Copy link
Contributor

@bscott-rh bscott-rh Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original phrasing is more accurate

Copy link
Contributor Author

@sean-freeman sean-freeman Oct 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original phrasing is, however, inconsistent with all other titles that begin with Installing...

Copy link
Contributor Author

@sean-freeman sean-freeman Oct 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 24, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Oct 24, 2024 •
edited
Loading

🤖 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

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 24, 2024
View reviewed changes
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 24, 2024
View reviewed changes
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 24, 2024
View reviewed changes
@sean-freeman
Copy link
Contributor Author

sean-freeman commented Oct 29, 2024 •
edited
Loading

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

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 29, 2024
View reviewed changes
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 29, 2024
View reviewed changes
ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Oct 29, 2024
View reviewed changes
@openshift-ci
Copy link

openshift-ci bot commented Oct 29, 2024

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

@openshift-bot
Copy link

openshift-bot commented Jan 28, 2025

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 Jan 28, 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 Jan 28, 2025
@openshift-merge-robot
Copy link

openshift-merge-robot commented Jan 28, 2025

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.

@bergerhoffer
Copy link
Contributor

bergerhoffer commented Feb 24, 2025

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.

@openshift-bot
Copy link

openshift-bot commented Mar 27, 2025

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

sean-freeman commented Mar 27, 2025

/lifecycle frozen

@openshift-ci
Copy link

openshift-ci bot commented Mar 27, 2025

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

@sean-freeman
Copy link
Contributor Author

sean-freeman commented Apr 3, 2025

Refer to #88715

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

Reviewers

@bscott-rh bscott-rh bscott-rh requested changes

+1 more reviewer

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

branch/enterprise-4.17 branch/enterprise-4.18 branch/enterprise-4.19 lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@sean-freeman @ocpdocs-previewbot @openshift-bot @openshift-merge-robot @bergerhoffer @bscott-rh @ocpdocs-vale-bot