iilab / contentascode

Content as Code
http://iilab.github.io/contentascode
GNU General Public License v3.0
34 stars 7 forks source link

Migrate to scaffold-github-jekyll-travis #23

Closed jmatsushita closed 8 years ago

jmatsushita commented 8 years ago

Related to #15

This repo is currently an implementation of the stack-github-pages approach. Not sure it can be made completely fork and play as it might always require to activate Pages on the github repo.

Moving to the stack-github-jekyll-travis approach will add the following features:

  • Build/CI process! Server side integration tests link link checking #11
  • Notifications of Build success and failure on Pull Requests
  • Build badges

From a DX standpoint, moving to this stack should be as simple as changing branches and merging (and configuring travis). Will open a new issue to track this.

jmatsushita commented 8 years ago

Before doing this I needed to wrap my head around how the tooling's modularity would work which I've done a first pass at in the README.md here https://www.npmjs.com/package/docsmith (no code yet).

jmatsushita commented 8 years ago

Here's a possible path to migrate this repo trying to focus on a DX that would use the docsmith approach.

Start state: the current repo has a stack-github-pages approach which means its docsmith.yml file would be like:

source: .
build: 'github-pages'

If we started from scratch then

Migrating out of the previous stack there should be a way to upgrade to the new stack which should look like either:

source: .
build: 'travis'
jmatsushita commented 8 years ago

Done and merged.