Skip to content

Latest commit

 

History

History
124 lines (94 loc) · 3.65 KB

README.md

File metadata and controls

124 lines (94 loc) · 3.65 KB
Raw

Open Science MOOC logo

Visit our website to learn more about the project.

Follow @OpenScienceMOOC on Twitter for important announcements or come talk with us on our slack channel.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Altering the module content.

Modules descriptions are rendered from markdown files (here is a useful markdown cheatsheet) located in the _modules folder. The module markdown files are plain markdown file. However, the top of each file contains some YAML data helping to render the content on the website. This YAML lines set the page layout, the title to render, and the icon picture to use on the page.

Here's an example:

---
layout: page
title: "Open Access to Research Papers"
icon: "icons/paper.html"
order: 6
---

How to add a person to be listed/rendered on the website

Currently adding a person involves adding a YAML file in the _data/people folder. Perhaps the easiest thing to do is to copy an existing file, e.g.
chris_madan.yml. In this file, the data is used to define a member profile.

The contact item currently supports:

  • email
  • github
  • impactstory
  • linkedin
  • orcid
  • twitter
  • website

Depending on which team you're in, you can use the following value for the team item:

  • advisors
  • production
  • steering-committee
  • code-of-conduct-committee

Here's an example:

name: Christopher Madan
location: UK
contact:
  email: [email protected]
  github: cMadan
  impactstory: 0000-0003-3228-6501
  linkedin: cmadan
  orcid: 0000-0003-3228-6501
  twitter: cMadan
  website: http://cmadan.com/
team: steering-committee

If you want to add a picture of you, you simply need to add an image in the folder assets/img/people.

The image should be in a JPG format and have the same name as your YAML file in _people (e.g chris_madan.yml -> chris_madan.jpg).

Sponsors

Digital Ocean

License

Content

Unless otherwise stated the content is licensed under the CC-BY-SA 4.0.

Source code

Copyright (C) 2019 OpenScienceMOOC

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.