diff --git a/README.md b/README.md index aacfadc5d..74e508cd5 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ It is designed to be embedded in the frontend of a digital service and provide a ## Demo of DXT -TODO: Link to CDP exemplar +If you are within the Defra network, [see a live demo](https://forms-engine-plugin-example-ui.dev.cdp-int.defra.cloud/example-form). + +If you aren't within the Defra network, [see our example UI and run it locally](https://github.com/DEFRA/forms-engine-plugin-example-ui). ## Installation diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 4df24b681..a96d754e0 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -102,11 +102,39 @@ await server.start() ## Step 3: Handling static assets -TODO +1. [Update webpack to bundle the DXT application assets (CSS, JavaScript, etc)](https://github.com/DEFRA/forms-engine-plugin-example-ui/pull/1/files#diff-1fb26bc12ac780c7ad7325730ed09fc4c2c3d757c276c3dacc44bfe20faf166f) +2. [Serve the newly bundled assets from your web server](https://github.com/DEFRA/forms-engine-plugin-example-ui/pull/1/files#diff-e5b183306056f90c7f606b526dbc0d0b7e17bccd703945703a0811b6e6bb3503) + +DXT plans to prefix to these asset paths to prevent collisions with your assets. Contact [#defra-forms-support](https://defra-digital-team.slack.com) if this is a blocker for you. ## Step 4: Environment variables -TODO +Blocks marked with `# FEATURE: ` are optional and can be omitted if the feature is not used. + +```shell +# START FEATURE: Phase banner -- supports `https://` and `mailto:` links in the feedback link +FEEDBACK_LINK=http://test.com +# END FEATURE: Phase banner + +# START FEATURE: DXT -- used if using DXT's infrastructure to store your forms and file uploads +MANAGER_URL=http://localhost:3001 +DESIGNER_URL=http://localhost:3000 +SUBMISSION_URL=http://localhost:3002 + +# S3 bucket and URL of the CDP uploader. Bucket is owned by DXT, uploader is your service's URL. +UPLOADER_BUCKET_NAME=my-bucket +UPLOADER_URL=http://localhost:7337 +# END FEATURE: DXT + +# START FEATURE: GOV.UK Notify -- used if using DXT's default GOV.UK Notify email sender +NOTIFY_TEMPLATE_ID="your-gov-notify-api-key" +NOTIFY_API_KEY="your-gov-notify-api-key" +# END FEATURE: GOV.UK Notify + +# START FEATURE: Google Analytics -- if enabled, shows a cookie banner and includes GA on the cookies/privacy policy +GOOGLE_ANALYTICS_TRACKING_ID='12345' +# END FEATURE: Google Analytics +``` ## Step 5: Creating and loading a form @@ -120,8 +148,4 @@ These files are called `Form definitions` and are built up of: - `conditions` - used to conditionally show and hide pages and - `lists` - data used to in selection fields like [Select](https://design-system.service.gov.uk/components/select/), [Checkboxes](https://design-system.service.gov.uk/components/checkboxes/) and [Radios](https://design-system.service.gov.uk/components/radios/) -The [types](https://github.com/DEFRA/forms-designer/blob/main/model/src/form/form-definition/types.ts), `joi` [schema](https://github.com/DEFRA/forms-designer/blob/main/model/src/form/form-definition/index.ts) and the [examples](test/form/definitions) folder are a good place to learn about the structure of these files. - -TODO - Link to wiki for `Form metadata` - -TODO - Link to wiki for `Form definition` +To understand the full set of options available to you, consult our [schema documentation](https://defra.github.io/forms-engine-plugin/schemas/). Specifically, the [form definition schema](https://defra.github.io/forms-engine-plugin/schemas/form-definition-v2-payload-schema). diff --git a/docs/PLUGIN_OPTIONS.md b/docs/PLUGIN_OPTIONS.md index f5ef14dd2..405809514 100644 --- a/docs/PLUGIN_OPTIONS.md +++ b/docs/PLUGIN_OPTIONS.md @@ -15,7 +15,7 @@ The forms plugin is configured with [registration options](https://hapi.dev/api/ ## Services -TODO +See [our services documentation](./features/code-based/CUSTOM_SERVICES.md). ## Custom controllers diff --git a/docs/features/code-based/PAGE_VIEWS.md b/docs/features/code-based/PAGE_VIEWS.md index 8d471dfca..c02b5d6c0 100644 --- a/docs/features/code-based/PAGE_VIEWS.md +++ b/docs/features/code-based/PAGE_VIEWS.md @@ -1,8 +1,7 @@ # Templates and views -## Extending the default layout - -TODO +> [!NOTE] +> DXT currently handles the page layout internally within the plugin and cannot be customised. We plan to offer this customisation as a feature, please contact us on Slack if this is urgent for you. To override the default page template, vision and nunjucks both need to be configured to search in the `forms-engine-plugin` views directory when looking for template files.