ubc-library-rc / rc-workshop-template

https://ubc-library-rc.github.io/rc-workshop-template/
MIT License
1 stars 2 forks source link

Add copyright/license statement on GitHub pages sites #7

Open JeremyBuhler opened 4 years ago

JeremyBuhler commented 4 years ago

The rc-workshop-template repository functions as a remote Jekyll theme: changes to _layouts/ affect all Research Commons sites, since the line remote_theme: ubc-library-rc/rc-workshop-template is added to each repo's _config.yml file during setup.

RC sites may have different licenses. To generate site-specific copyright/license statements I added three custom variables to _config.yml

# license information for workshop content
license_name: "Creative Commons Attribution 4.0 International License"
license_url: "http://creativecommons.org/licenses/by/4.0/"
license_image_url: "https://i.creativecommons.org/l/by/4.0/88x31.png"

I updated _layouts/default.html to generate site-specific copyright statements from these variables, adjusting if variables are missing (see c052d75 for initial implementation, refined in d196bc1).

The instructions for creating new sites reflect these changes (6518211). To add a copyright statement to an existing RC site add the block above to its _config.yml file, changing the values if desired.

JeremyBuhler commented 4 years ago

The license_image_url variable calls for a link to a license image. A note in the instructions indicates images should be at most 150px wide, but there are no actual constraints on image size in _layouts/default.html.

It would be good to add something to make sure large images don't affect site formatting.

eugene-barsky commented 4 years ago

So, @JeremyBuhler , how do we ensure that each workshop landing page reflects that Copyright statement? Up to the Team Leads to add?

JeremyBuhler commented 4 years ago

Yes, @eugene-barsky, that was my intention for existing pages. Team leads would update the workshops they're responsible for and I will do the TLEF set. I'll send everyone more detailed instructions by email.

For new sites, the step-by-step instructions for creating a site now include copyright setup: https://ubc-library-rc.github.io/rc-workshop-template/