HealthBioscienceIDEAS / microscopy-novice

https://healthbioscienceideas.github.io/microscopy-novice/
Other
1 stars 0 forks source link

Evaluate PR lesson previews via circle #12

Closed dpshelio closed 9 months ago

dpshelio commented 10 months ago

Definition of done

Evaluate the possibility to build the lesson and display it on circle-ci. Example: gh pages for this org

milanmlft commented 10 months ago

Alternative to watch out for: previews may be coming to GitHub Pages soon as well 👀 Though currently still in alpha and not available to general public...

milanmlft commented 10 months ago

I've looked into using CircleCI, but it might be overkill. Especially because {sandpaper} has its own CI deployment functionality for deploying to GitHub Pages, which we would need to rewrite for CircleCI...

In addition, {sandpaper} provides its own form of PR previews which shows you what has changed in the built markdown files. Although it doesn't provide a preview of the full website, it gives you a nice diff view of any changes (which I would say is more useful to review content changes, instead of scrolling through a new version of the website). I created a mock PR to show what this looks like: #13

To preview any layout changes to the website, I would suggest just building it locally. That being said, if the GitHub Pages preview feature ever gets released (see my previous comment), that could be implemented in a way that fits more nicely with the {sandpaper} workflow.

@dpshelio, @K-Meech thoughts?

K-Meech commented 10 months ago

Thanks for looking into this @milanmlft ! I'd agree that CircleCI is probably overkill - I think the sandpaper PR previews + building locally should be more than enough. The Github Pages preview feature looks interesting - definitely worth looking into if it gets released!

davecash75 commented 10 months ago

Hi @milanmlft - I agree that this will cover the content, which is the main things we will want to check. I guess if we have things that we think might affect the look and feel of the website, like the branding changes, then we might want to build locally to test. DC

MonikaSvata commented 9 months ago

@davecash75 to review if circle is still intended to use.

MonikaSvata commented 9 months ago

Closing as circle is not needed.