NBISweden / canvas-integrations

0 stars 0 forks source link

Re-arrange the repo to hold the CSS / JS for the NBIS account in Studium #4

Open wna-se opened 3 years ago

wna-se commented 3 years ago

We need a place to store the latest version of the custom styles and scripts (CSS / JS) for the NBIS account in Studium and decided to re-arrange this repos to fit that purpose.

When deploying / testing a new version of the styles and scripts and account administrator will upload the new files to a copy of the NBIS account theme to make sure that everything is working properly. If there are issues they would revert to the previous version of the theme. E.g., the theme NBIS_02092021 was deployed to test the Carpentries styles related to NBISweden/GitHub-to-Canvas-integration Issue #2

Example of a repo with a Canvas theme: https://github.com/oxctl/canvas-theme

Canvas also provides a set of legacy styles that have been used for their interface components in the past: https://uppsala.instructure.com/styleguide

We should try not be frivolous with creating new CSS and JavaScript but it might actually be better from a maintenance perspective to create our own than referencing those bundled with Canvas’ interface (since they can change or disappear with new versions).

We could probably set up a GitHub action to bundle a single file each for CSS and JavaScript based on a folder structure in this repo.

mihai-sysbio commented 3 years ago

Sounds great! Suggestion for a GH action: https://github.com/marketplace/actions/minisauras

wna-se commented 3 years ago

I think that GitHub pages might actually be the easiest option with the added benefit of being able to add a preview mode to see the styles and javascript in action.

wna-se commented 3 years ago

I've made a proof of concept available here: https://nbisweden.github.io/canvas-integrations/

Would still need some way of managing and naming releases. Edit: Though this could initially be done using GitHub releases by downloading the combined files and attaching them to a release.