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

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 196 forks source link

Profile | Update VFS directory #55949

Open andaleliz opened 1 year ago

andaleliz commented 1 year ago

Background

This list of VFS products, and has some profile features are missing (e.g. personal information, military information) and our PM info is out of date. We should make sure info for our products/features are up to date.

Tasks

Acceptance Criteria

### Personal Info
- [ ] create or locate markup page 
- [ ] Follow the onboarding procedure for a new app, which includes using the vets-website generator to create an app directory (this will also create the manifest file & UUID)
- [ ] Isolate that app by moving it into the space created by the generator
### Military Info
- [ ] create or locate markup page 
- [ ] Follow the onboarding procedure for a new app, which includes using the vets-website generator to create an app directory (this will also create the manifest file & UUID)
- [ ] Isolate that app by moving it into the space created by the generator
### Delete Duplicative page
-  [x] Joe had a different recommendation for adding, check if he also has a different recommendation for deleting - (confirmed [here](https://dsva.slack.com/archives/CBU0KDSB1/p1686577818971459?thread_ts=1680098098.808479&cid=CBU0KDSB1))
- [ ] if Get duplicative [VA Profile page](https://depo-platform-documentation.scrollhelp.site/getting-started/va-profile) deleted
Samara-Strauss commented 1 year ago

Just submitted updates for:

Samara-Strauss commented 1 year ago

Submitted an update for notification settings.

Samara-Strauss commented 1 year ago

Shira has asked Holden Hinkle to add pages for Personal info and Military info. Once that's done, I can get the information updated.

Samara-Strauss commented 1 year ago

I'll need @adamwhitlock1 or @tpharrison to help with the following tasks:

Adding pages to the directory

These are directions from Holden on how to add pages for Military information and Personal information to the VFS product directory:

To add a product to directory, a manifest.json file has to be created in the directory where that app lives in vets-website. The daily product directory scan will pick up the new product, add it to the product directory, and create a page for it. Then you can update the fields for each ‘new’ product in the directory.

Your team can use any of the existing manifest.json files in vets-website as a template. Just be sure to create a new UUID v4 for your product; those must be unique.

Deleting the VA Profile page

This VA Profile page shouldn't be in the directory, but I don't want to mess up anything with code on the backend. Obviously, VA Profile is a backend system and not a frontend tool, so Idk why it's getting picked up by the VFS product directory. I'd like to remove it, BUT if it looks like we're going to mess up something, let me know so we can reevaluate this plan.

How to delete something from Holden and Curt:

we do not have a cleanup job that removes products currently. It would manually need to be removed from the JSON file AND the ID would need to be removed from the manifest to avoid it being automatically re-added

Documentation

From Curt:

just a note of caution there’s build implications regarding the manifests and any altering/adding of those probably needs to be handled very carefully. The documentation Holden linked seems to cover what’s necessary

Samara-Strauss commented 1 year ago

OK, my recommendation for any next steps is to regroup with @JoeTice and @holdenhinkle on recommended next steps, @adamwhitlock1 @tpharrison. Joe has some different thoughts on how we should proceed, so you all should chat and come to a consensus on the best way to get pages added for personal info and military info to the VFS directory:

As far as how to get them added - currently we'd advise against creating your own manifests and UUID's for the moment, while this is right and would work - as was touched on, it's worth noting that there are a lot of platform components and mechanisms that rely on the manifest, so if the manifest or the UUID is not put in correctly, it creates a risk of failing builds... (We are going to test this to determine if it's a valid path going forward, but in the meantime, would advise against it)

We'd suggest that if you'd like them to be handled as standalone products, to treat them as such and onboard them through the normal process:

  • Follow the onboarding procedure for a new app, which includes using the vets-website generator to create an app directory (this will also create the manifest file & UUID)
  • Isolate that app by moving it into the space created by the generator

That will get it added to the directory safely