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

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
99 stars 69 forks source link

Keep It Simply Static Data #8198

Open swirtSJW opened 2 years ago

swirtSJW commented 2 years ago

Background

As a CMS developer working with external teams I need a way to share time synced data with external resources so that Web Apps can have reliable access to data that is managed by the CMS.

image

Affected users and stakeholders

This initial build will directly support the following

However, this data model has the capacity to support many more products, including our own CMS content-releases.

Hypothesis

Slides: History of needing KISS but not having it Diagram

We believe this architecture is a simple and reliable solution for delivering time synced data to multiple consumers and at the same time, supporting the concept of open data.

Assumptions

Acceptance Criteria

Design principles

Veteran-centered

Editor-centered

Runbook

## Labels (You can delete this section once it's complete) - [x] Issue type (red) (defaults to "Epic") - [ ] CMS subsystem (green) - [ ] CMS practice area (blue) - [x] CMS workstream (orange) - [ ] CMS-supported product (black) ### CMS Team Please check the team(s) that will do this work. - [ ] `CMS Program` - [x] `Platform CMS Team` - [ ] `Sitewide CMS Team ` (leave Sitewide unchecked and check the specific team instead) - [x] `⭐️ Content ops` - [ ] `⭐️ CMS experience` - [ ] `⭐️ Offices` - [ ] `⭐️ Product support` - [ ] `⭐️ User support`
EWashb commented 1 year ago

@jilladams can I remove the sitewide label on this?

jilladams commented 1 year ago

That may be a question for @swirtSJW & @ryguyk ? Looks like Kev originally added it, maybe with the idea that Sitewide CMS is the owner of this kind of high level data system?

Ryan did implement the basics on behalf of a Public Websites project, but it's a sort of independent structure that can be extended for other things, afaik.

EWashb commented 1 year ago

@swirtSJW do you have any insight on this?

ryguyk commented 1 year ago

@EWashb Part of this having been implemented by me on behalf of the Public Websites team was - even at the time - a sort of interesting thing. It is very arguably not a Sitewide responsibility, but we needed it and implementing it within the context of the first use case seemed appropriate.

I have no complaints with the Sitewide label being removed. That said, I'm curious if there are plans to do more with this in the near future, or if there is something else triggering the proposed cleanup. I'm happy to help in either case in any way I can.

Thanks!

EWashb commented 1 year ago

@ryguyk just cleaning up, and no other reason to be asking these questions. I may just icebox this for now and we can leave it as is.