Skip to content

Resolve "ENG: Make Search Results a New Page"

Step 1: What is changing in this MR?

Search is now a new page that allows doing searches by URL and allows to go back to a previous search by using the browser's back button.

This is how the search works as a new page:

  • It can be used by accessing via URL to https://1226-eng-make-search-results-a-new-page.about.gitlab-review.app/search?searchText=continuous where the searchText query param, it is required in order to make any search.

  • After accessing the page, other query parameters will be set as default, such as:

    Query Param Description Possible Values Default Value Required
    searchText Search term that comes from the search input or directly in the URL any text value N/A Yes
    source The engine filter marketing, handbook, blog marketing No
    sortBy The sorting values suggested, most_popular, last_updated suggested No
    page Pagination page any number 1 No
  • After making any change regarding the filters, sorting and pagination, the URL will be updated without refreshing the page, as this will work to go back after clicking any page from the search results

Next steps to iterate over:

  • Remove the search code from the Navigation repository that has been moved to Buyers Experience repository.
  • Modify the current search in the Navigation repository to use the search input as it is currently working but use the search results as a page.
  • Make a new Navigation release

Step 2: Ensure that your changes comply with the following, where applicable:

  • I, the Assignee, have run Axe tools on any updated pages, and fixed the relevant accessibility issues.
  • These changes meet a specific OKR or item in our Quarterly Plan.
  • These changes work on both Safari, Chrome, and Firefox.
  • These changes have been reviewed for Visual Quality Assurance and Functional Quality Assurance on Mobile, Desktop, and Tablet.
  • These changes work with our Google Analytics and SEO tools.
  • These changes have been documented as expected.

Step 3: Add the appropriate labels for triage

This MR will have dex-approval::2-standard automatically applied, but please update it as follows. If deciding between two levels, go with the higher of the two:

  1. dex-approval::1-minor
    1. Example of the type of change: typos or content changes.
      1. Anyone on the Digital Experience team can approve and merge.
      2. Once approved by the Digital Experience team, the MR creator can merge.
    2. Example of the type of change: /customers filter is displaying the wrong results.
      1. Anyone on the Digital Experience team can approve and merge.
      2. Once approved by the Digital Experience team, the MR creator can merge.
  2. dex-approval::2-standard
    1. Example of the type of change: re-arranging components on a page.
      1. Once the Digital Experience team approves, members of the Digital Experience team can merge.
      2. Members of the Digital Experience team should keep their Managers informed.
      3. Manager’s discretion to align with the Director of Digital Experience or not.
    2. Example of the type of change: Adding new pages.
      1. Managers of Digital Experience can approve and merge.
      2. Manager should align with Director, Digital Experience.
  3. dex-approval::3-key-page
    1. Example of the type of change: Changing Nav
      1. Directors and Managers of Digital Experience need to align.
      2. Managers of Digital Experience can approve and merge.
    2. Example of the type of change: Changes to key drivers of traffic and/or business goals etc. (Homepage, Pricing Page, Why GitLab).
      1. Director, Digital Experience can approve and merge.
      2. Director, Digital Experience will keep Marketing leadership informed of all Major Changes.
  4. dex-approval::4-legal
    1. Example of the type of change: Any changes to company information, board/director information, etc.
      1. Legal and Director of Digital Experience must approve.
    2. Example of the type of change: Changes to sign-up workflows or alteration/omission of footers/links to anything legal-related.
      1. Legal and Director of Digital Experience must approve.

Step 4: Tag the appropriate person for review

Depending on which label is used, you may tag the following people as a Reviewer on this MR:

  1. Level 1: Any member of the Digital Experience Team
  2. Level 2: Any member of the Digital Experience team
  3. Level 3: Ping @gitlab-com/marketing/digital-experience in a comment. This will tag the Digital Experience Leadership team, and they can review. When in doubt, tag @mpreuss as a reviewer.
  4. Level 4: This will need Legal approval. Tag @mpreuss and he can loop in the legal team.

Related #1226 (closed)

Edited by Lauren Barker

Merge request reports