Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 6.53 KB

README.md

File metadata and controls

122 lines (78 loc) · 6.53 KB
Raw

PSYC341OER

Table of Contents

Introduction

The primary goal of project aims to provide an open-source, ever-expanding body of information for PSYC341: Introduction to Memory and Cognition at the University of Maryland, College Park. A secondary goal is to provide these materials for other instructors to easily use/adapt for their own courses. These materials were initially compiled with support from a 2020 Faculty OER Mini-Grant from the Maryland Open Source Textbook Initiative.

This site is hosted via Github, allowing many users to contribute to the main site or to make their own variations. Ideally/eventually, this site will provide a mix of written and multimedia information to encourage learning through several mediums.

This site material itself falls in the Public Domain - i.e., licensed under a Creative Commons Zero v1.0 Universa licensure, however note that most sections are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Contributors

Become a Contributor

GitHub

The current site--called the "repository"--is the center for editing and branching. Changes to the main branch, or the "master" branch, will be pushed to the published site: https://umdoer.github.io/PSYC341OER/.

You do not need a GitHub account to view the published site, however you do need an account to make edits or contributions.

Forking

When editing, you should “fork” to a new, separate, branch. Forking is essentially making a copy, and a local repository of the project is created. Editing your separate branch will not affect the master branch. You will be able to access your site through the URL provided under the "Settings" tab:

For more information on how to fork, click here.

Make any changes in your new, local repository. When you wish to add your changes to the “master branch,” (i.e. the live, published version of the text) you can use a “pull request” to send the edits from your user-owned fork to the original repository, for approval.

Pull Requests

To propose a change without editing directly, you can issue a pull request. This request will allow you to add comments and discuss the changes with collaborators before the edits are published. Anyone can send a pull request, and this request will go to those with write permissions for approval. This way, only approved content will appear on the site.

For more information on how to create a pull request, click here.

Navigating the Repository

The repository is organized into several folders on the main page:

  • _data holds the .nav page, which creates the sidebar of links
  • _pages holds the multiple pages for each subject and is divided by subject
  • _sass holds the _variables page, which dictages fonts and format
  • images holds every image used on the site; it is necessary to upload images here before they can be used

Additionally, there are several lone pages:

  • .gitignore and Gemfile have information about the current theme
  • LICENSE has more information about Creative Commons Zero v1.0 Universa
  • README.md is this!
  • _congig.yml has information on the theme and layout
  • index.md is the main page of the website

Making Changes

Editing in Markdown

Pages that end with .md can be edited using Markdown, an easy way of editing Github pages. Editing in markdown is simple; this page outlines the basics.

Changing the Sidebar

If you want to add or delete a page from the sidebar, follow these steps:

1) Add a page to the _pages folder, or delete the selected page by clicking the trashcan icon in the top right corner:

2) In _data, go to navigation.yml.

Each sidebar is organized in the same format:

For example, here is the beginning of the sidebar for the Sensation and Perception pages:

Which, when published, leads to this:

Therefore, when adding or deleting a page, you must also add or delete the code for that page in the sidebar.

3) If your page is referenced in the Table of Contents on the index.md page, you must add or delete it there.

Adding Images

To add images to your .md page, follow these steps:

1) Upload your image to the images folder.

2) Insert your image using the following format:

  • The figure style can be edited to change the alignment, margins, and size of the photo
  • The img src is the URL, linking to the uploaded photo in the images folder
  • The fig caption refers to the text underneath the photo