How to give credits

Table of Contents generated with DocToc

• Adding Credits
  • Adding the Credits table to Coursera
  • Adding the Credits table to Leanpub

Adding Credits

Since so many individuals contribute to our courses in so many ways. Thus, we decided to make a table of credits to make it clear who did what. This credit system is analogous to a film credit system where one individual may have had multiple roles, and roles are shown in an order of highest to lowest level of involvement. We also gained inspiration from the CRediT system.

Here is an example:

Please see the about section of the template for descriptions of how credits should be attributed for the course.

This is generated from the About.Rmd file. An About.Rmd file will already be in your course from using our template. You will need to do the following steps to update it for your course:

1. Fill out author names for the various roles where applicable.
2. Delete lines for roles that are not applicable.
3. Make sure roles grammatically match names. If there are multiple people include the "s" in the role name where applicable and remove the parentheses. If only one person is appropriate for a given role remove "(s)" from the role name.
4. Ensure that each row has "|" around each cell value.

Example Table:

The first row and additional rows based on this table should be added and filled in using markdown table format.

|Credits|Names|
|-------|-----|
|Lead Content Instructor|FirstName LastName|

Links to personal websites can be added below the table to make it easier to read.

|Credits|Names|
|-------|-----|
|Lead Content Instructor|[FirstName LastName]|

<!-- Author information -->

[FirstName LastName]: link to personal website

These rows should be included for all courses:

|Template Publishing Engineers|[Candace Savonen], [Carrie Wright]|
|Publishing Maintenance Engineer|[Candace Savonen]|
|Technical Publishing Stylists|[Carrie Wright], [Candace Savonen]|
|Package Developers[ottrpal]|[John Muschelli], [Candace Savonen], [Carrie Wright]|

<!-- Author information -->

[John Muschelli]: https://johnmuschelli.com/
[Candace Savonen]: https://www.cansavvy.com/
[Carrie Wright]: https://carriewright11.github.io/

<!-- Links -->

[ottrpal]: https://github.com/jhudsl/ottrpal

These rows should be added to all Johns Hopkins courses:

|Content Publisher|[Ira Gooding]|
|Content Publishing Reviewer|Ira Gooding]|

<!-- Author information -->

[Ira Gooding]: https://publichealth.jhu.edu/faculty/4130/ira-gooding

Additionally, this row should be added for all ITCR Courses:

|Content Directors|[Jeff Leek], [Sarah Wheelan]|

<!-- Author information -->

[Jeff Leek]: https://jtleek.com/
[Sarah Wheelan]: https://www.hopkinsmedicine.org/profiles/details/sarah-wheelan

Adding the Credits table to Coursera

In Coursera, you can add the credits table URL as an ungraded plugin (the same as described here for adding chapter content). This should be added at the beginning of your course, right after the introduction.

Adding the Credits table to Leanpub

In Leanpub, make sure that your About.md file in your manuscript folder is listed in your Book.txt file and this Credits table will automatically be incorporated into your Leanpub course.