OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 #55666

tshwartz · 2023-02-08T09:11:06Z

Title:
Misleading information in Driver Toolkit doc in 4.11

Summary of changes:
Updates to step 1 of the 'Finding the Driver Toolkit image URL in the payload' section.

Versions:
Enterprise 4.11

Issue:
(https://issues.redhat.com/browse/OCPBUGS-6709?filter=-1)

Link to docs preview:
http://file.emea.redhat.com/tshwartz/OCPBUGS-6709/hardware_enablement/psap-driver-toolkit.html

QE review:

QE has approved this change.

Additional information:

openshift-ci-robot · 2023-02-08T09:11:13Z

@tshwartz: This pull request references Jira Issue OCPBUGS-6709, which is invalid:

expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead
expected Jira Issue OCPBUGS-6709 to depend on a bug in one of the following states: VERIFIED, RELEASE PENDING, CLOSED (ERRATA), CLOSED (CURRENT RELEASE), CLOSED (DONE), but no dependents were found

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:

Title:
Misleading information in Driver Toolkit doc in 4.11

Versions:
Enterprise 4.11

Issue:
(https://issues.redhat.com/browse/OCPBUGS-6709?filter=-1)

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

ocpdocs-previewbot · 2023-02-08T09:17:31Z

🤖 Updated build preview is available at:
https://55666--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/10664

openshift-ci-robot · 2023-02-12T15:16:49Z

@tshwartz: This pull request references Jira Issue OCPBUGS-6709, which is invalid:

expected the bug to be in one of the following states: NEW, ASSIGNED, POST, but it is MODIFIED instead
expected Jira Issue OCPBUGS-6709 to depend on a bug in one of the following states: VERIFIED, RELEASE PENDING, CLOSED (ERRATA), CLOSED (CURRENT RELEASE), CLOSED (DONE), but no dependents were found

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:

Title:
Misleading information in Driver Toolkit doc in 4.11

Versions:
Enterprise 4.11

Issue:
(https://issues.redhat.com/browse/OCPBUGS-6709?filter=-1)

Link to docs preview:
https://55666--docspreview.netlify.app/openshift-enterprise/latest/hardware_enablement/psap-driver-toolkit.html

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

openshift-ci-robot · 2023-02-15T17:02:01Z

@tshwartz: 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:

Title:
Misleading information in Driver Toolkit doc in 4.11

Versions:
Enterprise 4.11

Issue:
(https://issues.redhat.com/browse/OCPBUGS-6709?filter=-1)

Link to docs preview:
https://55666--docspreview.netlify.app/openshift-enterprise/latest/hardware_enablement/psap-driver-toolkit.html

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

Fixmetal · 2023-02-27T11:22:44Z

/lgtm
thanks @tshwartz

cdvultur · 2023-02-28T16:14:25Z

/lgtm

tshwartz · 2023-03-05T10:51:17Z

/label telco
/label peer-review-needed

kcarmichael08 · 2023-03-06T12:54:13Z

/label peer-review-in-progress

kcarmichael08

I had a couple of comments/questions; otherwise, LGTM!

kcarmichael08 · 2023-03-06T13:15:39Z

modules/psap-driver-toolkit-pulling.adoc

 ----
 +
+[IMPORTANT]
+====
+ARM images are built for 64-bit Arm (AArch64) only, and are currently a Technology Preview feature. For more information about {product-title} on ARM, see xref:../release_notes/ocp-4-11-release-notes.html#ocp-4-11-release-notes[Release Notes]. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. 


Suggested change

ARM images are built for 64-bit Arm (AArch64) only, and are currently a Technology Preview feature. For more information about {product-title} on ARM, see xref:../release_notes/ocp-4-11-release-notes.html#ocp-4-11-release-notes[Release Notes]. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].

ARM images are built for 64-bit ARM (AArch64) only, and are currently a Technology Preview feature. For more information about {product-title} on ARM, see xref:../release_notes/ocp-4-11-release-notes.html#ocp-4-11-release-notes[Release Notes]. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].

Maybe there is an exception for Telco docs (?) but usually xrefs aren't allowed in OCP modules (Release Notes link).

Hi @kcarmichael08 Thanks for your feedback. I see other links in the section so I'll ping you later to finalize this.

kcarmichael08 · 2023-03-06T13:35:00Z

modules/psap-driver-toolkit-pulling.adoc

@@ -28,17 +28,29 @@ The driver-toolkit image for the latest minor release will be tagged with the mi
 +
 [source,terminal]
 ----
-$ oc adm release info 4.11.0 --image-for=driver-toolkit
+# For x86 image:


I think you need an explicit instruction to "run" or "enter" the command, and only one command per code block is allowed per https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#code-blocks-command-syntax-and-example-output

Maybe something like:

The image URL of the driver-toolkit corresponding to a certain release can be extracted from the release image using the oc adm command.

For an x86 image, enter the following command:

[example]

For an ARM image, enter the following command:

[example]

I copied this directly from the latest version published: https://docs.openshift.com/container-platform/4.12/hardware_enablement/psap-driver-toolkit.html Let's discuss this comment too.

kcarmichael08 · 2023-03-06T13:38:34Z

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

openshift-ci · 2023-03-07T14:25:22Z

New changes are detected. LGTM label has been removed.

tshwartz · 2023-03-09T10:41:31Z

/label merge-review-needed

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

tshwartz force-pushed the OCPBUGS-6709 branch from ad0551c to 41ce2e2 Compare February 12, 2023 11:03

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 12, 2023

tshwartz force-pushed the OCPBUGS-6709 branch from 41ce2e2 to 3d64e3f Compare February 12, 2023 12:36

tshwartz force-pushed the OCPBUGS-6709 branch from 233915c to f1127f2 Compare February 14, 2023 08:24

kalexand-rh changed the title ~~OCPBUGS-6709: Misleading information in Driver Toolkit doc in 4.11~~ OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 Feb 15, 2023

openshift-ci-robot removed the jira/severity-moderate Referenced Jira bug's severity is moderate for the branch this PR is targeting. label Feb 15, 2023

kalexand-rh added jira/severity-moderate Referenced Jira bug's severity is moderate for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Feb 15, 2023

openshift-ci-robot removed the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 15, 2023

tshwartz force-pushed the OCPBUGS-6709 branch 5 times, most recently from eb82550 to fdf3eb2 Compare February 23, 2023 16:10

tshwartz force-pushed the OCPBUGS-6709 branch 2 times, most recently from c05dd00 to d5826f4 Compare February 27, 2023 10:45

openshift-ci bot assigned Fixmetal Feb 27, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2023

openshift-ci bot assigned cdvultur Feb 28, 2023

openshift-ci bot added telco Label for all Telco PRs peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 5, 2023

openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Mar 6, 2023

kcarmichael08 reviewed Mar 6, 2023

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 6, 2023

tshwartz force-pushed the OCPBUGS-6709 branch from d5826f4 to 77d9085 Compare March 7, 2023 14:24

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 7, 2023

tshwartz force-pushed the OCPBUGS-6709 branch 2 times, most recently from d74fec9 to 6d1dc60 Compare March 9, 2023 09:12

OCPBUGS-6709: Misleading information in Driver Toolkit doc in 4.11

a06b434

tshwartz force-pushed the OCPBUGS-6709 branch from 6d1dc60 to a06b434 Compare March 9, 2023 09:20

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Mar 9, 2023

jeana-redhat added merge-review-in-progress Signifies that the merge review team is reviewing this PR branch/enterprise-4.11 labels Mar 9, 2023

jeana-redhat merged commit 83dd92b into openshift:enterprise-4.11 Mar 9, 2023

jeana-redhat removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Mar 9, 2023

jeana-redhat added this to the Continuous Release milestone Mar 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 #55666

OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 #55666

tshwartz commented Feb 8, 2023 •

edited

openshift-ci-robot commented Feb 8, 2023

ocpdocs-previewbot commented Feb 8, 2023 •

edited

openshift-ci-robot commented Feb 12, 2023

openshift-ci-robot commented Feb 15, 2023

Fixmetal commented Feb 27, 2023

cdvultur commented Feb 28, 2023

tshwartz commented Mar 5, 2023

kcarmichael08 commented Mar 6, 2023

kcarmichael08 left a comment

kcarmichael08 Mar 6, 2023

kcarmichael08 Mar 6, 2023

tshwartz Mar 7, 2023

kcarmichael08 Mar 6, 2023

tshwartz Mar 7, 2023 •

edited

kcarmichael08 commented Mar 6, 2023

openshift-ci bot commented Mar 7, 2023

tshwartz commented Mar 9, 2023

OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 #55666

OCPBUGS#6709: Misleading information in Driver Toolkit doc in 4.11 #55666

Conversation

tshwartz commented Feb 8, 2023 • edited

openshift-ci-robot commented Feb 8, 2023

ocpdocs-previewbot commented Feb 8, 2023 • edited

openshift-ci-robot commented Feb 12, 2023

openshift-ci-robot commented Feb 15, 2023

Fixmetal commented Feb 27, 2023

cdvultur commented Feb 28, 2023

tshwartz commented Mar 5, 2023

kcarmichael08 commented Mar 6, 2023

kcarmichael08 left a comment

Choose a reason for hiding this comment

kcarmichael08 Mar 6, 2023

Choose a reason for hiding this comment

kcarmichael08 Mar 6, 2023

Choose a reason for hiding this comment

tshwartz Mar 7, 2023

Choose a reason for hiding this comment

kcarmichael08 Mar 6, 2023

Choose a reason for hiding this comment

tshwartz Mar 7, 2023 • edited

Choose a reason for hiding this comment

kcarmichael08 commented Mar 6, 2023

openshift-ci bot commented Mar 7, 2023

tshwartz commented Mar 9, 2023

tshwartz commented Feb 8, 2023 •

edited

ocpdocs-previewbot commented Feb 8, 2023 •

edited

tshwartz Mar 7, 2023 •

edited