search

bids-apps / bids-apps.github.io

This BIDS Apps website has now been integrated to the BIDS website: https://github.com/bids-standard/bids-website.git
Other
3 stars 14 forks source link

CI: iterate with circleci until it works #58

Closed sappelhoff closed 2 years ago

sappelhoff commented 2 years ago

closes #46

preferably fixed and merged before #54 so that we can better judge the impact of changes

the CI works, but the website is slightly weird:

  1. there is no "landing page" I could point to
  2. when building locally, and when looking at the CI output, it seems like CSS is missing ... but in the GH pages output, this is fine. -- probably something is wrong with the paths.
Remi-Gau commented 2 years ago 
1. there is no "landing page" I could point to

That is fixable

2. when building locally, and when looking at the CI output, it seems like CSS is missing ... but in the GH pages output, this is fine. -- probably something is wrong with the path

Not sure if this is doable with jekyll (that github pages uses in the background).

I think that jekyll serve takes care of linking the html and the css.

Remi-Gau commented 2 years ago

I wouldn't be opposed to changing the entire website to a very straight forward template that contains a good documentation. We have minimal needs and I feel like the current structure is overly complicated

I actually think that most templates will bring even more stuff to be honest.

sappelhoff commented 2 years ago

I think that jekyll serve takes care of linking the html and the css.

true ... when running bundle exec jekyll serve it works as expected. Whereas opening the html files in a browser after bundle exec jekyll build does not work :thinking:

Not sure if this is doable with jekyll (that github pages uses in the background).

it works on https://github.com/bids-standard/bids-website/ -- so I think we are just missing something here.

EDIT: however, this resource seems to say that you are right: https://talk.jekyllrb.com/t/index-html-in-site-folder-does-not-show-style/6069

just not sure why bids-website works then ...

I actually think that most templates will bring even more stuff to be honest.

okay, maybe I should just dig a little deeper into general jekyll docs then.

sappelhoff commented 2 years ago

EDIT: however, this resource seems to say that you are right: https://talk.jekyllrb.com/t/index-html-in-site-folder-does-not-show-style/6069

see also https://stackoverflow.com/q/27438937/5201771

just not sure why bids-website works then ...

I think it's because the css is linked like this: https://github.com/bids-standard/bids-website/blob/d880eb8e31de3f31c21df334943bda4ef0626990/_layouts/default.html#L68

instead of like this (as here): https://github.com/BIDS-Apps/bids-apps.github.io/blob/dc3d3a45086847e8390ad3cc68cb58bd350866f7/_includes/head.html#L35

(note the baseurl variable ...)

Anyhow -- I tried several things and couldn't get this to work. I give up for now. All I want is that we can get a neat preview in a PR of what the website looks like with the changes.

Perhaps I should try out netlify? Any experience with that @Remi-Gau?

https://docs.netlify.com/site-deploys/deploy-previews/

Remi-Gau commented 2 years ago

Perhaps I should try out netlify? Any experience with that @Remi-Gau?

https://docs.netlify.com/site-deploys/deploy-previews/

That's what the OHBM OSSIG website used but I feel that maybe then swtiching to another template that will render things properly could be an option.

All in all I don't think this is super urgent in any case because it is not like this website gets updated daily.

So I am also fine leaving this one open until we have the patience to get back to it.

sappelhoff commented 2 years ago

but I feel that maybe then swtiching to another template that will render things properly could be an option.

I also think so

All in all I don't think this is super urgent in any case because it is not like this website gets updated daily.

agreed

So I am also fine leaving this one open until we have the patience to get back to it.

I think I'll revert the non-functional circleci stuff and close this then :-) it was worth a try