Skip to content

Guides

Jump to bottom
Elvis Saravia edited this page May 22, 2020 · 18 revisions

On this page, we include our quick guides.

Submitting PR for NLP Newsletter Issue

First, I need to send you an invite to push to the repository. Just send me an email ([email protected]) or Slack message (@elvis) with your GitHub account and I will add you to repo. If I added you as a contributer already, you don't need to request again.

If you would like to be added as an official writer to the publication, I will need the following information from you (replace the items in CAPS):

GITHUB_USERNAME:
  name: NAME
  web: PERSONAL_WEBSITE (OPTIONAL)
  bio: SHORT BIO (OPTIONAL)
  twitter: TWITTER_USERNAME (OPTIONAL)
  instagram: INSTAGRAM_USERNAME (OPTIONAL)
  github: GITHUB_USERNAME (OPTIONAL)

In addition, send me your preferred photo/avatar to appear on the website. Send me the info at [email protected] or via Slack.

If you don't want to include your personal info, then I can just post the translated newsletter under my name and you can skip the steps above.

Submitting the PR

  1. Go to this _posts folder of the website and download the raw .md file corresponding to the NLP Newsletter that you are translating.

  2. You can then edit the .md file locally. These are the changes that you would need to perform:

  • First, rename the .md file to follow this format: YYYY-MM-DD-Title-of-your-translated-newsletter.md
  • Now it's time to edit the .md file
  • If you submitted your personal info above, change the author field value to the GITHUB_USERNAME you provided above
  • Change the title field in the header to your translated title
  • Replace the excerpt field value with "" or you can add your own translation there as well... this helps with displaying things nicely on social media
  • Then you can start to replace the different parts of the newsletter with your own text translations
  • Note that urls or links follow this format [link text](http://url)
  • Since this is a jekyll blog, we need to use \\ to skip a line so keep those where you want to skip a new line
  • For simplicity, reuse the url images that are in the original .md file; this means you don't need to host your own images or upload any to the repository.

  1. Then upload your finished .md file (your translated version) to the repository under that same folder.

  2. When you commit the publication choose the "Create a new branch for this commit and start a pull request" option. We will review it and if all is well, we are ready to put the translation live on the website.

Thanks for contributing to the publication!

Clone this wiki locally