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

Refactor the vSphere 4.14 docs

Open dfitzmau opened this issue 1 year ago • 2 comments
trafficstars

Version(s): 4.14

Issue:

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

Additional information:

dfitzmau avatar Mar 25 '24 14:03 dfitzmau

🤖 Thu Apr 11 09:43:13 - Prow CI generated the docs preview: https://73685--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-previewbot avatar Mar 25 '24 16:03 ocpdocs-previewbot

Address the Minimum permissions for the storage components links in the following modules:

ipi-vsphere-installation-reqs.adoc

upi-vsphere-installation-reqs.adoc

dfitzmau avatar Mar 28 '24 12:03 dfitzmau

/retest

aireilly avatar Apr 04 '24 12:04 aireilly

/retest

dfitzmau avatar Apr 05 '24 12:04 dfitzmau

/label peer-review-needed

dfitzmau avatar Apr 09 '24 15:04 dfitzmau

Hey Darragh, I discussed this PR with the rest of the peer review squad, and we've decided that we won't review this PR as-is for a number of reasons:

  1. It's an incredibly large PR that would require either coordination between several members of the squad or a large chunk of one reviewer's time, and in either case it's a huge burden for the team.
  2. Even if we have the time, the size and complexity of this PR makes it prone to errors and missed things during review, especially since it moves files around, edits the topic map, and changes many xrefs.
  3. We've discussed an issue like this before where @kalexand-rh said it would be reasonable to ask writers to break up very large PRs into smaller ones if possible.
  4. Considering that Mike Pytlak performed the same kind of reorg for the 4.15+ vSphere docs, and he successfully did the work in many smaller chunks (see the subtasks in the linked JIRA issue, where I believe he dedicated a single PR for each subtask), it's clear that this work can be done in smaller chunks, so we do not feel that the burden of reviewing such a large PR is justified.

I don't think you need to perform this reorg in as many PRs as Mike did, but please break this work up into much smaller chunks. I think it would ensure better content and a better review process overall.

In the meantime I'll drop the peer-review-needed label, please add it back to the queue if you feel differently. Let me know if you have any questions, thanks!

skopacz1 avatar Apr 09 '24 18:04 skopacz1

/label peer-review-needed /label peer-review-in-progress

bergerhoffer avatar Apr 10 '24 13:04 bergerhoffer

Based on today's slack discussion, I will take the peer review for this one.

bergerhoffer avatar Apr 10 '24 13:04 bergerhoffer

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

bergerhoffer avatar Apr 10 '24 17:04 bergerhoffer

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

openshift-ci[bot] avatar Apr 11 '24 09:04 openshift-ci[bot]

Thanks, @bergerhoffer and @JoeAldinger :pray: . I'll address the above feedback in a separate PR.

/label merge-review-needed

dfitzmau avatar Apr 11 '24 10:04 dfitzmau

Merge review LGTM.

bscott-rh avatar Apr 11 '24 13:04 bscott-rh