awebpodcast/README.md

2.2 KiB

Running Locally

  1. Install dependencies: npm install
  2. Start Gulp for asset compilation: gulp
  3. In a new terminal window, start the server: docker-compose up
  4. Open http://localhost:1313 in a browser

Edit the .scss and .js files in the /src directory (NOT in /static).

Adding new episodes

  1. docker exec awebpodcast_hugo_1 hugo new episodes/201X-XX-XX-SXXEXX-episode-title-here.md

You can create this file by hand in the filesystem, but the above command will use the archetypes/episodes.md template to populate all the necessary front matter, saving you precious, precious time.

Adding new pages

This probably won't happen often, but if needed, run:

  1. docker exec awebpodcast_hugo_1 hugo new somepage.md

Pushing to dev

  1. Push your changes to the dev branch: git push origin my-branch-name:dev
  2. Test on https://dev.awebpodcast.org

Pushing to stage

Any merge to the master branch will automatically update the staging site:

https://stage.awebpodcast.org/

A notice will be posted in #irlpodcast-notify on Slack when the push has completed.

Pushing to production

Episode deployments typically happen at 6AM PT on the publish date. Please post in #a-web-podcast-page (private channel) on Slack.

It is responsibility of the person who codes the episode to find someone to push if 6AM PT is too early for them. All members of MozMEAO are happy to do this.

  1. Verify all is good on the staging site
  • If the episode was merged before the publish date it will not be visible on staging. You can see it on staging by either re-running the Jenkins job (if you have permission) or by merging a new pull request. If there are no reviewed pull requests that are ready you can submit one that changes the publish date to 1 minute earlier.
  1. Make sure your local master branch is up to date
  2. Push the master branch to the prod branch: git push origin master:prod

A notice will be posted in #irlpodcast-notify on Slack when the push has completed.

Kudos