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

OSDOCS-11699: Made structural changes per OSDOCS-11699.

Open johnwilkins opened this issue 1 year ago • 11 comments

Consolidates the IPI and UPI docs under the installing_bare_metal directory with upi and ipi subdirectories. There are no other edits or improvements per the JIRA. However, there are updates to the xrefs that reference these docs, making the number of files changed rather extensive.

Version(s): 4.18

Issue: https://issues.redhat.com/browse/OSDOCS-11699

Link to docs preview: https://83982--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_bare_metal/preparing-to-install-on-bare-metal

QE review:

  • [ ] QE has approved this change.

Additional information:

johnwilkins avatar Oct 22 '24 23:10 johnwilkins

@johnwilkins: This pull request references OSDOCS-11699 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "4.18.0" version, but no target version was set.

In response to this:

Consolidates the IPI and UPI docs under the installing_bare_metal directory with upi and ipi subdirectories. There are no other edits or improvements per the JIRA.

Version(s): 4.18

Issue: https://issues.redhat.com/browse/OSDOCS-11699

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.

openshift-ci-robot avatar Oct 22 '24 23:10 openshift-ci-robot

🤖 Mon Oct 28 20:20:57 - Prow CI generated the docs preview: https://83982--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-previewbot avatar Oct 23 '24 00:10 ocpdocs-previewbot

@johnwilkins: This pull request references OSDOCS-11699 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "4.18.0" version, but no target version was set.

In response to this:

Consolidates the IPI and UPI docs under the installing_bare_metal directory with upi and ipi subdirectories. There are no other edits or improvements per the JIRA.

Version(s): 4.18

Issue: https://issues.redhat.com/browse/OSDOCS-11699

Link to docs preview: https://83982--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_bare_metal/preparing-to-install-on-bare-metal

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.

openshift-ci-robot avatar Oct 23 '24 00:10 openshift-ci-robot

@johnwilkins: This pull request references OSDOCS-11699 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "4.18.0" version, but no target version was set.

In response to this:

Consolidates the IPI and UPI docs under the installing_bare_metal directory with upi and ipi subdirectories. There are no other edits or improvements per the JIRA. However, there are updates to the xrefs that reference these docs, making the number of files changed rather extensive.

Version(s): 4.18

Issue: https://issues.redhat.com/browse/OSDOCS-11699

Link to docs preview: https://83982--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_bare_metal/preparing-to-install-on-bare-metal

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.

openshift-ci-robot avatar Oct 23 '24 00:10 openshift-ci-robot

/label peer-review-needed

johnwilkins avatar Oct 23 '24 16:10 johnwilkins

/label peer-review-in-progress /remove-label peer-review-needed /assign GroceryBoyJr

GroceryBoyJr avatar Oct 24 '24 19:10 GroceryBoyJr

@johnwilkins It's going to take me to tomorrow to turn this around, is that OK?

GroceryBoyJr avatar Oct 24 '24 19:10 GroceryBoyJr

@GroceryBoyJr sure. That's fine. I know it's big. I had no idea how many links there were to the bare metal install docs when I started. Sorry for the large size.

johnwilkins avatar Oct 25 '24 01:10 johnwilkins

@GroceryBoyJr sure. That's fine. I know it's big. I had no idea how many links there were to the bare metal install docs when I started. Sorry for the large size.

No problem sir. I'd rather you get peer review than not!

GroceryBoyJr avatar Oct 25 '24 21:10 GroceryBoyJr

/label peer-review-done /remove-label peer-review-in-progress

GroceryBoyJr avatar Oct 25 '24 21:10 GroceryBoyJr

/label merge-review-needed

johnwilkins avatar Oct 28 '24 14:10 johnwilkins

@johnwilkins: 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-ci[bot] avatar Oct 28 '24 20:10 openshift-ci[bot]

