Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversion to Wyam (#3) #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

daveaglick
Copy link

So this looks like a huge change, but like I said earlier it's mainly just moving files around with slight adjustments. I figured the best way to jump off discussing the changes and showing how to do it was just to get a PR in.

Some notes:

  • This uses the Wyam Blog recipe. We could have gone with a custom configuration, but the Blog recipe has all the pipelines we need and it's not just for blogs (the name is a bit of a holdover from when it was simpler).
  • I instrumented the build with Cake - that'll make it much easier to light up the CI/CD with AppVeyor and Netlify (or whichever host). You'll notice the Netlify deployment code is already in the build.cake script at the bottom.
  • It might be worth considering moving to another theme as the site gets filled out. I love the themes at http://html5up.com, and they happen to port to Wyam pretty well. This is probably for another issue, but something to keep in mind.

Anyway, take a look at the changes and we can follow up IRL or in the issue to go over any questions, comments, etc. Easiest thing to understand it all is to pull it down, run it, and look around the file structure.

@daveaglick
Copy link
Author

Yeah...this is probably going to drive Travis nuts 😄

@daveaglick daveaglick mentioned this pull request Jun 7, 2017
5 tasks
@spboyer
Copy link
Contributor

spboyer commented Jun 8, 2017

/font-awesome dir can be removed. resources are now loaded via CDN

@daveaglick
Copy link
Author

@spboyer Looks like the /font-awesome dir is already gone, but there was a Font Awesome Sass file hanging out that I removed.

@SeanKilleen
Copy link
Collaborator

SeanKilleen commented Jun 9, 2017

@daveaglick this is awesome so far, thank you so much! Sorry for the radio silence.

I think I'd still like to host via Github pages, so I'm likely going to modify travis to go to the "gh-pages branch push" route.

So remaining on this PR from my perspective:

  • Pull this and confirm build locally (will do ASAP). This is just to make sure I get what's going on
  • modify the .travis.yml to ensure the site builds correctly and can do the gh-pages push.
  • Restore the gemfile so that gh pages will still think it's building Jekyll for now.

At that point, I can merge this PR and continue with the rest of the steps on #3.

Also 👍 to a better theme; I grabbed the current one reaaaallly quickly. Like, "day of the presentation" quickly. 😄

@SeanKilleen SeanKilleen mentioned this pull request Jun 9, 2017
7 tasks
@daveaglick
Copy link
Author

daveaglick commented Jun 9, 2017

@SeanKilleen No problem - this is OSS after all, stuff gets done when it gets done. There shouldn't be any issues running on an alternate build server or uploading to a different host.

The trick with GH Pages is going to be to commit only the files from the output folder to the GH Pages repository after build. The AppVeyor build script here might provide some help on how to do this. My suggestion is to do something similar, putting the commands in the Cake script and then have Travis execute that specific Cake task to checkout/commit the GH Pages branch. Could also put the git commands right in the Travis Yaml file and skip Cake for that part. May take a little trial and error - GH Pages deployment is dead simple if you use it's built-in CI for Jekyll builds but much more complicated for running the build externally and then uploading.

Once this PR is merged, I'll open an issue for reviewing and selecting a theme.

@SeanKilleen
Copy link
Collaborator

@daveaglick 👍 I agree it'll be harder to get the push right.

From my perspective, this can be merged as long as it builds right. The deployment will then "fail" but the old site will be left up, which should buy us some time to experiment with travis on the gh-pages branch push until it's right, at which point we can merge those and then switch the GitHub pages settings for this repo to pull from that branch.

Looking forward to the trial and error. Worth it to get Wyam into greater usage! I'll likely end up doing a blog post on the conversion in case others are interested.

@SeanKilleen
Copy link
Collaborator

@daveaglick actually, could I ask you to restore the gemfile so that GitHub will still think it's building a jekyll site (and thus fail as I need it to for the next step)?

@daveaglick
Copy link
Author

@SeanKilleen 👍 No problem - went ahead and squashed commits as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants