OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 #72364

dfitzmau · 2024-02-29T09:22:03Z

Version(s):
4.14-4.16

Link to docs preview:

SME has approved this change.
QE has approved this change.

Additional information:
Google doc customer feedback - AI
Google doc customer feedback - ABI
AI screenshots
Diagram ideas
Add diagram here also

Considerations:

For the term "CSI", would Oracle refer to the term as the Oracle CSI for File or Oracle CSI for File Storage?

openshift-ci-robot · 2024-02-29T09:22:10Z

@dfitzmau: This pull request references Jira Issue OCPBUGS-30076, which is invalid:

expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2024-02-29T09:27:26Z

🤖 Tue Apr 16 10:39:39 - Prow CI generated the docs preview:
https://72364--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

modules/creating-config-files-cluster-install-oci.adoc

installing/installing_oci/installing-oci-agent-based-installer.adoc

openshift-ci-robot · 2024-03-04T15:23:51Z

@dfitzmau: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

In response to this:

Version(s):
4.15 and 4.16

Issue:
OCPBUGS-30076

Link to docs preview:

Agent-based Installer on OCI

Assisted Installer on OCI

SME has approved this change.

QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

pawanpinjarkar · 2024-03-04T17:05:38Z

Please update the PR title to OCPBUGS-30076 and run /jira refresh

modules/running-cluster-oci-agent-based.adoc

openshift-ci-robot · 2024-03-05T11:11:28Z

@dfitzmau: This pull request references Jira Issue OCPBUGS-30076, which is invalid:

expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Version(s):
4.14-4.16

Issue:
OCPBUGS-30076

Link to docs preview:

Agent-based Installer on OCI

Assisted Installer on OCI

SME has approved this change.

QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

dfitzmau · 2024-03-05T11:11:50Z

/jira refresh

openshift-ci-robot · 2024-03-05T11:11:54Z

@dfitzmau: This pull request references Jira Issue OCPBUGS-30076, which is invalid:

expected the bug to target the "4.16.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

/jira refresh

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 openshift-eng/jira-lifecycle-plugin repository.

welcome/index.adoc

modules/creating-oci-infra-resources-services.adoc

welcome/index.adoc

modules/creating-oci-infra-resources-services.adoc

openshift-ci · 2024-04-16T10:41:00Z

@dfitzmau: 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/test-infra repository. I understand the commands that are listed here.

dfitzmau · 2024-04-16T13:22:35Z

/label merge-review-needed

jab-rh · 2024-04-16T17:00:53Z

@dfitzmau, PR mentions 4.14+, but the labels are 4.15 and 4.16. Can you confirm if this also belongs in 4.14? Thanks!

openshift-ci-robot · 2024-04-16T17:01:03Z

@dfitzmau: Jira Issue OCPBUGS-30076 is in an unrecognized state (Verified) and will not be moved to the MODIFIED state.

In response to this:

Version(s):
4.14-4.16

Issue:
OCPBUGS-30076
OCPBUGS-30322

Link to docs preview:

Agent-based Installer on OCI

Assisted Installer on OCI

Welcome page

SME has approved this change.

QE has approved this change.

Additional information:
Google doc customer feedback - AI
Google doc customer feedback - ABI
AI screenshots
Diagram ideas
Add diagram here also

Considerations:

For the term "CSI", would Oracle refer to the term as the Oracle CSI for File or Oracle CSI for File Storage?

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 openshift-eng/jira-lifecycle-plugin repository.

jab-rh · 2024-04-16T17:01:08Z

/cherry-pick enterprise-4.16

jab-rh · 2024-04-16T17:01:13Z

/cherry-pick enterprise-4.15

openshift-cherrypick-robot · 2024-04-16T17:01:55Z

@jab-rh: #72364 failed to apply on top of branch "enterprise-4.16":

Applying: OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
M	contributing_to_docs/term_glossary.adoc
M	welcome/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/index.adoc
Removing modules/verifying-cluster-install-oci.adoc
Auto-merging contributing_to_docs/term_glossary.adoc
CONFLICT (content): Merge conflict in contributing_to_docs/term_glossary.adoc
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick enterprise-4.16

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/test-infra repository.

openshift-cherrypick-robot · 2024-04-16T17:01:58Z

@jab-rh: #72364 failed to apply on top of branch "enterprise-4.15":

Applying: OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
M	contributing_to_docs/term_glossary.adoc
Falling back to patching base and 3-way merge...
Removing modules/verifying-cluster-install-oci.adoc
Auto-merging contributing_to_docs/term_glossary.adoc
CONFLICT (content): Merge conflict in contributing_to_docs/term_glossary.adoc
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick enterprise-4.15

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/test-infra repository.

