cds-snc / platform-forms-client

NextJS application that serves the public-facing website for Forms
https://forms-staging.cdssandbox.xyz/
MIT License
35 stars 13 forks source link

Plain language guidance on responses -- linking to API docs #4698

Open anikbrazeau opened 1 week ago

anikbrazeau commented 1 week ago

Create high-level guidance page for non-technical audience that links to API documentation

User story

As a form builder, I want to understand what we mean by API delivery so that I can make an informed decision and know what I need to do to get set up with an API integration to retrieve form submissions programmatically.

Context

This guidance should be an entry point to the more comprehensive documentation site: https://cds-snc.github.io/forms-api/.

As part of the self-serve version of the API release, we need to empower people who are not developers with what they need to reach out to developers who can help set them up.

This will also help support direct questions to an up-to-date plain language high-level support article that outlines what's involved for different delivery methods: https://articles.alpha.canada.ca/forms-formulaires/getting-form-responses/

anikbrazeau commented 21 hours ago

Draft: https://articles.alpha.canada.ca/forms-formulaires/using-the-api-to-get-form-responses/