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

Add layout and functionality for 2d broken link checker #1891

Merged
merged 9 commits into from
Jun 7, 2024

Conversation

kishore03109
Copy link
Contributor

@kishore03109 kishore03109 commented May 30, 2024

@hanpuliu-charles todo fill this up ya

Problem

Closes [insert issue #]
This pr implements the 2 level broken link checker interface, moving individual errors on a page into a modal, that overlays over main broken link checker page, which now provides a summary listing the page and number of errors on it in a table.

Solution

Implemented the design here.

Breaking Changes

  • Yes - this PR contains breaking changes
    • Details ...
  • No - this PR is backwards compatible with ALL of the following feature flags in this doc

Features:

  • Improves usability of the broken link checker function, making it less cluttered(No longer listing all errors on a single page.)

Improvements:

  • Splitting of tables into 2 levels(Site level table shown at first, listing each page with error and error count, and page level table which is in a modal shown when user clicks the 'Review Page' link.)
  • Now attempts to classify the different types of links into hyperlinks(both relative and absolute), email
  • Using the above, display some hints to the user on suggested ways to rectify the errors(It's quite limited at the moment)

Before & After Screenshots

BEFORE:
Old Scanning

Old Populated

Old ErrorFree

AFTER:

New Main Scanning
New Main Populated
New Main ErrorFree

New Modal Scanning
New Modal Populated
New Modal ErrorFree

Tests

  • Unit tests (using npm run tests)
  • e2e tests (comment on this PR with the text !run e2e)
  • Smoke tests
    Not too sure about this. No new test added.

@kishore03109 kishore03109 requested a review from a team May 30, 2024 05:08
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
Copy link
Contributor Author

@kishore03109 kishore03109 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot approve since it is a pr i created.
This is ok from my end, all the comments here are just nits. once the nits are resolved, proceed to approve this pr and reember to squah and merge into dev

also moving forward, when creating commits, use commitcitizen for your commits ya

sorry for the delay in review, good work on your first pr!

src/assets/images/NoBrokenLinksImage.tsx Show resolved Hide resolved
src/components/paginateButton.tsx Outdated Show resolved Hide resolved
src/components/paginateButton.tsx Outdated Show resolved Hide resolved
src/components/paginateButton.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
src/layouts/LinkReport/LinksReport.tsx Outdated Show resolved Hide resolved
@@ -236,7 +236,10 @@ export const SiteDashboard = (): JSX.Element => {
<HStack>
<Text textStyle="h4">
{brokenLinks?.status === "success" &&
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ya seems like this is unchanged

Copy link
Contributor

@hanpuliu-charles hanpuliu-charles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed all nits, proceeding to approve this PR

@hanpuliu-charles hanpuliu-charles merged commit 2ddd4b4 into develop Jun 7, 2024
7 of 8 checks passed
@mergify mergify bot deleted the 2d-brokenlink-checker branch June 7, 2024 02:24
@alexanderleegs alexanderleegs mentioned this pull request Jun 13, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants