Update header / footer product documentation to cover technical behaviors

jilladams commented 1 year ago

Existing Documentation

https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/header-footer/engineering

Description

This will be done as a follow on to the new Federal Header/Footer work. (1/24/2024)

The Design System team is interested in potentially owning the Header and Footer as a design system component. If that transition takes place, we need to evaluate what other functionality is hidden in the Header / Footer and either needs to be mitigated or transitioned to that team.

In general: we should also have these things documented re: state of what is true today, even if no transition.

User story

Describe the audience/user, enhancement or fix, and value / outcome desired.

AS A(N) Design System owner I WANT to understand the scope of the current header/footer functionality SO THAT I can effectively support these products moving forward.

AS A(N) Product owner I WANT to have accurate documentation of the technical behaviors of the header / footer SO THAT teams can effectively support these products moving forward.

Engineering notes / background

Areas we already know of:

Injected header / proxy-rewrite app
Drupal SSOT data loading (including #13185)
Sign in modal - ownership outside PW, etc.
Veterans Crisis Line modal
Header menu populated by Drupal
Footer menu not yet populated by Drupal, BUT footer menus are created in Drupal, just not yet integrated

Existing docs:

https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/header-footer -- this should be the final home of all documentation
https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/public-websites/header - this should move into the path above, not urgent or an AC, but just a flag: don't add on in this location

Acceptance criteria

[ ] Header code has been reviewed for any functionality happening that is not immediately visible from the front-end
[ ] Footer code has been reviewed for any functionality happening that is not immediately visible from the front-end
[ ] Findings are documented in this ticket

FranECross commented 3 weeks ago

@jilladams I think this ticket is redundant/a dupe of the header/footer ticket you and Randi have been reviewing/updating. If true, we can close this one.

jilladams commented 3 weeks ago

Good catch! If you don't mind, let's leave it open -- I haven't updated #18866 to rescope that beyond just the injected header, so this ticket will actually be handy to cover the rest of the docs review. I'll update to reflect I've already gotten started.

jilladams commented 1 week ago

Help I need from @randimays :

[x] https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/header-footer/engineering - technically true?
- [x] Make sure the data origin / local storage is documented

randimays commented 1 week ago

@jilladams Updated https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/header-footer/engineering 👍🏻

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