Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix javadoc violations #675

Merged
merged 1 commit into from
Aug 31, 2023
Merged

Fix javadoc violations #675

merged 1 commit into from
Aug 31, 2023

Conversation

psoujany
Copy link
Contributor

@psoujany psoujany commented Jun 20, 2023 •
edited
Loading

This PR fixes below violation seen in openj9 docs generated using Semeru JDK8.

1. IBMA_Color_Contrast_WCAG2AA
Info: Violation Text contrast of 2.21 with its background is less than the WCAG AA minimum requirements for text of size  14px and weight of 700 - 1.4.3 Contrast (Minimum)

2. WCAG20_Table_CapSummRedundant
Info: Violation The table summary duplicates the caption - 1.3.1 Info and Relationships


Note: We've backport for IBMA_Color_Contrast_WCAG2AA which is in a stylesheet.css which contains 4 intermediate backports containing dependent patches being a challenge. Hence, raising the PR with required changes which fixes the violations in JDK8.

@pshipton
Copy link
Member

If this is a backport or is related to changes in a higher version (11, 17, etc), pls indicate what those changes are in OpenJDK.

@pshipton pshipton requested a review from keithc-ca June 20, 2023 13:21
@keithc-ca
Copy link
Member

The commit message and the description here should say "Fix ...", not "Fixing ...".

@psoujany
Copy link
Contributor Author

@pshipton
For IBMA_Color_Contrast_WCAG2AA below is the backport PR
openjdk/jdk17u-dev@e2eab3c

For WCAG20_Table_CapSummRedundant, there's no backport PR.

@psoujany psoujany changed the title Fixing javadoc violations Fix javadoc violations Jun 20, 2023
@keithc-ca
Copy link
Member

Why did you not pursue openjdk/jdk8u-dev#114 further?

pshipton added a commit to pshipton/openj9-docs that referenced this pull request Jun 21, 2023
@pshipton
Update jdk8 javadoc for 0.40
76f437c 
Using ibmruntimes/openj9-openjdk-jdk8#675

Signed-off-by: Peter Shipton <Peter_Shipton@ca.ibm.com>
@pshipton pshipton mentioned this pull request Jun 21, 2023
Merged
@psoujany
Copy link
Contributor Author

Why did you not pursue openjdk/jdk8u-dev#114 further?

This backport PR has dependencies on 4 of the intermediate patches which contain many changes to the sheet, also paths of the stylesheet.css in JDK8 and JDK11 is different which is not a straight backport. After discussing with JCL team it's been decided to only port those changes which fixes the violation instead of full backport so we couldn't take that PR further.

pshipton added a commit to pshipton/openj9-docs that referenced this pull request Aug 30, 2023
@pshipton
Update jdk8 javadoc for 0.41
0b4a10a 
Using ibmruntimes/openj9-openjdk-jdk8#675

Doc created by
https://openj9-jenkins.osuosl.org/job/Build_JDK8_x86-64_linux_Personal/453/

Signed-off-by: Peter Shipton <Peter_Shipton@ca.ibm.com>
@pshipton pshipton mentioned this pull request Aug 30, 2023
Merged
@keithc-ca
Copy link
Member

Jenkins compile plinux,win32 jdk8

@keithc-ca keithc-ca merged commit 1281c6e into ibmruntimes:openj9 Aug 31, 2023
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pshipton pshipton pshipton left review comments

@keithc-ca keithc-ca keithc-ca approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@psoujany @pshipton @keithc-ca