OpenCilk / www.opencilk.org

OpenCilk's new website in development
https://www.opencilk.org
MIT License
5 stars 5 forks source link

Acknowledge Intel and CilkArts #62

Closed behoppe closed 2 years ago

behoppe commented 2 years ago

Issues Much of our content comes courtesy of Intel + CilkArts, but does not acknowledge that.

Improvements When appropriate, the page template should include a standard acknowledgment. Something like "This work is a derivative of Cilk Plus documentation, used with permission of Intel Corporation and Cilk Arts."

Additional discussion One way to implement is with a front matter flag like

acknowledge: true

If the field is not set, then no acknowledgment appears. If the field is true, then a default acknowledgment message appears. If the field is set to something else, then that something else is printed as a customized acknowledgment.

behoppe commented 2 years ago

I updated the page layouts (pages and posts) to check for a front matter field attribution, and if it's true then display metadata.attribution.cilkplus. That is a field in metadata.json and right now it's

This work is derived from Cilk Plus documentation with permission of Intel Corporation and Cilk Arts.

I also updated config.yml for Netlify CMS so that every collection provides a true-false field that is labeled "Provide attribution to Intel and Cilk Arts."

Because of our current GitHub workflow, the attribution field only works for articles that come from the main branch after this commit was added. Other PRs that were branched prior to this change will have the CMS field but will not display the attribution message until after they are merged with main.