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.

Sign up for GitHub

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

Jump to bottom

[Emails] Display variables available in the context for every signal #2482

Closed
pbanaszkiewicz opened this issue Jul 21, 2023 · 0 comments · Fixed by #2491
Closed

[Emails] Display variables available in the context for every signal #2482

pbanaszkiewicz opened this issue Jul 21, 2023 · 0 comments · Fixed by #2491
Assignees
@pbanaszkiewicz

Comments

@pbanaszkiewicz
Copy link
Contributor

As a user I want to be able to see what variables, and with what type, are available in the email template body context.
@pbanaszkiewicz pbanaszkiewicz self-assigned this Jul 21, 2023
@pbanaszkiewicz pbanaszkiewicz mentioned this issue Jul 21, 2023
Merged
6 tasks
pbanaszkiewicz added a commit that referenced this issue Jul 26, 2023
@pbanaszkiewicz
[#2482] Add context dict types
6fa8f86
pbanaszkiewicz added a commit that referenced this issue Jul 26, 2023
@pbanaszkiewicz
[#2482] Add context type param to signals
c1c0b63
pbanaszkiewicz added a commit that referenced this issue Jul 26, 2023
@pbanaszkiewicz
[#2482] Type hints for contexts, correct type in controller
290d5c4
pbanaszkiewicz added a commit that referenced this issue Jul 26, 2023
@pbanaszkiewicz
[#2482] Add context type annotations to the detail views for template…
9d299f7 
… and scheduled email
pbanaszkiewicz added a commit that referenced this issue Jul 26, 2023
@pbanaszkiewicz
[#2482] Display documentation links for variables used in template co…
717c754 
…ntext
@pbanaszkiewicz pbanaszkiewicz mentioned this issue Jul 26, 2023
Merged
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Add context dict types
78fa603
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Add context type param to signals
c32ae29
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Type hints for contexts, correct type in controller
eaa26d5
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Add context type annotations to the detail views for template…
1dda5fb 
… and scheduled email
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Display documentation links for variables used in template co…
5542caa 
…ntext
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Rework all signals list
68dd496
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Find signal by name
33fce35
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Move find_signal_by_name to utils
785b589
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Update signals tests: add missing context_type param
c125a0a
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Test find_signal_by_name
8e9f7cd
pbanaszkiewicz added a commit that referenced this issue Jul 28, 2023
@pbanaszkiewicz
[#2482] Test model_documentation_link
bce3659 
Using mocks was necessary because with
metaprogramming Django changes
Model.__class__ to ModelBase and therefore
(only in these tests!) it wasn't possible to use
Person or other models.

A trick was to use MagicMock with `.__class__.__name__`
attribute overwritten.
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Add context dict types
3aa0cf9
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Add context type param to signals
8ab31c1
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Type hints for contexts, correct type in controller
6aea3f8
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Add context type annotations to the detail views for template…
1b6a6d8 
… and scheduled email
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Display documentation links for variables used in template co…
c7e7c3a 
…ntext
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Rework all signals list
2335dcf
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Find signal by name
a3229dc
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Move find_signal_by_name to utils
1a578de
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Update signals tests: add missing context_type param
225e368
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Test find_signal_by_name
4d83dbb
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Test model_documentation_link
1fba999 
Using mocks was necessary because with
metaprogramming Django changes
Model.__class__ to ModelBase and therefore
(only in these tests!) it wasn't possible to use
Person or other models.

A trick was to use MagicMock with `.__class__.__name__`
attribute overwritten.
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Extend detail views tests with annotations
449e668
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Change EmailTemplateUpdateForm to disable signal name modific…
22dd902 
…ation
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Add template variables preview to email template update and s…
ea35868 
…cheduled email update views
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] No variables preview for when creating an email template
4d5f649
pbanaszkiewicz added a commit that referenced this issue Aug 5, 2023
@pbanaszkiewicz
[#2482] Update some docs and tests before getting ready for review
3658ed7
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Remove template variables from scheduled emails
2222b49 
They aren't used in this layer.
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Update verbiage
3d019ad 
Updated sections containing variables available in template body.
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Add context dict types
11cd532
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Add context type param to signals
481ba7e
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Type hints for contexts, correct type in controller
e734b8c
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Add context type annotations to the detail views for template…
2af4603 
… and scheduled email
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Display documentation links for variables used in template co…
56b10d3 
…ntext
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Rework all signals list
08219b6
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Find signal by name
00df760
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Move find_signal_by_name to utils
1992059
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Update signals tests: add missing context_type param
538e387
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Test find_signal_by_name
168b0f9
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Test model_documentation_link
f304425 
Using mocks was necessary because with
metaprogramming Django changes
Model.__class__ to ModelBase and therefore
(only in these tests!) it wasn't possible to use
Person or other models.

A trick was to use MagicMock with `.__class__.__name__`
attribute overwritten.
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Extend detail views tests with annotations
45acd9e
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Change EmailTemplateUpdateForm to disable signal name modific…
8b577e8 
…ation
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Add template variables preview to email template update and s…
9a95ed2 
…cheduled email update views
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] No variables preview for when creating an email template
09dbaaf
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Update some docs and tests before getting ready for review
7389593
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Remove template variables from scheduled emails
0ea4baa 
They aren't used in this layer.
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Update verbiage
cb98109 
Updated sections containing variables available in template body.
pbanaszkiewicz added a commit that referenced this issue Aug 11, 2023
@pbanaszkiewicz
[#2482] Update context tests
ec11712
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pbanaszkiewicz pbanaszkiewicz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Emails] Template context variables documentation links carpentries/amy
1 participant
@pbanaszkiewicz