@johnwilkins Everything LGTM. I added a few comments for consideration for a follow-up PR. (Sorry, couldn't help myself, I tried!) I didn't click every link, it seems that James did that. The update links look OK in the code.

mburke5678 avatar Oct 29 '24 12:10 mburke5678

/cherrypick enterprise-4.18

mburke5678 avatar Oct 29 '24 16:10 mburke5678

@mburke5678: #83982 failed to apply on top of branch "enterprise-4.18":

Applying: OSDOCS-11699: Restructured bare metal install docs to live under the installing_bare_metal directory..
.git/rebase-apply/patch:3926: trailing whitespace.
// 
.git/rebase-apply/patch:3938: trailing whitespace.
// 
.git/rebase-apply/patch:3962: trailing whitespace.
// 
.git/rebase-apply/patch:3974: trailing whitespace.
// 
.git/rebase-apply/patch:3986: trailing whitespace.
// 
warning: squelched 4 whitespace errors
warning: 9 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	modules/installation-configure-proxy.adoc
M	modules/ipi-install-creating-an-rhcos-images-cache.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/ipi-install-creating-an-rhcos-images-cache.adoc
CONFLICT (content): Merge conflict in modules/ipi-install-creating-an-rhcos-images-cache.adoc
Auto-merging modules/installation-configure-proxy.adoc
Removing installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc
Removing installing/installing_bare_metal_ipi/images
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/snippets
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/modules
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/_attributes
Removing installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
Removing installing/installing_bare_metal/installing-bare-metal.adoc
Removing installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OSDOCS-11699: Restructured bare metal install docs to live under the installing_bare_metal directory..

In response to this:

/cherrypick enterprise-4.18

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.

@johnwilkins can this change be backported to other enterprise branches? it's pretty extensively affecting a lot of the bug work i do

jldohmann avatar Nov 06 '24 22:11 jldohmann

/cherrypick enterprise-4.17

jldohmann avatar Nov 15 '24 20:11 jldohmann

@jldohmann: #83982 failed to apply on top of branch "enterprise-4.17":

Applying: OSDOCS-11699: Restructured bare metal install docs to live under the installing_bare_metal directory..
.git/rebase-apply/patch:3926: trailing whitespace.
// 
.git/rebase-apply/patch:3938: trailing whitespace.
// 
.git/rebase-apply/patch:3962: trailing whitespace.
// 
.git/rebase-apply/patch:3974: trailing whitespace.
// 
.git/rebase-apply/patch:3986: trailing whitespace.
// 
warning: squelched 4 whitespace errors
warning: 9 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	disconnected/installing.adoc
M	installing/overview/cluster-capabilities.adoc
M	migration_toolkit_for_containers/premigration-checklists-mtc.adoc
M	modules/installation-configure-proxy.adoc
M	modules/ipi-install-creating-an-rhcos-images-cache.adoc
M	post_installation_configuration/cluster-tasks.adoc
M	service_mesh/v1x/preparing-ossm-installation.adoc
M	welcome/learn_more_about_openshift.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/learn_more_about_openshift.adoc
Auto-merging service_mesh/v1x/preparing-ossm-installation.adoc
Auto-merging post_installation_configuration/cluster-tasks.adoc
Auto-merging modules/ipi-install-creating-an-rhcos-images-cache.adoc
CONFLICT (content): Merge conflict in modules/ipi-install-creating-an-rhcos-images-cache.adoc
Auto-merging modules/installation-configure-proxy.adoc
Auto-merging migration_toolkit_for_containers/premigration-checklists-mtc.adoc
Auto-merging installing/overview/cluster-capabilities.adoc
Removing installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc
Removing installing/installing_bare_metal_ipi/images
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/snippets
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/modules
CONFLICT (content): Merge conflict in installing/installing_bare_metal/ipi/_attributes
Removing installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
Removing installing/installing_bare_metal/installing-bare-metal.adoc
Removing installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
Auto-merging disconnected/installing.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OSDOCS-11699: Restructured bare metal install docs to live under the installing_bare_metal directory..

In response to this:

/cherrypick enterprise-4.17

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.