department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 202 forks source link

CT Redesign: Create "Refine your search" component #23597

Closed dneel-bah closed 3 years ago

dneel-bah commented 3 years ago

As a developer, I need to create a component that allows users to filter their search results so that the institutions they are looking for can be displayed in the search results and the component can be tested during usability testing.

Assumptions:

  1. This work is completed in the CT sandbox found here: https://staging.va.gov/gi-bill-comparison-tool-sandbox/
  2. This component is similar to the current "Refine search" functionality on the search results.

Acceptance Criteria

  1. The user has the ability to filter down the search results by the following criteria: a. Type of Institution b. Location c. School Attributes d. Type of School e. School Mission

Type of Institution

  1. Filters available for "Type of Institution" are: a. Schools (default) b. Employers (On the job training and Apprenticeships) (default) c. VET TEC (default)

  2. The VET TEC filter has a sub-filter of "Preferred Provider" a. If the user selects the "Preferred Provider" filter, the "VET TEC" filter is automatically selected. b. If the user de-selects the "VET TEC" filter, the "Preferred Provider" filter is automatically de-selected.

Location

  1. The user can filter results by country. a. The country list is populated with the country of institutions in the current set of search results. b. All is an available filter option (default)

  2. The user can filter results by state. a. The state list is populated with the state of institutions in the current set of search results. b. All is an available filter option (default)

School Attributes

  1. The following are filter groupings under "School Attributes": a. Type of School b. School Mission

  2. The following general filters are available: a. Has no cautionary warnings b. Is accredited c. Has student veteran group d. Offers Yellow Ribbon Program

  3. The "Has no cautionary warnings" has a "Learn more" link that displays the following content:

    Cautionary warnings and school closings VA applies caution flags when we, or another federal agency, have increased regulatory or legal scrutiny of an educational program. We recommend students consider these warnings before enrolling in flagged programs.

    When VA receives notice that a school or campus location will be closing, we add a school closing flag to that profile. Once the closing date passes, we remove the institution from the Comparison Tool during the next system update.

    To learn more about caution flags, visit the About this Tool page.

  4. The "Is accredited" has a "Learn more" link that displays the following content:

    Accreditation and why it matters The goal of accreditation is to ensure that the education provided by institutions of higher education meets acceptable levels of quality. Schools can be accredited by private educational associations of regional or national scope.

    Accreditation matters if you plan to start school at one institution and transfer to another to complete your degree. Be sure to ask any potential school about their credit transfer policy.

  5. The available answers to the "Type of School" question are: a. All (default) b. Flight c. Foreign d. For Profit e. Private f. Public

  6. The available answers to the "School Mission" question are: a. Historically Black Colleges and Universities b. Single gender school c. Religious Affiliation

  7. The search results are updated to include results that contain the selected values of AC2-9.

  8. The user has the ability to initiate an update of the cards using a button after changing the answers to the questions.

Supporting Artifacts:

  1. Prototype - Search by name

  2. Prototype - Search by location

elder-joseph commented 3 years ago

Associated PRs: Website: https://github.com/department-of-veterans-affairs/vets-website/pull/17295 GIDS: https://github.com/department-of-veterans-affairs/gibct-data-service/pull/822

delli-gatti-michael commented 3 years ago

Testrail test run

zurbergram commented 3 years ago

need both to test filter updates Includes having these actions using filters: pressing Enter, clicking Search, clicking "Update results" in "Refine your search"

There are several backend changes so all filters should be tested

https://github.com/department-of-veterans-affairs/vets-website/pull/17455 https://github.com/department-of-veterans-affairs/gibct-data-service/pull/828/

delli-gatti-michael commented 3 years ago

After adding lat/long data to a VET TEC and OJT school locally I found the following:

  1. Unchecking "Schools" and having both "Employers" and "VET TEC" checked omits VET TEC results which should show.
  2. Unchecking "Schools" and having "Employers", "VET TEC", and "Preferred Providers" all checked omits all results.

I am currently unable to test the "country" filter for Location search as foreign institutions are currently not shown in the results.

zurbergram commented 3 years ago

https://github.com/department-of-veterans-affairs/gibct-data-service/pull/829 https://github.com/department-of-veterans-affairs/gibct-data-service/pull/828 now requires a generate and publish after running database migrations

delli-gatti-michael commented 3 years ago

Local testing complete

delli-gatti-michael commented 3 years ago

These changes are now on staging. Closing this issue