Content Model Documentation into Drupal

[swirtSJW]

Background

User Story or Problem Statement

As a CMS architect I would like to be able to see field uses and instances across the whole CMS.

As a VA employee I would like to have all the data that currently resides in airtable/spec tool in the CMS so I can see it too.

As an engineer I want to no longer have to update the spec tool to get my tests to pass. (tests would be removed) so that I will not longer have collisions on tests that only test to make sure our documentation is updated.

Affected users and stakeholders

• CMS engineers
• Content architects

Hypothesis

A hypothesis may depend on a spike ticket to be completed.

We believe that Drupal should be the source of truth for the content model that is already in Drupal

Assumptions

• Could be done as a contributed module.

(How will these assumptions be validated?)

Acceptance Criteria

• [ ] Add Airtable data to Drupal Module
• [ ] Create storage entity that is scalable
• [ ] Requires KB article update

Change management triage

The change represented by this user story will:

• [ ] Be a site-wide change to appearance or key functionality (such as log-in process)
• [ ] Be a specific change that requires more than 30 minutes of work by a user to meet a publishing requirement
• [ ] Remove a piece of functionality (such as restricting editing functions, or “hardening”)
• [ ] Require action by some or all users by a specific deadline
• [ ] Change the front end and be highly visible to the public
• [ ] Noticeable performance improvements (publishing speed, predictability)

If you selected an item above, use the Change Management Runbook to create a CM epic and associated tickets.

If you did not select an item above, update issues/PRs in GitHub but don’t plan for change management.

Design principles

Veteran-centered

• [ ] Single source of truth: Increase reliability and consistency of content on VA.gov by providing a single source of truth.
• [ ] Accessible, plain language: Provide guardrails and guidelines to ensure content quality.
• [ ] Purposely structured content: Ensure Content API can deliver content whose meaning matches its structure.
• [ ] Content lifecycle governance: Produce tools, processes and policies to maintain content quality throughout its lifecycle.

Editor-centered

• [ ] Purpose-driven: Create an opportunity to involve the editor community in VA’s mission and content strategy goals.
• [ ] Efficient: Remove distractions and create clear, straightforward paths to get the job done.
• [ ] Approachable: Offer friendly guidance over authoritative instruction.
• [ ] Consistent: Reduce user’s mental load by allowing them to fall back on pattern recognition to complete tasks.
• [ ] Empowering: Provide clear information to help editors make decisions about their work.

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. - [ ] `Program` - [ ] `Platform CMS Team` - [ ] `Sitewide Crew` - [ ] `⭐️ Sitewide CMS` - [ ] `⭐️ Public Websites` - [ ] `⭐️ Facilities` - [ ] `⭐️ User support`

[EWashb]

Identify roadmap and flesh out tickets. Create a discovery ticket as a first step.

[swirtSJW]

As an aside, this epic will render the following tickets obsolete and they can be closed

• 11938

• 9497

• 8586

[EWashb]

removed the sprint label since this is an epic

[swirtSJW]

Issues are now sorted in priority order.

[EWashb]

@swirtSJW thank you for your work on this. I went ahead and removed your assignment at the epic level and I have it on tap to bring into refinement tomorrow.

[swirtSJW]

The fieldhelptext module has a neat ability to bulk edit all field labels and help text either as a single bundle or across all/select field instances

Saving this as a not to circle back to this for possible inclusion as a feature.

[davidmpickett]

@EWashb @BlakeOrgan - Just chatted with @swirtSJW and discussed adding some UX tickets to this epic. First one might be a UX review of the new interfaces created:

• Content Model Fields view
• Content Model Document Entity edit view