Merge branch 'main' into za/861-remove-archive

.github/pull_request_template.md

@@ -1,13 +1,134 @@
-# <!-- Use the title to describe PR changes in the imperative mood --> #
+## Ticket
 
-## 🗣 Description ##
+Resolves #00
+<!--Reminder, when a code change is made that is user facing, beyond content updates, then the following are required:
+- a developer approves the PR
+- a designer approves the PR or checks off all relevant items in this checklist.
 
-<!-- Describe the "what" of your changes in detail. -->
+All other changes require just a single approving review.-->
-<!-- Please link to any relevant issues. -->
 
-## 💭 Motivation and context ##
+## Changes
 
-<!-- Why is this change required? -->
+<!-- What was added, updated, or removed in this PR. -->
-<!-- What problem does this change solve? How did you solve it? -->
+- Change 1
-<!-- Mention any related issue(s) here using appropriate keywords such -->
+- Change 2
-<!-- as "closes" or "resolves" to auto-close them on merge. -->
+
+<!--
+    Please add/remove/edit any of the template below to fit the needs
+    of this specific PR.
+--->
+
+## Context for reviewers
+
+<!--Background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers.  -->
+
+## Setup
+
+<!--  Add any steps or code to run in this section to help others run your code.
+    
+    Example 1:
+    ```sh
+    echo "Code goes here"
+    ``` 
+    
+    Example 2: If the PR was to add a new link with a redirect, this section could simply be:
+    -go to /path/to/start/page
+    -click the blue link in the <insert location>
+    -notice user is redirected to <proper end 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
+- [ ] Added at least 2 developers as PR reviewers (only 1 will need to approve)
+- [ ] Messaged on Slack or in standup to notify the team that a PR is ready for review
+- [ ] Changes to “how we do things” are documented in READMEs and or onboarding guide
+- [ ] If any model was updated to modify/add/delete columns, makemigrations was ran and the assoicated migrations file has been commited.
+
+#### Ensured code standards are met (Original Developer)
+
+- [ ] All new functions and methods are commented using plain language
+- [ ] Did dependency updates in Pipfile also get changed 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)
+
+- [ ] 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)
+- [ ] Add at least 1 designer as PR reviewer
+
+### As a code reviewer, I have
+
+#### Reviewed, tested, and left feedback about the changes
+
+- [ ] Pulled this branch locally and tested it
+- [ ] Reviewed this code and left comments
+- [ ] Checked that all code is adequately covered by tests
+- [ ] Made it clear which comments need to be addressed before this work is merged
+- [ ] If any model was updated to modify/add/delete columns, makemigrations was ran and the assoicated migrations file has been commited.
+
+#### Ensured code standards are met (Code reviewer)
+
+- [ ] All new functions and methods are commented using plain language
+- [ ] Interactions with external systems are wrapped in try/except
+- [ ] Error handling exists for unusual or missing values
+- [ ] (Rarely needed) Did dependency updates in Pipfile also get changed in requirements.txt?
+
+#### Validated user-facing changes as a developer
+
+- [ ] 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)
+
+- [ ] Tested with multiple browsers, the suggestion is to use ones that the developer didn't (check off which ones were used)
+  - [ ] Chrome
+  - [ ] Microsoft Edge
+  - [ ] FireFox
+  - [ ] Safari
+
+- [ ] (Rarely needed) Tested as both an analyst and applicant user
+
+**Note:** Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist
+
+### As a designer reviewer, I have
+
+#### Verified that the changes match the design intention
+
+- [ ] Checked that the design translated visually
+- [ ] Checked behavior
+- [ ] Checked different states (empty, one, some, error)
+- [ ] Checked for landmarks, page heading structure, and links
+- [ ] Tried to break the intended flow
+
+#### 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
+
+## Screenshots
+
+<!-- If this PR makes visible interface changes, an image of the finished interface can help reviewers
+and casual observers understand the context of the changes.
+A before image is optional and can be included at the submitter's discretion.
+
+Consider using an animated image to show an entire workflow.
+You may want to use [GIPHY Capture](https://giphy.com/apps/giphycapture) for this! 📸
+
+_Please frame images to show useful context but also highlight the affected regions._
+--->

docs/architecture/decisions/0021-django-admin.md

@@ -34,6 +34,13 @@ In contrast to building an admin interface from scratch where development activi
 involve _building up_, leveraging Django Admin will require carefully _pairing back_ the functionalities available to
 users such as analysts.
 
+On accessibility: Django admin is almost fully accessible out-of-the-box, the exceptions being tables, checkboxes, and
+color contrast. We have remedied the first 2 with template overrides and the 3rd with theming (see below).
+
+On USWDS and theming: Django admin brings its own high level design framework. We have determined that theming on top of Django (scss)
+is easy and worthwhile, while overwriting Django's templates with USWDS is hard and provides little return on investment
+([research PR](https://github.com/cisagov/getgov/pull/831)).
+
 While we anticipate that Django Admin will meet (or even exceed) the user needs that we are aware of today, it is still
 an open question whether Django Admin will be the long-term administrator tool of choice. A pivot away from Django Admin
 in the future would of course mean starting from scratch at a later date, and potentially juggling two separate admin

src/registrar/assets/sass/_theme/_admin.scss

@@ -105,19 +105,29 @@ html[data-theme="light"] {
     }
 
     // Dark mode django (bug due to scss cascade) and USWDS tables
-    body,
     .change-list .usa-table,
-    .change-list .usa-table--striped tbody tr:nth-child(odd) td {
+    .change-list .usa-table--striped tbody tr:nth-child(odd) td,
-        color: var(--body-fg)!important;
+    .change-list .usa-table--borderless thead th,
+    .change-list .usa-table thead td, 
+    .change-list .usa-table thead th,
+    body.dashboard,
+    body.change-list,
+    body.change-form {
+        color: var(--body-fg);
     }
 }
 
 // Firefox needs this to be specifically set
 html[data-theme="dark"] {
-    body,
     .change-list .usa-table,
-    .change-list .usa-table--striped tbody tr:nth-child(odd) td {
+    .change-list .usa-table--striped tbody tr:nth-child(odd) td,
-        color: var(--body-fg)!important;
+    .change-list .usa-table--borderless thead th,
+    .change-list .usa-table thead td, 
+    .change-list .usa-table thead th,
+    body.dashboard,
+    body.change-list,
+    body.change-form {
+        color: var(--body-fg);
     }
 }
 

src/registrar/templates/home.html

@@ -127,14 +127,15 @@
     <p>You don't have any archived domains</p>
   </section>
 
-  <section class="tablet:grid-col-11 desktop:grid-col-10">
+  <!-- Note: Uncomment below when this is being implemented post-MVP -->
+  <!-- <section class="tablet:grid-col-11 desktop:grid-col-10">
     <h2 class="padding-top-1 mobile-lg:padding-top-3"> Export domains</h2>
     <p>Download a list of your domains and their statuses as a csv file.</p>
     <a href="{% url 'todo' %}" class="usa-button usa-button--outline">
       Export domains as csv
     </a>
-  </section>
+  </section> -->
-  -->
+
 </div>
 
 {% else %} {# not user.is_authenticated #}

src/zap.conf

@@ -31,6 +31,8 @@
 10027	OUTOFSCOPE	http://app:8080/public/js/uswds-init.min.js
 # get-gov.js contains suspicious word "from" as in `Array.from()`
 10027	OUTOFSCOPE	http://app:8080/public/js/get-gov.js
+# Ignore wording of "TODO"
+10027	OUTOFSCOPE	http://app:8080.*$
 10028	FAIL	(Open Redirect - Passive/beta)
 10029	FAIL	(Cookie Poisoning - Passive/beta)
 10030	FAIL	(User Controllable Charset - Passive/beta)