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.

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

[HTML Reports] Update User & Quick guides to match improvements #2048

Closed
2 tasks done
Tracked by #2019
philljenkins opened this issue Sep 13, 2024 · 11 comments · Fixed by #2056
Closed
2 tasks done
Tracked by #2019

[HTML Reports] Update User & Quick guides to match improvements #2048

philljenkins opened this issue Sep 13, 2024 · 11 comments · Fixed by #2056
Assignees
Labels
priority-3 (low) Ready for QA SME Discuss with subject matter experts

Comments

@philljenkins
Copy link
Contributor

philljenkins commented Sep 13, 2024

Update the following:

This update is dependent on the other issues in Epic R6.x HTML Reports #2019 so that valid screenshots can be taken

@philljenkins philljenkins self-assigned this Sep 13, 2024
@philljenkins philljenkins added SME Discuss with subject matter experts priority-3 (low) labels Sep 13, 2024
@philljenkins philljenkins mentioned this issue Sep 13, 2024
10 tasks
@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 13, 2024

@nam-singh @drjoho Please notify me which PR will include the final changes so I can take screenshots.
#2049

  • any changes to the Scan Summary, or only the HTML exported reports? Filter checkboxes added

Image

After pressing the 'Scan' button, the left panel shows a detailed list of issues grouped by 'Element roles'. The right panel shows the 'Scan summary' report with totals for each type of issue group.

The default view is by 'Element roles' that shows a detailed list of issues with expand/collapse control for each group. The view is also available by 'Requirements' or by 'Rules' when selected from the dropdown menu. Auditors often organize the view by ‘Requirement’ to get a list of issues by the WCAG accessibility guideline...

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 13, 2024

From a quick review of the Quick GuIde, I actually do not see any places needing updates for HTML reports. "HTML" is only mentioned in one place.

Screenshot 2024-09-13 at 9 34 58 AM

The above screenshot replaced and text edited for 'Export XLS' button.

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 13, 2024

The User Guide has several places where text and screenshots will need to be updated in section 6 (shown below), and section 3.7 Filter views and section 3.8 Show/Hide issues:

Screenshot 2024-09-13 at 9 40 43 AM

Screenshot replaced and text edited to address new filters.

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 18, 2024

waiting on PR #2049 to go to test so screenshots will be good

@philljenkins
Copy link
Contributor Author

Using Action artifacts to take screenshots
feature(extension): HTML Report CSS and Font Fix #2035 #4031

@nam-singh
Copy link
Contributor

nam-singh commented Sep 20, 2024

waiting on PR #2049 to go to test so screenshots will be good

PR #2049 is updated with htmlReportRelease branch, so ready to fix screenshots and editing.

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 23, 2024

Since PR #2049 is merged to main branch htmlReportRelease branch now, will use this branch to take new screenshots

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 24, 2024

I'll need to re-test after merging with master because when filtering on only Hidden only issues. Re-tested and issues are resolved.

Checker UI and Summary view

  • In summary view: the counts of Violations: zero, Needs review: zero, and Recommendations: zero are correct
  • In Filter view: the list of "Hidden" issues in correct
  • The counts of issues by type (e.g., 14, 26, 0, 12) is correct (I hid all the Recommendations in screenshot)
  • but, the 0 hidden issues is incorrect, now correct
  • and the large NaN % in Current Status is incorrect, now correct

Screenshot 2024-09-24 at 1 14 07 PM

HTML Report view

Hiding 12 issues, all the Recommendations and 2 Needs Review, then pressed the Export XLS button and viewed the exported htML Report page:

  • The Tile is correctly highlighted when the Recommendations filter is selected, even though there are only 'Hidden" issues
  • The "Recommendations" count zero is correct
  • The counts of issues by type (14, 26, 0 12) is correct
  • The list of 12 hidden issues is correct

Screenshot 2024-09-24 at 1 47 47 PM

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 24, 2024

When running the version 3.1.75 deployed to the store, I get ANOTHER different count, that are not correct. The 6 hidden issues are summarized correctly, but oddly "4" still show up under "Recommendations" in the Summary when the "Hidden" Filter is selected.

Checker UI and Summary view v 3.1.75

Screenshot 2024-09-24 at 1 37 21 PM

@philljenkins
Copy link
Contributor Author

philljenkins commented Sep 26, 2024

Ready for review. PR #2056 review assigned to @drjoho

@sct-will
Copy link
Contributor

sct-will commented Oct 1, 2024

This has been reviewed.

Fixed in PR: #2056

@sct-will sct-will closed this as completed Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3 (low) Ready for QA SME Discuss with subject matter experts
Projects
None yet
4 participants