Spike: capture all Content Build functionality that potentially need to be reimplemented

timcosgrove commented 1 year ago

Description

Content Build does a fair amount of data manipulation and creation of 'pages' that are not directly correlated to CMS nodes. We need to make sure that each of the needs Content Build handles is addressed by Next Build.

Investigate Content Build to find any functions that are not handled solely and strictly by templates. This is intended to be an overview and it is understood that we may potentially find more functionality down the line.

This will include but may not be limited to:

Functionality specific to the Lovell case
Office directory
Outreach assets
Resources & Support section
Environment
Debug information written to templates
Collections
Left rail navigation menu levels
Date to file names?
App assets
Content assets
Breadcrumbs
Rewrite VA domains?
ModifyDOM
- addNonceToScripts,
- processEntryNames,
- updateExternalLinks,
- addSubheadingsIds,
- checkBrokenLinks,
- injectAxeCore,
- addLangToMain,
- forceCorrectAccordionHeaders,
Functionality in filters.js: https://github.com/department-of-veterans-affairs/content-build/tree/main/src/site/filters
Functions present in templates that is not directly associated with Drupal content types, i.e. Analytics

Example locations to look in (there may be others):

Content-build steps: https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/index.js
ModifyDOM plugins: https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/index.js
Filters: https://github.com/department-of-veterans-affairs/content-build/tree/main/src/site/filters
Globally used templates, for example https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/includes/header.html

Acceptance Criteria

[x] List out functionality with links to code implementation and description of its intent
- https://github.com/department-of-veterans-affairs/va.gov-cms/issues/14470#issuecomment-1679500813
[x] Identify scope of the functionality i.e. whether it is specific to one or a few content types or if it is global 'glue' functionality
[x] Identify back-of-napkin level of complexity and effort
[x] If specific teams need to be consulted about functionality, list those teams

Team

Please check the team(s) that will do this work.

[ ] CMS Team
[ ] Public Websites
[ ] Facilities
[ ] User support
[ ] Accelerated Publishing

timcosgrove commented 1 year ago

Analytics also fits in here; look into global templates for pieces of functionality that are not strictly associated with nodes.

timcosgrove commented 1 year ago

Take special note of work here that requires interaction with or work from other teams.

timcosgrove commented 1 year ago

Break up into 5 tickets potentially:

build steps
DOM plugins
filters
templates
detective work

timcosgrove commented 1 year ago

T-shirt sized: this is epic sizing, not sprint ticket sizing.

Needed for Milestone 1

Lovell functionality (XL)
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/drupal/process-lovell-pages.js
- Need ‘link switcher’; see template
- Need to account for side nav issues
- Obviously all the other Lovell functionality eventually; Ryan should be a good resource
- Prioritize things needed to complete News Stories first.
- https://prod.cms.va.gov/help/vamc/creating-content-for-lovell-federal-health-care
- https://dsva.slack.com/archives/C0FQSS30V/p1692036673429439
- https://prod.cms.va.gov/admin/structure/cm_document/note/120/VAMC-Lovell
- Further discussion with Facilities team needed
App assets (S)
- This is just how images/js/css are included from content-build
- Some of this may need to be replicated in Next Build
- Should do a review but honestly if needed for new templates they will be moved into Next Build as that happens.
Content assets (S)
- Assets from vagov-content
- This might ultimately be where some critical assets come from. Need to tabulate and identify what’s here.
Breadcrumbs (L)
- Breadcrumbs.html only for old sites….maybe
- Breadcrumb computation is core functionality but not exposed to json:api natively. Potential modules:
  - https://www.drupal.org/project/decoupled_kit
  - https://www.drupal.org/project/computed_breadcrumbs
- Fair amount of logic hidden here: https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/includes/breadcrumbs.drupal.liquid
Rewrite VA domains (S)
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/rewrite-va-domains.js
- Changes any www.va.gov domain in HTML to point to the local host for the server content build is happening on.
modifyDOM: addNonceToScripts (XS)
- If needed, gets added by next.
- This script also appears to add clickHandlers; investigate
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/add-nonce-to-scripts.js
modifyDOM: updateExternalLinks (S)
- Processes links to other va domains
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/update-external-links.js
- Will need reimplementing
modifyDOM: addSubheadingIds (M)
- https://github.com/department-of-veterans-affairs/content-build/blame/main/src/site/stages/build/plugins/modify-dom/add-id-to-subheadings.js
- Re-add
Filters (L)
- This needs its own epic.
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/filters/liquid.js
Items from Header.html (S-ish)
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/includes/header.html
- IE handling
- layout/path/entityID in head
- Google Tag Manager
- Robots noindex on non-prod
- Polyfills - needed?
- Web components helpers
- Apple icons, favicons, ms application icons
- Fonts
- CSS - basic style.css, content-build.css, specific css for applications
- IE stylesheet, do we need?
- Botframework_cdn?
- Vendor.js
- Js for entries
- Federal analytics js
- focusContent function
- SurveyTools
- Preview: draft indication
- Google_analytics_noscript?
- Skip to content
- Banners
- Skip link focus
- USA website header (part of header)
Items from footer.html (XS)
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/includes/footer.html
- Minimal footer?
- Agency motto (Lincoln to care for him etc)
- Static-page-widgets.js inclusion
- Veteran-banner.html?
- Drupal debug info? Show

Later Milestones

Analytics (L)
- Further discussion with Platform Analytics team
OutreachAssetsData (M)
- Builds data that drives this page: https://www.va.gov/outreach-and-events/outreach-materials/
- Case of needing CMS Data for client-side actions
- https://github.com/search?q=repo%3Adepartment-of-veterans-affairs%2Fcontent-build+outreach&type=code
- Public Websites team
Resources & Support section (M)
- https://www.va.gov/resources/
- Builds out this index page as well as individual paginated listings of the pages by topic
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/create-resources-and-support-section.js
- Could this be Drupal views?
- Public websites team
Debug information written to templates:
- What is useful?
- Currently written:
  - Always: Main layout template
  - Always: nid
  - Debug: https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/add-debug-info.js
  - This is essentially the content data used to generate the page in the first place
  - Think this can be handled by sourcemaps?
- This should really be a kind of research - what do developers want/need out of
modifyDOM: processEntryNames
- Do not understand yet; related to the entry names.
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/process-entry-names.js
modifyDOM: addLangToMain (not needed in this form in Next Build)
- This looks for certain strings in filenames and changes the lang attribute
- May not be needed in new multilingual world
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/add-lang-to-main.js
modifyDOM: forceCorrectAccordionHeaders
- Josh is the best person to speak to this
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/stages/build/plugins/modify-dom/force-correct-accordion-headers.js
Events filters
- Need to look at Events as a whole
- https://github.com/department-of-veterans-affairs/content-build/blob/main/src/site/filters/events.js
Broken links (L)
- CMS Team
- This is a large coordinated effort.

Unneeded functionality

Office directory? Dead product, confirmed
Environment Filter (believe unneeded)
Collections (not needed)
- Honestly not convinced this is used anymore; appears to have to do with creating sidebar menus for items that used to be in vagov-content
- See detail-page.html; believe this is all old. Follow detail-page thread
Left rail navigation menu levels (not needed)
- Appears to be unused; confirmed
dateInFilename (not needed)
- Appears to deal with adding dates from filenames into the meta of the files
- Unused? We barely use metadata
- None of our files match this

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