2022 Q3 Console UI - Implement Planned Console Features from other Teams

lhelmer commented 2 years ago

Problem Statement

The Platform teams that are building functionality for the Console need our team's support. We also need to identify what features should be built next.

How might we

implement features created by other teams on the Console to address BE engineer pain points?
help Platform teams finish the functionality they are building in Q3 and identify additional features to be built in the near future?

Hypothesis or Bet

This will bring new features onto the Console, increasing the number of tasks that VFS teams can complete in one place.

By conducting primary research with VFS backend engineers and implementing features currently planned to address the needs of Console users, we will be able to simultaneously (1) provide functionality for users in the immediate term and (2) identify features to be built that will address VFE BE engineers' biggest pain points.

We will know we're done when... ("Definition of Done")

[x] We have conducted 6 interviews with backend engineers and identified features that need to be built to enable a selection of VFS BE engineer tasks The following features have been implemented in the Console (minimally the dev environment):
- [x] Virus scanning API (catalog entry with documentation, dependencies, etc.) This will take you directly to the catalog page for the Virus Scan API entity
- [x] Sidekiq UI link with SSO Sidekiq will be in the "Links" section in the lower left.
- [x] Datadog will be on the plugins tab in the upper right, there is still a CSP issue for embedding we have contacted DOTS regarding.
- [x] Sentry Upper right in the plugins tab
- [x] Grafana lower center of the page, "Dashboards"... underwhelmed by this plugin
- [x] GitHub API Requests plugin to monitor how many requests the Console UI uses Goes direct to the plugin we wrote, alleviates concern of RTT that system will exhaust GitHub API requests.
- [x] Platform Teams' Health Metrics dashboards (at their request) On the "Links" section we do have links out to Datadog health metrics like VSP - Breakers
- [x] Usability testing with 3-5 backend engineers on ability to locate and use features: Related issues #820 & #597

NOT in scope

Keycloak off-boarding plugin - AMT
File upload (IET)
PG Hero link with SSO (IET dependency)
Console Services plugin (TBD)
Keycloak onboarding plugin - AMT

Known Blockers/Dependencies

The most significant risk of not being able to deliver the services and features that VFS or Platform engineering teams are integrating into the Console UI is that their schedule doesn't permit a timely delivery of the expected deliverable. For example:

The Integration Experience Team (IET) is responsible for implementing the Virus Scan Service API. If they cannot produce the component and API documentation and identify the teams that would benefit from their new service, the Console UI won't be able to demonstrate any benefit for proliferating documentation and onboarding developers to new services.
AMT is responsible for providing the Access Management System (AMS) that authenticates users into tools like Sidekiq UI and PG Hero. If they cannot complete this authentication integration, the user experience will not seem unified.
If teams providing performance or health metrics are unable to provide a way to link to, embed, or otherwise expose Platform metrics to us, then the utility of the Console UI will not be able to include Analytics.

Projected Launch Date

There is no expected launch date to support, but there may be launch dates for Platform Development teams launching their services to the Console MVP.

jchapin commented 2 years ago

[x] https://github.com/department-of-veterans-affairs/platform-console-ui/issues/201 @ActualAbby here is the issue referred to as "Sidekiq UI link with SSO @pjholyoke". Probably the key thing that Peter needs to find out is... Which teams want to link from their project to SidekiqUI... Is it a VFS team whose app triggers background processing jobs? Is it the team that wrote the API that files those jobs? or probably... Both.

jchapin commented 2 years ago

"1-2 additional SSO links to VFS tools" - Per the above ticket... PGHero is a maybe.

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