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

Migrate to scaffold-github-jekyll-travis #23

Closed
jmatsushita opened this issue Feb 23, 2016 · 3 comments
Closed

Migrate to scaffold-github-jekyll-travis #23

jmatsushita opened this issue Feb 23, 2016 · 3 comments

Comments

@jmatsushita
Copy link
Member

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:

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
Copy link
Member Author

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
Copy link
Member Author

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

  • Click based: forking the contentascode/site template should allow to get started immediately.
  • CLI based: using a docsmith init site should create the site scaffolding in the current directory.

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

  • Click based: Not sure its possible unless editing the files from the github editor.
  • CLI based: docsmith install build travis should do the migration which are what the manual steps do:
  • Manually:
    • Changing the docsmith.yml file manually to:
source: .
build: 'travis'
  • Adding a default .travis.yml file.

@jmatsushita
Copy link
Member Author

Done and merged.

@jmatsushita jmatsushita changed the title Migrate to scaffold-github-jekyll-travis Migrate to scaffold-github-jekyll-travis Mar 14, 2016
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

No branches or pull requests

1 participant