Skip to content

WDFN-877 - Implemented some changes to content display, meta data generation, and marking sections in nosnippet to hopefully improve our SEO.

Bucknell, Mary S. requested to merge mbucknell/waterdataui:wdfn-877 into main

Before making a pull request

  • Put the appropriate EXEMPT flag if needed in the MR label (see https://practices.wma.chs.usgs.gov/practice/peer_code_review/)
  • Run all linters (make lint)
  • Run all tests (make test)
  • Update the changelog appropriately
  • If making a release, update code.json metadataLastUpdated and bump CHANGELOG.md to next version.

Description

There were four unique changes.

  1. Use the description tag in the json-ld and remove the @context element that 404s. As part of this work, I moved the json-ld generation to a template where it will be easier to adjust content. This required modifying how we generate the json-ld response when the header asks for json-ld.
  2. Add the “data-nosnippet” attribute to the site alert sections.
  3. Remove the forced uppercase for the site type, county, state, and parameter codes in the description.
  4. Use title case for site names. We will start by applying title case to words that do not contain numbers and are more than 2 characters long. I also added a short list of words that should always be lowercase such as 'at'

After making a pull request

  • If appropriate, put the link to the PR in the JIRA ticket
  • Assign someone to review unless the change is trivial
  • Check the accessibility CI step and fix or explain any issues.

Merge request reports