Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Technical spike: How will we surface guidance content snippets? #782

Open
CharliePatterson opened this issue Jan 15, 2025 · 1 comment · May be fixed by #818
Open

Technical spike: How will we surface guidance content snippets? #782

CharliePatterson opened this issue Jan 15, 2025 · 1 comment · May be fixed by #818
Assignees

Comments

@CharliePatterson
Copy link
Contributor

CharliePatterson commented Jan 15, 2025

Context:

The redesigned check tool experience includes snippets of guidance content on the issues details page, to surface the relevant piece of content from the guidance to help users understand how to fix the specific issue that the page highlights:


Image ----
  • We've previously discussed one approach to implementing this: the so-called "mini-CMS" approach, where guidance content lives closer to the specifications, and can then be fetched by various applications.
  • This approach is probably too complex for this, though we should consider it alongside any other implementations.
  • In refinement we discussed the possibility of creating a folder with a series of files that contains the content snippets, with each of those snippets mapped to issues or fields from the specification, and having the application pull the relevant data from there. In reality, this might be a lean first iteration towards the goal of having a mini-CMS.
  • The scope of this ticket is to spike out possible approaches, and come up with a list of pros and cons, and rough estimations for each approach, to then be played back to the wider team.
@GeorgeGoodall-GovUk
Copy link
Contributor

Just some initial thoughts from yesterdays away day: can we use the guidance field in the database? if not why? can we argue for this?
would it suit are needs? is it updatable? specifically by our content designers?

@DilwoarH DilwoarH self-assigned this Jan 21, 2025
@DilwoarH DilwoarH moved this from Eng sprint backlog to In Development in Submit and update planning data service Jan 21, 2025
@DilwoarH DilwoarH linked a pull request Jan 22, 2025 that will close this issue
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Development
Development

Successfully merging a pull request may close this issue.

3 participants