jab-rh · 2024-04-16T17:21:49Z

@dfitzmau, looks like these don't merge cleanly; it should merge cleanly into 4.16 though.

@bergerhoffer, I wonder if this needs a revert?

dfitzmau · 2024-04-17T08:41:08Z

@dfitzmau, looks like these don't merge cleanly; it should merge cleanly into 4.16 though.

@bergerhoffer, I wonder if this needs a revert?

I think it's OK. The difference is among the term_glossary file entries where I ddi modify this file as part of this PR (PM request).

apinnick · 2024-04-17T09:25:07Z

installing/installing_oci/installing-oci-assisted-installer.adoc


 // The Assisted Installer and OCI overview
 include::modules/installing-oci-about-assisted-installer.adoc[leveloffset=+1]

 [role="_additional-resources"]
 .Additional resources

-* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2024[Assisted Installer for {product-title}]
+* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2024[{ai-full} for {product-title}]


I recommend removing the version (2024) so that the link does not have to be updated when the version changes in 2025.

Thanks. For a follow-up PR. I need to address merge conflicts on 4.14-4.16

apinnick · 2024-04-17T09:25:39Z

installing/installing_oci/installing-oci-assisted-installer.adoc

-* link:https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#ways[Ways to access Resource Manager]
-* link:https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Tasks/create-stack.htm#top[Creating a stack] in the Oracle documentation.
+* xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#using-the-assisted-installer_installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}]
+* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[{ai-full} for {product-title}]


This link needs to be updated.

Thanks. For a follow-up PR. I need to address merge conflicts on 4.14-4.16

apinnick · 2024-04-17T09:26:05Z

modules/complete-assisted-installer-oci.adoc

 +
 [IMPORTANT]
 ====
 Before, you can continue to the next steps, wait for each node to reach the `Ready` status.
 ====

-. Accept the default settings for the **Storage** and **Networking** steps. Click the **Next** button to go to the **Custom manifests** step. 
+. Accept the default settings for the *Storage* and *Networking* steps, and then Click *Next*.


typo: "Click"

Thanks. For a follow-up PR. I need to address merge conflicts on 4.14-4.16

apinnick · 2024-04-17T09:30:34Z

modules/creating-config-files-cluster-install-oci.adoc

 <4> The URL of the server where you want to upload the `rootfs` image.

 . Apply one of the following two updates to your `agent-config.yaml` configuration file:
 +
-* For a disconnected network:  After you run the command to generate a minimal ISO Image, the Agent-based installer saves the `rootfs` image into the `./<installation_directory>/boot-artifacts` directory on your local system. Upload `rootfs` to the location stated in the `bootArtifactsBaseURL` parameter in the `agent-config.yaml` configuration file. 
+* For a disconnected network:  After you run the command to generate a minimal ISO Image, the Agent-based installer saves the `rootfs` image into the `./<installation_directory>/boot-artifacts` directory on your local system. Use your preferred web server, such as any Hypertext Transfer Protocol daemon (`httpd`), to upload `rootfs` to the location stated in the `bootArtifactsBaseURL` parameter in the `agent-config.yaml` configuration file.


AFAIK, rootfs is only marked with backticks when it is used as a directory name. In this context, it is the name of the discovery image, so it should not be surrounded by backticks.

Thanks. For a follow-up PR. I need to address merge conflicts on 4.14-4.16

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Feb 29, 2024

openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 29, 2024

dfitzmau force-pushed the OCPBUGS-30076 branch from 9ee3aea to 97155f5 Compare February 29, 2024 09:41

dfitzmau commented Feb 29, 2024

View reviewed changes

modules/creating-config-files-cluster-install-oci.adoc Outdated Show resolved Hide resolved

dfitzmau force-pushed the OCPBUGS-30076 branch 2 times, most recently from 55b828d to 822713c Compare February 29, 2024 10:29

openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 29, 2024

dfitzmau force-pushed the OCPBUGS-30076 branch 2 times, most recently from 7f40f26 to 428da08 Compare February 29, 2024 10:33

dfitzmau commented Feb 29, 2024

View reviewed changes

installing/installing_oci/installing-oci-agent-based-installer.adoc Outdated Show resolved Hide resolved

dfitzmau force-pushed the OCPBUGS-30076 branch 3 times, most recently from 21b3e3d to 876010f Compare February 29, 2024 15:35

dfitzmau mentioned this pull request Mar 1, 2024

OCPBUGS-30092-oci: Port the OCI AI and ABI docs sets to 4.14 #72430

Merged

2 tasks

