Why

We need a good environment for testing our gem and documenting its usage. With the right Jekyll site, we can do both. We can have a hosted Jekyll site that shows off the gem, and acts as a great testing ground in development.

How

Create a demo Jekyll site hosted on GitHub Pages with a page that shows off each example and how to use it.
Use the default Jekyll theme for simplicity.
We should utilize a gem convention that imports from github in order to make testing easier. Perhaps a commented ruby gems version, and an uncommented GitHub solution? Or the reverse?

Resources

• Deploy site to GitHub Pages

Right now, this only supports clips, let's expand it to include broadcasts and vods.

Create two GitHub issue templates. A default one, and one for creating new releases. The one for releases should include all the steps associated with releasing a new gem version from CONTRIBUTING.md. The default one just needs a description header and a closes # placeholder for the issue it closes.

• Extract CONTRIBUTING section from README.
• link to the demo site from README
• Add Installation and Troubleshooting guide to demo site
• reverse usage and troubleshooting
• usage should cover what different clips/broadcasts/etc are supported
• explain how Jekyll-Twitch works

Description

The .gitignore was configured for a ruby gem, which means it's missing common Jekyll ignore directories, like .jekyll-cache/Jekyll/Cache .

Tech Plan

1. Remove the offending files/folder
2. Add .jekyll-cache to the .gitignore

References

See GitHub's Jekyll gitignore example

Version 1.0.1 was released October 17th, 2022, but the date on the post is April 23rd, 2021. This was the date version 1 was released. We should fix that. This should update the url as well.

There are two links in the footer of the demo site that link to GitHub and Twitter. The GitHub one should link to this repo, and the twitter one can link to twitter.com/ChaelCodes

Description

The parent url is always 127.0.0.1, and Twitch doesn't recognize that as the location the iframe is embedded in production.

Suggested fix

Description

Jekyll-Twitch is releasing a new version!

• Create a post in docs site with the expected changes
• Update the docs site with the newest version
• Test the changes in the docs site
• Run bundle exec rake release