search

bcgov / common-hosted-form-service-techdocs

Technical documentation for the Common Hosted Forms Service (CHEFS).
Apache License 2.0
0 stars 5 forks source link

Added documentation to create a form using JSON with minimum fields. #20

Closed bhuvan-aot closed 8 months ago

bhuvan-aot commented 8 months ago

Added documentation to create a form using JSON with minimum fields.

bhuvan-aot commented 8 months ago

Looks good, just a couple of typo suggestions.

Questions, though:

  • Should we have a standard naming convention for the JSON files?
  • Should we have a standard naming convention for the CHEFS forms?
  • Should we have a standard CHEFS team for the CHEFS form?

Some of these are discussed in #3

WalterMoar commented 8 months ago

Looks good, just a couple of typo suggestions. Questions, though:

  • Should we have a standard naming convention for the JSON files?
  • Should we have a standard naming convention for the CHEFS forms?
  • Should we have a standard CHEFS team for the CHEFS form?

Some of these are discussed in #3

  • I have updated the file names to match naming convention.
  • The form name has the Examlple as prefix, should we have the pipe in the middle, not sure what is the convention.
  • Matt owns the form right now, Is this still a open question on who are form owners?

I'm not sure what the name convention for the forms is - or even if there is one! Once we decide, where would be a good place to document this? Some sort of "style guide" for the docs?

I think some of our current example forms are owned by the previous team. I think there is a lot of cleanup to be done with the old forms, but for this one I guess we should just decide who owns them. We want enough people so that we have coverage when people are on vacation or they leave, but not too many! Again, this is one of those things we need to come up with a standard, document it, and enforce it.