Skip to content

#3481: Move alerts below breadcrumbs [meoward] #3835

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

kimallen
Copy link
Contributor

@kimallen kimallen commented May 27, 2025

Ticket

Resolves #3481

Changes

  • Moves the alerts (error and success) to below the breadcrumbs rather than above for the following screens:
    • profile (same template for both org and non-org)
    • member:
      • portfolio_member
      • portfolio_member_domains
      • portfolio_member_domains_edit
      • portfolio_member_permissions
      • portfolio_members_add_new
    • domain:
      • domain_add_user
      • domain_nameservers
      • domain_security_email
      • domain_suborganization
      • domain_dns
      • domain_dnssec
      • domain-dsdata
      • domain_users

Context for reviewers

Because some of the alerts were in the domain_base.html so were appearing above the breadcrumbs, I added a breadcrumbs block before those alerts and then moved the breadcrumbs in the child templates into the content block (and out of the domain_content block)

Setup

In both the org model and non-org model, walk through each of the steps for creating a domain request. cause both success and error alerts and ensure they are below the breadcrumbs. Also be sure to go to a domain whose status is "DNS needed" and walk through the pages for adding DNS and check the breadcrumbs location.

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

  • Met the acceptance criteria, or will meet them in a subsequent PR
  • Created/modified automated tests
  • Update documentation in READMEs and/or onboarding guide

Ensured code standards are met (Original Developer)

  • If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
  • Interactions with external systems are wrapped in try/except
  • Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

  • Tag @dotgov-designers in this PR's Reviewers for design review. If code is not user-facing, delete design reviewer checklist
  • Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
  • Checked keyboard navigability
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

  • Pulled this branch locally and tested it
  • Verified code meets all checks above. Address any checks that are not satisfied
  • Reviewed this code and left comments. Indicate if comments must be addressed before code is merged
  • Checked that all code is adequately covered by tests
  • Verify migrations are valid and do not conflict with existing migrations

Validated user-facing changes as a developer

Note: Multiple code reviewers can share the checklists above, a second reviewer should not make a duplicate checklist. All checks should be checked before approving, even those labeled N/A.

  • New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
  • Checked keyboard navigability
  • Meets all designs and user flows provided by design/product
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
  • (Rarely needed) Tested as both an analyst and applicant user

As a designer reviewer, I have

Verified that the changes match the design intention

  • Checked that the design translated visually
  • Checked behavior. Comment any found issues or broken flows.
  • Checked different states (empty, one, some, error)
  • Checked for landmarks, page heading structure, and links

Validated user-facing changes as a designer

  • Checked keyboard navigability
  • Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
  • Tested with multiple browsers (check off which ones were used)
    • Chrome
    • Microsoft Edge
    • FireFox
    • Safari
  • (Rarely needed) Tested as both an analyst and applicant user

References

Screenshots

@kimallen kimallen marked this pull request as ready for review May 29, 2025 21:35
@kimallen kimallen force-pushed the ka/3481-move-alerts-below-breadcrumbs branch from 07d4cde to a48f366 Compare May 29, 2025 21:57
@@ -21,7 +21,14 @@
{% endif %}
</div>

<div class="tablet:grid-col" id="main-content">
<div class="tablet:grid-col">
<main id="main-content" class="grid-container">
Copy link
Contributor Author

@kimallen kimallen May 29, 2025

Choose a reason for hiding this comment

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

@erinysong - I reverted this change from a recent PR because for accessibility reasons, we should not remove main- it's always better to use semantic html. I didn't see how it impacted the styling, but I'm sure you made the change for a reason, so let me know if this undoes something. I'm sure we can find a way to make the desired change without removing the main tag.

Copy link
Contributor

Choose a reason for hiding this comment

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

@kimallen thank you for changing that and explaining! We originally made that change because design noticed the grid sizing on the domain and domain request summary sidebars were different from the portfolio sidebar. We changed the domain and domain request layouts to match the portfolio but we can definitely revert this to maintain accessibility. cc: @gabo0oo who I was working on this during that PR's design review

Copy link
Contributor Author

@kimallen kimallen May 30, 2025

Choose a reason for hiding this comment

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

Thanks for the context @erinysong - I talked with @gabo0oo and figured out where the spacing issue was and believe that I adjusted it back while maintaining the <main> tag.

@lizpearl lizpearl self-assigned this Jun 2, 2025
@lizpearl lizpearl removed their assignment Jun 2, 2025
@kimallen kimallen changed the title Move alerts below breadcrumbs [KMA] #3481: Move alerts below breadcrumbs [KMA] Jun 2, 2025
@kimallen kimallen changed the title #3481: Move alerts below breadcrumbs [KMA] #3481: Move alerts below breadcrumbs [meoward] Jun 2, 2025
@witha-k witha-k requested review from witha-k and removed request for a team June 3, 2025 15:21
Copy link
Contributor

@witha-k witha-k left a comment

Choose a reason for hiding this comment

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

Blocked from reviewing - running into 500 errors on the meoward sandbox when I try to access a domin in the admin portal & when I try to start domain requests in both org model and non-org model..

@witha-k
Copy link
Contributor

witha-k commented Jun 3, 2025

Blocked from reviewing - running into 500 errors on the meoward sandbox when I try to access a domin in the admin portal & when I try to start domain requests in both org model and non-org model..

Never mind, some migrations weren't applied but Liz helped fix this issue!

@witha-k witha-k self-requested a review June 3, 2025 17:05
Copy link
Contributor

@witha-k witha-k left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@erinysong erinysong self-assigned this Jun 3, 2025
@erinysong
Copy link
Contributor

erinysong commented Jun 3, 2025

Thank you for moving all of these! This may be a separate bug but I noticed when prompting an alert on the domain renewal form tab, we have 2 breadcrumb menus so the alerts on this page appear twice above the breadcrumb. If updating this page and removing one of the breadcrumb menus ends up being more involved than a quickfix, happy to also make a bug ticket for this!

I believe expiring domains are a little hard to reproduce in sandboxes because they pull from registry data and I just happened to find this because @therealslimhsiehdy manually created an expiring domain for me in my sandbox for a past PR I was testing, so feel free to test on my sandbox by adding yourself as a domain manager for account-wind-plant.gov if that makes testing easier!

image image

Copy link
Contributor

@erinysong erinysong left a comment

Choose a reason for hiding this comment

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

Updated pages LGTM! Just had one change request commented above to update domain_renewal.html's error message placement that I think can be fixed by updating domain_renewal.html the same as you did the ones here

@github-project-automation github-project-automation bot moved this to 👀 In review in .gov Product Board Jun 3, 2025
@witha-k witha-k requested review from a team and removed request for a team June 3, 2025 20:44
@kimallen
Copy link
Contributor Author

kimallen commented Jun 3, 2025

Updated pages LGTM! Just had one change request commented above to update domain_renewal.html's error message placement that I think can be fixed by updating domain_renewal.html the same as you did the ones here

Good catch! And thanks for the tip on how to test it. I believe I have updated it, but I'm having trouble accessing the right things to view it in the sandbox. I sent an email to you with more details.

@erinysong
Copy link
Contributor

Updated pages LGTM! Just had one change request commented above to update domain_renewal.html's error message placement that I think can be fixed by updating domain_renewal.html the same as you did the ones here

Good catch! And thanks for the tip on how to test it. I believe I have updated it, but I'm having trouble accessing the right things to view it in the sandbox. I sent an email to you with more details.

Thank you! Ah I don't think I got an email but happy to go over it from standup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

Change the placement of alerts to go below the breadcrumb
4 participants