Improve the-fair-cookbook deployment strategy

nih-cfde / the-fair-cookbook

NIH CFDE project for creating a collection of FAIRification recipes

https://cfde-published-documentation.readthedocs-hosted.com/en/latest/

2 stars 6 forks source link

Improve the-fair-cookbook deployment strategy #6

Closed u8sand closed 4 years ago

u8sand commented 4 years ago

Based on the work here: https://github.com/yegor256/jekyll-github-deploy -- we can improve the way we deploy the-fair-cookbook drastically.

[x] move files from docs/ to /
[x] eliminate _build / _site files from source branches in repository; they don't belong there
[x] ~~automatically deploy site with travis on master update~~
- Now using github actions
[ ] [HELP NEEDED] configure repo to deploy gh-pages instead of /docs
[x] ~~[HELP NEEDED] authorize travis-ci to access repo for continuous integration~~
- Now using github actions
[x] finish setting up github actions

proccaserra commented 4 years ago

@u8sand thx for looking into this. I was currently looking at deploying a github action instead in order to deal with the automated deployment.

u8sand commented 4 years ago

@proccaserra As long as we don't need to store build files in the source tree and modifying something like a jupyter notebook in master still gets rendered properly -- I'm all for it. The current deploy script properly uses python and ruby environments to ensure all jupyter book extensions function when deploying, while the standard github pages is based only on jekyll. At this point it's just a matter of setting up travis for this to function properly.

u8sand commented 4 years ago

@proccaserra I looked into github actions and it's actually pretty nice. Got it working for this deployment, was simpler than using travis for permissions reasons. All we need to do is change the repository to use gh-pages branch instead of /docs for github pages and this should be good to go.

Is this something you or @ACharbonneau is able to configure?