Investigate how DS team can be notified and view community space submissions

[robertjmccarthy]

What

Investigate how the MoJ Design System team can be notified that a new component has been submitted to the community space, and how the team can view the submission and related assets. This investigation is to include how the team can be notified, and view, that an addition has been submitted to an existing component in the community space.

Submissions to the community space will be through a form on the MoJ Design System documentation website.

Share findings and suggestions with the team working on the community space.

Why

When a component is to be submitted to the community space, the MoJ Design System team will need to (a) review the submission, and (b) upload the submission to the community space on the MoJ Design System documentation site. To do both of these tasks, the MoJ Design System needs to be notified when a submission has been made and be able to view the submission and related assets.

Who needs to be involved

• Developer (leading)
• Interaction Designer (supporting)
• Content Designer (supporting)

Done

When findings and suggestions are shared with the team working on the community space to inform the work to develop a contribution form.

[jbarnardmoj]

I looked into using notify for sending the team email when a submission has been made. We will want to add a URL or link to a file to enable the team to see the details of the submission via the email.

For example a link to a page or (perhaps simpler) a link to a file with the submission details.

[jbarnardmoj]

Notify email allows an attached file to be a maximum of 2mb and has a restriction on file type (so no zip files and certainly no code extensions).

This leads us to likely want to include a link to a downloadable file rather than send an attached file.

We could store the submitted assets in a database or S3 and allow a download.

S3 would be a simpler option for storage and retrieval could be direct or indirect via our backend.

We would have to consider how we could control access to downloadable assets.