Once you have a transcript and have uploaded a draft to StoryCorps Connect, follow these steps to add it to opensourcestories.org. These instructions assume that you have followed the setup instructions.
-
Fork opensourcestories/opensourcestories.org into your own GitHub account.
- Reminder: When you clone this repository, be sure to get the submodules!
git clone --recurse-submodules --depth 1 https://github.com/opensourcestories/opensourcestories.org.git
-
If you already have a fork, you may want to make sure it is up-to-date.
- There are 3 easy ways to sync your fork
-
We recommend creating a new branch for the new story, but this is optional.
- Details on how to create a branch
To generate a markdown file with the correct front matter, use the hugo command from the root directory:
$ hugo new stories/{year}/{person name}.mdThis will generate a mostly empty markdown file:
title: ""
date:
description: ""
storyteller: ""
storycorps: ''
bio: ""
draft: true
---title: page title
date: autogenerated, but update it with the date that the story was created
description: used for the index page and any social copy
storyteller: the person telling the story
storycorps: the URL https://archive.storycorps.org/embed/{story id}, where the {story id} is the numeric portion of your uploaded StoryCorps interview ID
- For example, click through one of the current Open Source Stories interviews to see the ID field on the interview page, e.g. ID: APP3543191
bio: the 2-3 sentence bio that the storyteller provided
draft: true or false, depending on whether the page is ready for publishing
Under the ---, paste the markdown of the transcript.
Run the local server using the command:
$ hugo server -Dand navigate to localhost:1313 (or whichever port Hugo tells you).
Once you're happy with it, make sure to set the draft to false, and push the changes to your fork. From there, submit a pull request to the base repository!