kalexand-rh changed the title ~~OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15~~ OCPBUGS#30076: Fixed minor bugs with OCI docs post 4.15 Mar 4, 2024

openshift-ci-robot removed jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Mar 4, 2024

pawanpinjarkar reviewed Mar 4, 2024

View reviewed changes

modules/running-cluster-oci-agent-based.adoc Outdated Show resolved Hide resolved

dfitzmau changed the title ~~OCPBUGS#30076: Fixed minor bugs with OCI docs post 4.15~~ OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 Mar 5, 2024

openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Mar 5, 2024

ocpdocs-vale-bot reviewed Apr 15, 2024

View reviewed changes

welcome/index.adoc Outdated Show resolved Hide resolved

dfitzmau force-pushed the OCPBUGS-30076 branch 2 times, most recently from b8b58c8 to e0c926b Compare April 16, 2024 10:25

ocpdocs-vale-bot reviewed Apr 16, 2024

View reviewed changes

modules/creating-oci-infra-resources-services.adoc Show resolved Hide resolved

ocpdocs-vale-bot reviewed Apr 16, 2024

View reviewed changes

welcome/index.adoc Outdated Show resolved Hide resolved

OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15

169340f

dfitzmau force-pushed the OCPBUGS-30076 branch from e0c926b to 169340f Compare April 16, 2024 10:31

ocpdocs-vale-bot reviewed Apr 16, 2024

View reviewed changes

modules/creating-oci-infra-resources-services.adoc Show resolved Hide resolved

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 16, 2024

jab-rh merged commit c2c25e6 into openshift:main Apr 16, 2024
3 checks passed

This was referenced Apr 17, 2024

[enterprise-4.16] OCPBUGS-30076: Fixed minor bugs with OCI docs #74758

Merged

[enterprise-4.15] OCPBUGS-30076: Fixed minor bugs with OCI docs #74759

Merged

[enterprise-4.14] OCPBUGS-30076: Fixed minor bugs with OCI docs #74760

Merged

apinnick reviewed Apr 17, 2024

View reviewed changes

This was referenced Apr 17, 2024

OCPBUGS-30076-av #74785

Merged

[Internal fix] glossary-terms-banner-main #74788

Merged

jab-rh removed the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 #72364

OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 #72364

dfitzmau commented Feb 29, 2024 •

edited

openshift-ci-robot commented Feb 29, 2024

ocpdocs-previewbot commented Feb 29, 2024 •

edited

openshift-ci-robot commented Mar 4, 2024

pawanpinjarkar commented Mar 4, 2024

openshift-ci-robot commented Mar 5, 2024

dfitzmau commented Mar 5, 2024

openshift-ci-robot commented Mar 5, 2024

openshift-ci bot commented Apr 16, 2024

dfitzmau commented Apr 16, 2024

jab-rh commented Apr 16, 2024

openshift-ci-robot commented Apr 16, 2024

jab-rh commented Apr 16, 2024

jab-rh commented Apr 16, 2024

openshift-cherrypick-robot commented Apr 16, 2024

openshift-cherrypick-robot commented Apr 16, 2024

jab-rh commented Apr 16, 2024

dfitzmau commented Apr 17, 2024

apinnick Apr 17, 2024

dfitzmau Apr 17, 2024

apinnick Apr 17, 2024

dfitzmau Apr 17, 2024

apinnick Apr 17, 2024

dfitzmau Apr 17, 2024

apinnick Apr 17, 2024

dfitzmau Apr 17, 2024

OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 #72364

OCPBUGS-30076: Fixed minor bugs with OCI docs post 4.15 #72364

Conversation

dfitzmau commented Feb 29, 2024 • edited

openshift-ci-robot commented Feb 29, 2024

ocpdocs-previewbot commented Feb 29, 2024 • edited

openshift-ci-robot commented Mar 4, 2024

pawanpinjarkar commented Mar 4, 2024

openshift-ci-robot commented Mar 5, 2024

dfitzmau commented Mar 5, 2024

openshift-ci-robot commented Mar 5, 2024

openshift-ci bot commented Apr 16, 2024

dfitzmau commented Apr 16, 2024

jab-rh commented Apr 16, 2024

openshift-ci-robot commented Apr 16, 2024

jab-rh commented Apr 16, 2024

jab-rh commented Apr 16, 2024

openshift-cherrypick-robot commented Apr 16, 2024

openshift-cherrypick-robot commented Apr 16, 2024

jab-rh commented Apr 16, 2024

dfitzmau commented Apr 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfitzmau commented Feb 29, 2024 •

edited

ocpdocs-previewbot commented Feb 29, 2024 •

edited