Skip to content
This repository has been archived by the owner on Feb 12, 2021. It is now read-only.

Latest commit

 

History

History
72 lines (57 loc) · 4.94 KB

README.md

File metadata and controls

72 lines (57 loc) · 4.94 KB
Raw

Goodbits Templating Bot

Helps you to get the Goodbits newsletter for The Ember Times 🐹 ready on a Friday afternoon 🌇 or night 🌙

Setup

  • Clone this repo
git clone [email protected]:ember-learn/emberjs-times-tools.git
  • cd ember-times-tools
  • nvm use if you want to use the LTS version of Node, that we have tested
  • yarn install
  • set the GOODBITS_USER_EMAIL and GOODBITS_USER_PASSWORD env variables in e.g. your ~/.bashrc (ping @jessica on the Ember Community Discord for the credentials):
// .bashrc
export GOODBITS_USER_EMAIL="goodbits-bot-email-address"
export GOODBITS_USER_PASSWORD="goodbits-bot-password"
  • reload the settings in your current terminal tab
source ~/.bashrc

How to Use

  • get a hold of the latest blog post url, e.g. https://www.emberjs.com/blog/2018/11/16/the-ember-times-issue-73.html
  • finally run the script and pass in the url pointing to the latest blog post:
node create-goodbits-template.js --botemail="$GOODBITS_USER_EMAIL" --botpassword="$GOODBITS_USER_PASSWORD" --botblogurl="https://www.emberjs.com/blog/2018/11/16/the-ember-times-issue-73.html"
  • use the --debug=true for development and debugging 💛
  • review 👀 and feel free to improve the template at Goodbits - this tool isn't perfect (see Troubleshooting Goodbits below!), but tries its best to help with the mundane copy-pasta work ✍️
  • Goodbits creates "phantom" issues, so verify that the email subject matches the # of the issue we are sending.
  • Send a test email to yourself, and verify that emojis display correctly (there is a difference in Goodbits.io and your email, e.g. Gmail).
  • schedule the newsletter for 2pm PST (https://everytimezone.com/#2018-12-21,600,b8jj) and celebrate your support for The Ember Times this week.✨ Thank you! ❤️

Troubleshooting Goodbits

  • Many emojis appear fine on goodbits.com, but don't work when you send to email such as Gmail. Always send a test email and check the emojis there!
  • If there are bullets or numbered lists, remove any blank line between regular non-bulleted text & first line of bulleted text
  • If there is code block text (three backticks), consider manually deleting the copied over code block in the Goodbits editor. Instead, you can try simply copying and pasting the code block from the blog URL.
  • If there is quoted text > quote here, remove the line on the left hand side, convert to plain text (I do this in Gmail Compose WYSIWIG), an pasted italicize in Goodbits WYSIWIG instead. Quotes appear to look fine on goodbits.com, but they just looks strangely indented when you send a test email.
  • Should be covered by ember-times-tools bot, but if not do double curlies manually: {{ must be written as {{ opening_double_curly() }}, and }} as {{ closing_double_curly() }}.
  • No double curlies {{ in Titles. Causes the word within double curlies to not appear at all, or sometimes causes a 500 error.
  • If there are buttons, add manually. Delete the button in text and change to Content > Button in Goodbits.
  • If there are images, e.g. contributor interview images, change "Display as" dropdown to "Article" in Goodbits and manually upload the image
  • Getting a 500 on goodbits.io? It may be because of a rogue double curly {{ or }}, which must be written as {{ opening_double_curly() }} or {{ closing_double_curly() }}.
  • To add a gif, manually add an image instead of the typical "title and text" article, then upload the gif. Can link to the gif's URL on the blog e.g. https://blog.emberjs.com/images/blog/2020-03-13/ember_twiddle_preview-df7f432d.gif from The Ember Times Issue #139.

Twitter howto

  • Post tweet on Tweetdeck to post on Monday (second day of #engagement)
  • Set $natural reminder on Discord, for example:

$natural on December 23th at 2:00pm send post tweet 2 news & announce @Alon (if you're avail!) :newspaper2: to #support-ember-times

  • Use one emoji for each line item as a bullet point
  • Try to @ or hashtag when appropriate

dev.to howto

  • Copy raw from GitHub, delete top YAML portion.
  • Delete READMORE
  • Delete any alex-ignore or markdownlint-ignore
  • Delete any italics classes such as <span style="font-style: italic;"></span>. Normal <em> or *italicizeme* markdown doesn't work in /ember-blog right now.
  • Double curlies {{ in links will sometimes give you a liquid error. e.g. in this example, just deleted the double curlies- [No Implicit This or {{foo}} to {{this.foo}} Codemod](https://github.com/ember-codemods/ember-no-implicit-this-codemod)
  • Check for weird line breaking. We can fix this with stricter markdownlint but it was a bit cumbersome for blog writers!
  • Add canonical URL and series name (The Ember Times should come up)
  • Delete inline code and add body image for Readers' Questions image manually https://github.com/ember-learn/ember-website/blob/master/public/images/tomsters/officehours.png