Skip to content

Add a Tech Talk

Jeff Fredrickson edited this page Jan 12, 2018 · 18 revisions

The Tech Talk content is stored in a data file: /_data/techtalks.yml. Any time you want to add or edit a Tech Talk, the techtalks.yml file is the place to go.

Adding a Tech Talk

  1. Create a feature branch based on the master branch. Prefix it with your initials, followed by _, and then a brief summary of the change, e.g., sc_new-techtalk (see branching tutorial).
  2. Make the following changes in your feature branch, not on master:
    1. Edit /_data/techtalks.yml.
    2. Copy and paste the entry for the previous Tech Talk to create a new entry at the top of the file.
    3. Edit the new entry you just created to add details on the upcoming Tech Talk.
    4. Make sure the slides: line is an empty value.
    5. Enter the URL to the registration form on the register: line.
    6. Commit the feature branch
  3. Preview your changes at https://federalist.18f.gov/preview/gsa/cto-website/BRANCH_NAME/ (where BRANCH_NAME is the name of your feature branch, e.g., sc_new-techtalk)
  4. Open a pull request to merge the feature branch to master (see pull request tutorial).

Updating a Tech Talk

Typically, after a Tech Talk concludes, we remove the registration form link and add the slides from the Tech Talk.

  1. Create a feature branch based on the master branch. Prefix it with your initials, followed by _, and then a brief summary of the change (e.g., sc_update-techtalk). View this tutorial for help in creating branches on GitHub.
  2. Make the following changes in your feature branch, not on master:
    1. Navigate to the Tech Talks assets folder (assets/downloads/techtalks). Then click the Upload button to upload the slides in PDF format. The file name should begin with tech-talk and then include the title of the talk. There should be no spaces in the name, use hyphens instead (e.g., tech-talk-data-science.pdf). Copy the name of this file to your clipboard. You will need this in the next step.
    2. Edit /_data/techtalks.yml.
    3. Remove the registration URL from the register: line.
    4. Enter the file name for the slides PDF on the slides: line. prefix it with /assets/downloads/techtalks/ (e.g., /assets/downloads/techtalks/tech-talk-data-science.pdf).
    5. Commit the feature branch
  3. Preview your changes at https://federalist.18f.gov/preview/gsa/cto-website/BRANCH_NAME/
  4. Open a pull request to merge the feature branch to master (see pull request tutorial).