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

Update automated email language about publishing self organized workshops #1791

Closed
maneesha opened this issue Feb 10, 2021 · 13 comments
Closed

Comments

@maneesha
Copy link
Contributor

maneesha commented Feb 10, 2021

The self organized response template says that the workshop will appear on our website in a few hours -- and this is how things used to be.

Current text:

Your workshop has been added to the database and if you provided the URL for your workshop website, it should appear on the website in a few hours.

However, because we now have the public/private status for workshop requests, the workshop will only appear on the website conditionally. I have changed the current text to be

Your workshop has been added to our database. If you provided the URL for your workshop website and consented to having it published, it should appear on the website in a few hours.

Ideally I'd like to have conditional text in the template. I think this is what it should look like but wanted to raise it here before updating (and possibly breaking) the logic in the text. We want to say it will be published if we have a url and status is public.

Thanks for your self-organised workshop submission at {{ workshop.venue }} on {{ dates }}. Your workshop has been added to our database. {% if workshop.public_status == 'public' and workshop.url %} Your workshop will be listed our our website within a few hours. {% endif %}

We know that there are several things to think about when preparing to teach a Carpentries workshop, so we’ve included some reminders below:

{% if not workshop.url %} 
# continue from original
@maneesha
Copy link
Contributor Author

@pbanaszkiewicz Can you verify if the syntax above is correct?

@pbanaszkiewicz
Copy link
Contributor

@maneesha this condition looks okay:

{% if workshop.public_status == 'public' and workshop.url %} Your workshop will be listed our our website within a few hours. {% endif %}

However if you want to capture scenario when user has consented to publicizing the workshop, but didn't provide the URL, then you'll have to extend the conditional with an elif clause.

What I don't understand is this part:

{% if not workshop.url %} 
# continue from original

This doesn't capture {% endif %} and I have hard time guessing what you meant with this condition. Should this appear in case user didn't provide URL and didn't consent to publicizing?

Note: once the wording is changed in the production database, I'd like to update amy/autoemails/fixtures/templates_triggers.json accordingly, so please post here the final template. Thanks in advance!

@pbanaszkiewicz pbanaszkiewicz removed their assignment Feb 14, 2021
@pbanaszkiewicz pbanaszkiewicz added status: needs feedback Getting started Good for new contributors to get started labels Feb 14, 2021
@maneesha
Copy link
Contributor Author

I actually think it may be better to re-write this email allowing for a few conditions. Assigning to myself to come back to.

@maneesha maneesha self-assigned this Feb 19, 2021
@pbanaszkiewicz pbanaszkiewicz added status: needs improvements and removed Getting started Good for new contributors to get started status: needs feedback labels Feb 19, 2021
@maneesha
Copy link
Contributor Author

Here's the final template. I have added a few conditionals around url and public/private status, as well as some changes to make the language flow a bit better. @pbanaszkiewicz can you review the logic?

Hi {{ request.personal }}, 

Thanks for your self-organised workshop submission at {{ workshop.venue }} on {{ dates }}. Your workshop has been added to our database. 

{% if workshop.public_status == 'private' %}
Per your request, we will not be listing your workshop on any of our websites.
{% endif %}

{% if workshop.public_status == 'public' and workshop.url %}
Your workshop should be listed on our website (LINK) within a few hours.
{% endif %}

We know that there are several things to think about when preparing to teach a Carpentries workshop, so we’ve included some reminders below:

{% if not workshop.url %}
**Workshop website:** We’d love to add this workshop's URL to our database. The workshop website is important to our workflows and has many benefits: 
* The information (dates, location, instructors, helpers, etc.) in our database can be pulled directly from the workshop website
* The survey links for learners are automatically generated on the workshop website.  They are located above and within the schedule, and we can provide you with access to the results of these surveys
* The content is customizable. 
{% if workshop.public_status == 'public' }
* Your workshop can be listed in the upcoming workshops on the Carpentries website (LINK)
{% endif %}

If you are still in the process of creating your webpage, here is the [repository template](https://github.com/carpentries/workshop-template) for guidance. Please double-check that you are using the recommended slug format of {% if 'online' in tags %}YEAR-MM-DD-site-online{% else %}YEAR-MM-DD-site{% endif %}.  Please let me know if you have any questions or concerns.
{% endif %}

**Helpers:** If possible, recruit some helpers. Helpers do not have to be affiliated with [The Carpentries](https://carpentries.org/). Being a helper is a great way to introduce others to The Carpentries. In order to assist you in recruiting helpers, we have developed text for you to use to recruit potential [helpers](https://docs.carpentries.org/topic_folders/hosts_instructors/hosts_instructors_checklist.html#helper-checklist). 

**Survey Links:** The learner facing survey links are automatically generated on the {% if workshop.url %}[workshop's webpage]({{ workshop.url }}){% else %} workshop's page {% endif %}. They will be located directly above and within the schedule. You are welcome to share the survey links (located on the workshop webpage) with your attendees whenever the time is right for your workshop. *Please be advised your learners’ anonymous and aggregate responses will be shared with workshop Hosts, Instructors, Helpers, and The Carpentries Core Team for the purpose of understanding the learners experiences, improving future workshops and providing in-depth feedback to allow Instructors to reflect their teaching strategies.* 

{% if "online" in tags %}
* **Online Teaching:** If you plan to teach/host a workshop online please check out our recommendations for online resources in [our handbook](https://docs.carpentries.org/topic_folders/hosts_instructors/resources_for_online_workshops.html). This official set of recommendations will be updated as we receive feedback from the community. We would welcome [any feedback](https://carpentries.typeform.com/to/aXXn4P) you may have after teaching online.
{% endif %}

{% if short_notice %}
Please allow us a few days to get you the links to view the results of the survey.  
Feel free to follow-up if you have any questions or concerns. 
{% else %}
We will send out the links to view the results of the survey approximately 1 week prior to the workshop.
{% endif %}

Please let me know if you have any questions or concerns.  

@maneesha maneesha assigned maneesha and pbanaszkiewicz and unassigned maneesha Apr 2, 2021
@maneesha
Copy link
Contributor Author

Pinging @pbanaszkiewicz Can you take a look at the logic syntax here?

@pbanaszkiewicz
Copy link
Contributor

@maneesha generally looks okay, here's some small issues I found:

  1. line **Survey Links:** The learner ... ends with *.
  2. line **Online Teaching:** starts with * but there's no list around it - I'd guess it shouldn't be a bullet list?

@maneesha
Copy link
Contributor Author

Thanks for catching these @pbanaszkiewicz
I've made the changes below. If it looks good now, I'll copy and paste into AMY.

Hi {{ request.personal }}, 

Thanks for your self-organised workshop submission at {{ workshop.venue }} on {{ dates }}. Your workshop has been added to our database. 

{% if workshop.public_status == 'private' %}
Per your request, we will not be listing your workshop on any of our websites.
{% endif %}

{% if workshop.public_status == 'public' and workshop.url %}
Your workshop should be listed on our website (LINK) within a few hours.
{% endif %}

We know that there are several things to think about when preparing to teach a Carpentries workshop, so we’ve included some reminders below:

{% if not workshop.url %}
**Workshop website:** We’d love to add this workshop's URL to our database. The workshop website is important to our workflows and has many benefits: 
* The information (dates, location, instructors, helpers, etc.) in our database can be pulled directly from the workshop website
* The survey links for learners are automatically generated on the workshop website.  They are located above and within the schedule, and we can provide you with access to the results of these surveys
* The content is customizable. 
{% if workshop.public_status == 'public' }
* Your workshop can be listed in the upcoming workshops on the Carpentries website (LINK)
{% endif %}

If you are still in the process of creating your webpage, here is the [repository template](https://github.com/carpentries/workshop-template) for guidance. Please double-check that you are using the recommended slug format of {% if 'online' in tags %}YEAR-MM-DD-site-online{% else %}YEAR-MM-DD-site{% endif %}.  Please let me know if you have any questions or concerns.
{% endif %}

**Helpers:** If possible, recruit some helpers. Helpers do not have to be affiliated with [The Carpentries](https://carpentries.org/). Being a helper is a great way to introduce others to The Carpentries. In order to assist you in recruiting helpers, we have developed text for you to use to recruit potential [helpers](https://docs.carpentries.org/topic_folders/hosts_instructors/hosts_instructors_checklist.html#helper-checklist). 

**Survey Links:** The learner facing survey links are automatically generated on the {% if workshop.url %}[workshop's webpage]({{ workshop.url }}){% else %} workshop's page {% endif %}. They will be located directly above and within the schedule. You are welcome to share the survey links (located on the workshop webpage) with your attendees whenever the time is right for your workshop. *Please be advised your learners’ anonymous and aggregate responses will be shared with workshop Hosts, Instructors, Helpers, and The Carpentries Core Team for the purpose of understanding the learners experiences, improving future workshops and providing in-depth feedback to allow Instructors to reflect their teaching strategies.

{% if "online" in tags %}
**Online Teaching:** If you plan to teach/host a workshop online please check out our recommendations for online resources in [our handbook](https://docs.carpentries.org/topic_folders/hosts_instructors/resources_for_online_workshops.html). This official set of recommendations will be updated as we receive feedback from the community. We would welcome [any feedback](https://carpentries.typeform.com/to/aXXn4P) you may have after teaching online.
{% endif %}

{% if short_notice %}
Please allow us a few days to get you the links to view the results of the survey.  
Feel free to follow-up if you have any questions or concerns. 
{% else %}
We will send out the links to view the results of the survey approximately 1 week prior to the workshop.
{% endif %}

Please let me know if you have any questions or concerns.  

@pbanaszkiewicz
Copy link
Contributor

@maneesha it's looking good. Don't forget to include the links.

@maneesha
Copy link
Contributor Author

@pbanaszkiewicz Which links?

@pbanaszkiewicz
Copy link
Contributor

@maneesha: there are 2 places with word "LINK" instead of actual link.

Your workshop should be listed on our website (LINK) within a few hours.

  • Your workshop can be listed in the upcoming workshops on the Carpentries website (LINK)

@maneesha
Copy link
Contributor Author

I tried to update the template with the text below but get error (Invalid Django Template syntax.)

Hi {{ request.personal }}, 

Thanks for your self-organised workshop submission at {{ workshop.venue }} on {{ dates }}. Your workshop has been added to our database. 

{% if workshop.public_status == 'private' %}
Per your request, we will not be listing your workshop on any of our websites.
{% endif %}

{% if workshop.public_status == 'public' and workshop.url %}
Your workshop should be listed on [our website](https://carpentries.org) within a few hours.
{% endif %}

We know that there are several things to think about when preparing to teach a Carpentries workshop, so we’ve included some reminders below:

{% if not workshop.url %}
**Workshop website:** We’d love to add this workshop's URL to our database. The workshop website is important to our workflows and has many benefits: 
* The information (dates, location, instructors, helpers, etc.) in our database can be pulled directly from the workshop website
* The survey links for learners are automatically generated on the workshop website.  They are located above and within the schedule, and we can provide you with access to the results of these surveys
* The content is customizable. 
{% if workshop.public_status == 'public' }
* Your workshop can be listed in the upcoming workshops on [The Carpentries website](https://carpentries.org)
{% endif %}

If you are still in the process of creating your webpage, here is the [repository template](https://github.com/carpentries/workshop-template) for guidance. Please double-check that you are using the recommended slug format of {% if 'online' in tags %}YEAR-MM-DD-site-online{% else %}YEAR-MM-DD-site{% endif %}.  Please let us know if you have any questions or concerns.
{% endif %}

**Helpers:** If possible, recruit some helpers. Helpers do not have to be affiliated with [The Carpentries](https://carpentries.org/). Being a helper is a great way to introduce others to The Carpentries. In order to assist you in recruiting helpers, we have developed text for you to use to recruit potential [helpers](https://docs.carpentries.org/topic_folders/hosts_instructors/hosts_instructors_checklist.html#helper-checklist). 

**Survey Links:** The learner facing survey links are automatically generated on the {% if workshop.url %}[workshop's webpage]({{ workshop.url }}){% else %} workshop's page {% endif %}. They will be located directly above and within the schedule. You are welcome to share the survey links (located on the workshop webpage) with your attendees whenever the time is right for your workshop. *Please be advised your learners’ anonymous and aggregate responses will be shared with workshop Hosts, Instructors, Helpers, and The Carpentries Core Team for the purpose of understanding the learners experiences, improving future workshops and providing in-depth feedback to allow Instructors to reflect their teaching strategies.* 

{% if "online" in tags %}
* **Online Teaching:** If you plan to teach/host a workshop online please check out our recommendations for online resources in [our handbook](https://docs.carpentries.org/topic_folders/hosts_instructors/resources_for_online_workshops.html). This official set of recommendations will be updated as we receive feedback from the community. We would welcome [any feedback](https://carpentries.typeform.com/to/aXXn4P) you may have after teaching online.
{% endif %}

{% if short_notice %}
Please allow us a few days to get you the links to view the results of the survey.  
Feel free to follow-up if you have any questions or concerns. 
{% else %}
We will send out the links to view the results of the survey approximately 1 week prior to the workshop.
{% endif %}

Please let us know if you have any questions or concerns.  

@pbanaszkiewicz
Copy link
Contributor

@maneesha there was '%' missing in line {% if workshop.public_status == 'public' }, here's the fixed version:

Hi {{ request.personal }}, 

Thanks for your self-organised workshop submission at {{ workshop.venue }} on {{ dates }}. Your workshop has been added to our database. 

{% if workshop.public_status == 'private' %}
Per your request, we will not be listing your workshop on any of our websites.
{% endif %}

{% if workshop.public_status == 'public' and workshop.url %}
Your workshop should be listed on [our website](https://carpentries.org) within a few hours.
{% endif %}

We know that there are several things to think about when preparing to teach a Carpentries workshop, so we’ve included some reminders below:

{% if not workshop.url %}
**Workshop website:** We’d love to add this workshop's URL to our database. The workshop website is important to our workflows and has many benefits: 
* The information (dates, location, instructors, helpers, etc.) in our database can be pulled directly from the workshop website
* The survey links for learners are automatically generated on the workshop website.  They are located above and within the schedule, and we can provide you with access to the results of these surveys
* The content is customizable. 
{% if workshop.public_status == 'public' %}
* Your workshop can be listed in the upcoming workshops on [The Carpentries website](https://carpentries.org)
{% endif %}

If you are still in the process of creating your webpage, here is the [repository template](https://github.com/carpentries/workshop-template) for guidance. Please double-check that you are using the recommended slug format of {% if 'online' in tags %}YEAR-MM-DD-site-online{% else %}YEAR-MM-DD-site{% endif %}.  Please let us know if you have any questions or concerns.
{% endif %}

**Helpers:** If possible, recruit some helpers. Helpers do not have to be affiliated with [The Carpentries](https://carpentries.org/). Being a helper is a great way to introduce others to The Carpentries. In order to assist you in recruiting helpers, we have developed text for you to use to recruit potential [helpers](https://docs.carpentries.org/topic_folders/hosts_instructors/hosts_instructors_checklist.html#helper-checklist). 

**Survey Links:** The learner facing survey links are automatically generated on the {% if workshop.url %}[workshop's webpage]({{ workshop.url }}){% else %}workshop's page{% endif %}. They will be located directly above and within the schedule. You are welcome to share the survey links (located on the workshop webpage) with your attendees whenever the time is right for your workshop. *Please be advised your learners’ anonymous and aggregate responses will be shared with workshop Hosts, Instructors, Helpers, and The Carpentries Core Team for the purpose of understanding the learners experiences, improving future workshops and providing in-depth feedback to allow Instructors to reflect their teaching strategies.* 

{% if "online" in tags %}
* **Online Teaching:** If you plan to teach/host a workshop online please check out our recommendations for online resources in [our handbook](https://docs.carpentries.org/topic_folders/hosts_instructors/resources_for_online_workshops.html). This official set of recommendations will be updated as we receive feedback from the community. We would welcome [any feedback](https://carpentries.typeform.com/to/aXXn4P) you may have after teaching online.
{% endif %}

{% if short_notice %}
Please allow us a few days to get you the links to view the results of the survey.  
Feel free to follow-up if you have any questions or concerns. 
{% else %}
We will send out the links to view the results of the survey approximately 1 week prior to the workshop.
{% endif %}

Please let us know if you have any questions or concerns.

@maneesha
Copy link
Contributor Author

Finally :-) This has been updated in the admin panel.

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

2 participants