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

Allow List Syntax in Attention Block #181

Open
4 tasks
k-macmillan opened this issue Nov 5, 2024 · 1 comment
Open
4 tasks

Allow List Syntax in Attention Block #181

k-macmillan opened this issue Nov 5, 2024 · 1 comment

Comments

@k-macmillan
Copy link
Member

k-macmillan commented Nov 5, 2024

User Story - Business Need

Services would like to use a list in "personalisation" to be within a code/attention block. The use of lists in this way is not currently supported according to Portal usage, but we do have API support to allow a list passed in the request to become a bulleted list in the email. This feature was not 100% ready for services to use, this is to close the loop and make it Production ready.

  • Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a service using VA Notify
I want to use a list to generated a bulleted list within a code block
So that I can simplify templates

Additional Info and Resources

Slack conversation

Example template:

 ^ ##__ Submission details__
 ^
 ^ __Additional forms included__
 ^ ((forms_submitted))
 ^
 ^

forms_submitted and files_submitted should be within a code block but they are being excluded from the code block:
Image

It appears the ^ is not being applied to each bullet point added.

Acceptance Criteria

  • Lists submit inside a code block (denoted with ^) have the entire list inside a code block
  • Update API docs (schema/swagger/postman)
  • This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

Permutations of code blocks and lists.

Out of Scope

Updating Portal documentation
Collaboration with Portal is happening in parallel and the documentation will be updated after this is functional in the API.

@mjones-oddball
Copy link

@k-macmillan to add an AC regarding the API doc update needed

@kbelikova-oddball Can you find the corresponding Notify Exp ticket for the portal documentation updates? I think Kyle referred to it as advanced usage. Dave would like that ticket linked in the out of scope section so we know where that work is happening.

Additional note from Dave:

In addition we'll want to think about change management/announcement of this functionality to existing customers if this is a feature others need/want beyond the current VA.gov request.

I think above should happen after the portal updates are made so folks have clear instruction on how to use this in the template and API request.

CC @davidconlon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants