Explain missing associated entity better

[Ben-Hodgkiss]

Missing associated entity is our most commonly misunderstood task. We should research how we can make this more clear to users.

In general, we should consider whether we should host the relationship diagram on C&P Issue Details (or pull from the spec) as this is often helpful to users when they get in touch via Jira.

Specifically, for plans,the issue pages for the plan datasets aren't pulling in the guidance. We should figure out how we can do this so it assists LPAs.

e.g. https://provide.planning.data.gov.uk/organisations/local-authority%3ASTH/plan-timetable/missing%20associated%20entity/plan

[pooleycodes]

Content to be designed by @paris-dp on the correct information required for this task, with a tech approach then to follow from a Dev.

[paris-dp]

spoke with @oli-rose-mhclg around the design challenge we are facing- we will find the tech spec link and explore content to better explain what the user needs to do.

[paris-dp]

Specification with diagram showing relationship between plan and plan timetable datasets is here

Additional context- we think that the problem with pulling a useful snippet of guidance is due to there being one spec/guidance page for multiple datasets. The scope of this ticket is to design how we would like it to look in this instance, and then we can write up another ticket to fix this across plan data.

[oli-rose-mhclg]

Updates to the publish your plan data guidance:

---

Updates to the how to fix this issue section:

How to fix this issue

Your data is missing a ‘plan’ field.

This is the unique reference for your overall plan. For example:

• LP-BRX-2024
• barnet-local-plan-2021-2036
• hertfordshire-minerals-and-waste-plan
• essex-minerals-plan
• essex-waste-plan
• county-durham-supplementary-plan

The ‘plan’ field in your plan timetable dataset must match the ‘reference’ field from your plan dataset.

Image alt text: This diagram shows the relationship between the plan dataset and the plan timetable dataset. The reference value from your plan dataset needs to match the plan value in your plan timetable dataset. This is so that we can match your timetable to the right plan.

How to improve your data

1. Make changes to fix this issue using a spreadsheet or other editing software.
2. Check your data to find out if it is ready to publish.
3. Publish your updates at your endpoint URL.

---

Error summary:

15 'plan' fields do not match the 'reference' field in the plan dataset

Error message:

'Plan' field does not match the 'reference' field in the plan dataset

[paris-dp]

Work required and sequencing

• Proposed changes to plan guidance have been sent to the policy team (not contentious, expecting support with this)
• Make changes to plan guidance
• Work out tech approach to pulling guidance snippets from plan guidance and the dataset relationship diagram for guidance
• Make changes to error message as missing associated entity does not seem meaningful to the user

I will schedule some design time with Matt and Oli to discuss

[paris-dp]

Designers and devs met to discuss.

• Content amends to guidance are awaiting a final sign off then amends can be made
• We walked through approach and rationale
• Dataset relationship image can be found in the spec here: https://digital-land.github.io/specification/specification/plan/