registry.json guidance

[raudabaugh]

Description

Suggest adding the following text (copied from "Getting Started With the Forms Library" page) to the "Creating a new application" page.

NOTE: If you've already created another form locally there will be a question at the end to Overwrite the existing registry.json file in your content-build repo. We suggest that you use the a option, which will add the new json block at the bottom of the file and not alter your existing form.

Relevant URLs

https://depo-platform-documentation.scrollhelp.site/developer-docs/creating-a-new-application

Which type of team are you on? (Platform team, VFS team, or Leadership)

Benefits

[taylojill]

Hi @raudabaugh - thanks for your content suggestions. The Platform Content team will review your request and put it in our backlog to refine for next steps.

[jknipes]

@raudabaugh if we copy this exact note to the "Creating a new application" page, will the user know what the a option refers to?

[raudabaugh]

It's possible that the references to an existing form might be too specific, since this could apply to non-form applications as well. Definitely open to suggestions!

[jknipes]

@rmtolmach since you have contributed to the Creating a new application page, would you say this suggested text in description could be added verbatim to the page?

[rmtolmach]

@jknipes that might be a better question for someone on the Frontend, but here's my best stab at an answer:

I see that note on this page in the Create a new form application with Yeoman generator section, so my assumpation would be to add the note to this section of the page:

And in reference to Sam's comment about it possibly being too specific, since this could apply to non-form applications as well, it could be slightly changed to this:

NOTE: If you're creating a form and have already created another form locally, there will be a question at the end to Overwrite the existing registry.json file in your content-build repo. We suggest that you use the a option, which will add the new json block at the bottom of the file and not alter your existing form.

I don't LOVE having duplicated text in the docs, because if someone edits one spot, they probably wouldn't know to edit the other spot. But it's not the end of the world! 😄