openshift
OADP-6294: Mod-work for the OADP Troubleshooting user story
Version(s): OCP 4.19-4.20
Issue: OADP-6294
Link to docs preview: OADP troubleshooting and its sub-modules
QE review:
- [ ] QE has approved this change.
Note -
-
This is a modularization work for the OADP Troubleshooting user story.
-
As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.
@apurvabhide17: This pull request references OADP-6294 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 sub-task to target the "4.20.0" version, but no target version was set.
In response to this:
Version(s): OCP 4.20
Issue: OADP-6294
Link to docs preview:
QE review:
- [ ] QE has approved this change.
Note -
This is a modularization work for the OADP Troubleshooting user story.
As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.
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.
🤖 Thu Jul 03 14:10:57 - Prow CI generated the docs preview: https://95005--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt
@apurvabhide17 - please can you check which versions these changes need to be cherry-picked to
thanks
@apurvabhide17: This pull request references OADP-6294 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 sub-task to target the "4.20.0" version, but no target version was set.
In response to this:
Version(s): OCP 4.20
Issue: OADP-6294
Link to docs preview: OADP troubleshooting and its sub-modules
QE review:
- [ ] QE has approved this change.
Note -
This is a modularization work for the OADP Troubleshooting user story.
As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.
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.
@apurvabhide17: This pull request references OADP-6294 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 sub-task to target the "4.20.0" version, but no target version was set.
In response to this:
Version(s): OCP 4.19-4.20
Issue: OADP-6294
Link to docs preview: OADP troubleshooting and its sub-modules
QE review:
- [ ] QE has approved this change.
Note -
This is a modularization work for the OADP Troubleshooting user story.
As discussed with Kathryn, skipping the QE review because this PR focuses on changing structure and there are no technical changes.
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.
Nice work modularizing this section of the docs! I provided a few comments where I noticed that you might align more closely with IBM Style, the Supplementary Style Guide, or the OCP docs guidelines. I understand that this PR mainly focuses on structural changes, though, so feel free to save those changes for a later time when you are more focused on wording improvements.
Thanks, @lahinson for reviewing and adding your suggestions. I've applied your suggestions. Since the main focus of this PR was modularization, I'll share the added suggestions with the team so that they can add them later as I've changed my role effective 1st July.
In an effort to help move things along, for me, the following issues are the minimum to merge:
- fixing the instance where you use the OCP abbreviation. please change this {product-title} or {ocp}, whatever you use in your docs set
- fixing the two places where the mod docs content type is missing
The other issues, including the ones Laura called out, really should be addressed as a follow up. It is important for our ContentX goals. Perhaps breaking them up by assembly and related modules as smaller chunks will make it easier for the next writer to work on it a little at a time. It will certainly make for speedier reviews.
@apurvabhide17: 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](https://avatars.githubusercontent.com/in/91280?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hello @michaelryanpeter, thanks for your suggestions. I've implemented most of your suggestions. As mentioned in the description of this ticket, this PR focuses on mod-work and this was a huge user story, and updating other changes will be beyond the scope of this PR. I've already shared the remaining suggestions with the team, which can be completed in the next PR. Requesting you to merge the changes, thanks in advance!
@michaelryanpeter: #95005 failed to apply on top of branch "enterprise-4.19":
Applying: OADP-6294: Mod-work for the OADP Troubleshooting user story
.git/rebase-apply/patch:110: trailing whitespace.
* Backup CR status remains in progress
.git/rebase-apply/patch:473: trailing whitespace.
Velero plugins are started as separate processes. After a Velero operation has completed, either successfully or not, it exits.
.git/rebase-apply/patch:1695: trailing whitespace.
If the persistent volume (PV) and the snapshot locations are in different regions, the `Backup` custom resource (CR) displays the following error message:
warning: 3 lines add whitespace errors.
Using index info to reconstruct a base tree...
M _topic_maps/_topic_map.yml
M backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
M modules/oadp-features-plugins-known-issues.adoc
Falling back to patching base and 3-way merge...
Removing modules/oadp-plugins-receiving-eof-message.adoc
CONFLICT (modify/delete): modules/oadp-features-plugins-known-issues.adoc deleted in OADP-6294: Mod-work for the OADP Troubleshooting user story and modified in HEAD. Version HEAD of modules/oadp-features-plugins-known-issues.adoc left in tree.
Auto-merging backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
CONFLICT (content): Merge conflict in backup_and_restore/application_backup_and_restore/oadp-features-plugins.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 OADP-6294: Mod-work for the OADP Troubleshooting user story
In response to this:
/cherrypick enterprise-4.19 /cherrypick enterprise-4.20
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.
@michaelryanpeter: #95005 failed to apply on top of branch "enterprise-4.20":
Applying: OADP-6294: Mod-work for the OADP Troubleshooting user story
.git/rebase-apply/patch:110: trailing whitespace.
* Backup CR status remains in progress
.git/rebase-apply/patch:473: trailing whitespace.
Velero plugins are started as separate processes. After a Velero operation has completed, either successfully or not, it exits.
.git/rebase-apply/patch:1695: trailing whitespace.
If the persistent volume (PV) and the snapshot locations are in different regions, the `Backup` custom resource (CR) displays the following error message:
warning: 3 lines add whitespace errors.
Using index info to reconstruct a base tree...
M _topic_maps/_topic_map.yml
M backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
M modules/oadp-features-plugins-known-issues.adoc
Falling back to patching base and 3-way merge...
Removing modules/oadp-plugins-receiving-eof-message.adoc
CONFLICT (modify/delete): modules/oadp-features-plugins-known-issues.adoc deleted in OADP-6294: Mod-work for the OADP Troubleshooting user story and modified in HEAD. Version HEAD of modules/oadp-features-plugins-known-issues.adoc left in tree.
Auto-merging backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
CONFLICT (content): Merge conflict in backup_and_restore/application_backup_and_restore/oadp-features-plugins.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 OADP-6294: Mod-work for the OADP Troubleshooting user story
In response to this:
/cherrypick enterprise-4.20
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.
There are some problems cherrypicking forward to 4.19 and 4.20 that will require a manual cherrypick.
For file: openshift-docs/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
I figured out that 4.19 and 4.20 are missing the fips module that is in main
- 4.19: https://github.com/openshift/openshift-docs/blob/a3932955c162819bedf169b6e66fbfbe934ed1e9/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc?plain=1#L36
- File in PR: https://github.com/openshift/openshift-docs/pull/95005/files#diff-39c6f3342cd56157303dd2b7ac4c48501c5455fb8c566e94edeb47e93dd581b4R36
- Change introduced in main: https://github.com/openshift/openshift-docs/commit/44d40f24f3d9d70fa00ea63308ae90367fba2732
- The FIPS PR was never cherrypicked to another branch: https://github.com/openshift/openshift-docs/pull/65310 I suspect that this should this be added to 4.12+?
For the other file mentioned, modules/oadp-features-plugins-known-issues.adoc, I can't put my finger on what is happening. A modify/delete error signals that one branch is deleting a file and the file on the other branch has been modified. When I look at the history of the file, it looks like it hasn't been updated since December 2024:
- https://github.com/openshift/openshift-docs/commits/enterprise-4.20/modules/oadp-features-plugins-known-issues.adoc
- https://github.com/openshift/openshift-docs/commits/main/modules/oadp-features-plugins-known-issues.adoc
I wonder if Git is confused due to the file getting deleted AND a file that uses oadp-features-plugins.adoc as an include is also being renamed in the PR? https://github.com/openshift/openshift-docs/pull/95005/files#diff-bf66eba76b24b8ace2a9b1df66140be81bd2219d04241369f40a6d0bcf51057a
@bergerhoffer Would you PTAL and advise when you get the chance?
cc: @kalexand-rh
I replied in slack already, but just reposting here for historic reasons:
I did a diff of the file in main when it's being deleted in that PR, and how it is in 4.20 and the content isn't the same, so it's going to choke on that delete, because it's not the same exact content.
It looks like it was entered in differently in main vs. whichever 4.x branch it went into .
You can see by the mod-docs-content-type vs content-type (among other changes) in the two versions:
- https://github.com/openshift/openshift-docs/commit/63925e95b9ad3188ac841ca8ce86acee636903cd
- https://github.com/openshift/openshift-docs/commit/04ce1b085fe9b3cd673f1d4e88d0dbceba682cd9
But either way, it's being deleted, and there isn't a PR that was missed, so I don't think you need to take action on it. So you can just cherry pick that other PR you found that was missed, and then the author can do a manual CP for this PR int 4.19 and 4.20, and hopefully things should be in sync after that.
@apurvabhide17: I was able to fix one of the problem files by merging cherrypicks off of an old PR where they were missed. Would you please perform manual cherrypicks for 4.19 and 4.20?
Thank you. Please feel free to @ mention me in the PR and DM me in Slack when the manual picks are ready to merge.