VA Forms System Core will be a React library hosted in NPM that will allow engineers and designers to easily interact with Forms inside of vets-website.
Define and document the process for handling documentation update requests (add, remove, modify) to the Forms Library help documentation located in the VA Forms Library Overview section of the VA Platform Documentation website.
Make this a lightweight process for how app team engineers can contribute to this documentation.
Stand up content on the main help page with directions to submit request?
If you see something missing, write it up in markdown on a ticket and submit the ticket?
Link checking is important when working with submitted content.
Stand up a GitHub template for doc request submission?
Considerations
How do people notify the team supporting the Forms Library that they have a documentation request?
What does the team supporting the Forms Library do when that request is received?
Are the team members supporting the Forms Library the only people who should make the documentation updates, or should app team members be encouraged to directly update the help docs?
Think about the documentation Robin Garrison recently submitted for the subtask pattern (ticket #544). It isn’t ideal for our engineers to have to add that, but there doesn’t seem like a way to allow non-platform users access to add docs themselves.
Acceptance Criteria
[ ] The process for handling documentation update requests (add, remove, modify) to the Forms Library help documentation located in the VA Forms Library Overview section of the VA Platform Documentation website is documented on a Confluence page in the Forms Library Work Stream section of the FLT Confluence space.
[ ] FLT members have reviewed the Confluence page and provided feedback:
[ ] BJ
[x] Harshil
[x] Karen
[x] Lauren
[ ] All feedback has been addressed.
[ ] Reference to this page has been added to the relevant transition documents (Karen).
These updated pages should be deployed to production as part of the daily deploy on Monday, 9/12. When that is complete, the updated text will appear on these live site pages:
Task Description
Considerations
Acceptance Criteria