Git Product home page Git Product logo

research-teaching-companion's Introduction

The Making and Knowing Project: Research and Teaching Companion

https://cu-mkp.github.io/research-teaching-companion/

Webpage content and navigation for the Making and Knowing Project's Research and Teaching Companion (RTC), built on the Hugo framework.

For Making and Knowing Editors, see also Publishing to the RTC.

Contributing

Content pages are stored in the content/ directory. Each content page is a Goldmark-flavored Markdown (.md) file. To contribute to the site content, you may edit the Markdown files directly, or add new ones. The page's URL will be determined by its location in the folder structure.

Front matter

At the top of each Markdown file is metadata called "front matter", separated from the rest of the file by three dashes (---) on either side. The following front matter information will be used by the site:

  • title populates the heading/banner at the top of the page, and if the page will appear in the top navigation, this value will appear there as well.
  • menu indicates which, if any, menu(s) the page should appear in.
    • Currently, the only supported values are "main" (the top navigation that appears on every page) and "resources" (the buttons that appear on the homepage and the Resources page to link to the available resources).
  • weight determines the order of the page in a menu.
    • Higher values are "more" weight, which means the item "falls" to the bottom of the list, and lower values are "less" weight, which means the item "floats" to the top of the list. A bit counter-intuitive, but the items that should appear first should have lower numbers.
  • draft indicates whether or not this page should be public (false) or hidden (true).
  • slug determines the page's URL, but this will be generated automatically so there is no need to provide it unless you wish to override the generated URL.

Other front matter metadata, such as tags, date, and author, may be used in the future, but will currently be ignored.

Content text

After the front matter, the rest of the page must be formatted as Goldmark-flavored Markdown. Markdown Guide provides a handy guide for the Markdown syntax supported by Goldmark.

Headings of levels ## Two and ### Three will populate the table of contents on the left side of each document. Headings of level two will also have a thin horizontal rule beneath them.

Images, documents, and other media

All non-markdown media should be placed in the static/ directory. For ease of use, it is currently structured as two folders: img for images, and documents for all other media (e.g. docx, pptx, pdf).

These work differently from the other internal links. Instead of the ref tag, just use normal Markdown link or image syntax, treating static/ as the base of the URL. It is important that each URL includes a leading slash. For example:

![stucco-molded](/images/stucco-molded.jpg)
[PDF (student handout)](/documents/pdf/stucco_assignment_student-handout.pdf)

Links to resources and content in this repository

  • make sure you include the full filepath, starting from either /static/ or /content/
  • make sure to include a leading /
    • RIGHT: /resources/activity-sheets/activitysheet_jasper/
    • WRONG: resources/activity-sheets/activitysheet_jasper/
  • for markdown pages, do not include .md, but do include a trailing /
    • So resources/activity-sheets/activitysheet_jasper.md becomes /resources/activity-sheets/activitysheet_jasper/
    • RIGHT: /resources/activity-sheets/activitysheet_jasper/
    • WRONG: /resources/activity-sheets/activitysheet_jasper.md
  • for static resources, include the file extension and do not include a trailing /
    • RIGHT: /documents/pdf/activitysheet_Jasper_preparation-of-horn.pdf
    • WRONG: /documents/pdf/activitysheet_Jasper_preparation-of-horn.pdf/

Links to other pages (i.e., .md files under content/):

[Making Varnishes](/resources/activity-sheets/activitysheet_varnishes/)

[Digital Project](/resources/digital/EXAMPLEPAGE/)

[Bibliography](/resources/reflection/bibliography/)

[Student Project - Alberts](/resources/student-projects/fa21_alberts_naomi_final-project_ph-lesson/)

[Syllabus SP23](/resources/reflection/syllabi/syllabus_sp23_gu4962-hands-on-history/)

Links to pdfs, handouts, etc (i.e., files under static/):

[pdf example](/documents/pdf/activitysheet_Jasper_preparation-of-horn.pdf)

[docx example](/documents/docx/activitysheet_Jasper_preparation-of-horn.docx)

Images:

![jasper-part3](/images/jasper-part3.png)

For more information about internal links, see the Hugo documentation on Links and Cross References.

_index.md pages

There is a special kind of page at the root of each subfolder called _index.md. This represents the category root and can be used to list all the subpages. In RTC, we use them for three purposes:

  1. Display the homepage (content/_index.md)
  2. List the subpages of the "Resources" page (content/resources/_index.md) and indicate where the "Resources" page should appear in the main menu
  3. Display content that should appear at the root of the "Activity Sheets" and "Student Projects" folders (the _index.md in each of those folders)

To achieve the RTC structure, there is a rule in place that these pages will only show a list of their subpages if:

  1. they are not the homepage AND
  2. they are a top-level category

In other words, only the "Resources" page currently matches that description. A developer may change this rule in the file themes/rtc/layouts/_default/list.html.

Publishing

Every time changes are pushed to the main branch, a GitHub action will execute and publish content to the gh-pages branch. Make sure not to modify or remove this branch.

Development

Requirements

Commands

hugo server

Run this command to serve the site over localhost, with hot-reloading.

hugo

Run this command to build the static site and output into the public/ directory.

Theming and templates

The custom theme is based on the Edition 640 theme and is composed of Go Templates HTML and SASS-flavored CSS. It can be edited in themes/rtc/, under layouts/ for Go Templates/HTML and assets/scss/ for CSS. See Hugo documentation on templating for more information.

NOTES from NJR+THC about building site on NJR's WSL (2024-07-17)

  1. git pull
  2. rm -rf public/ to clear anything in the public/ directory [[we have tested this -- without wiping this directory first, the build takes MUCH longer]]
  3. hugo
  4. aws s3 sync ./public/ s3://teaching640-dev/ --delete to push build to the bucket in AWS S3 of teaching640-dev which is now routing to teaching640.makingandknowing.org

research-teaching-companion's People

Contributors

ps2270 avatar njr2128 avatar thuchacz avatar tcatapano avatar sjpitman avatar blms avatar tillmanntaape avatar caro27 avatar lydiadef avatar

Watchers

Nick Laiacona avatar  avatar  avatar

research-teaching-companion's Issues

Syllabi - Convert all pre-2021 Syllabi

Convert all Syllabi (use only "Web" versions of syllabi) before 2021 to pdf, docx, and potentially markdown or html (NJR and THC will work on this through pandoc)

Reflections on Hands-On - Web Page

Introduction - Reflections on Hands-on Teaching and Learning

Why engage in Hands-on activities?
Our philosophy and skills
Videos
Lectures, links to our reflections on hands-on teaching
List of articles (from M&K website)

RSA 2020: panels - (presented in virtual RSA 2021) we may be able to use these as they are - 4 panels of papers

Gather publications, lectures, or other products produced by the project - include them here

Using M&K Resources - Web Page

Courses taught by collaborators using Making and Knowing Project Teaching resources
LANDING PAGE TEXT:
The Project has many collaborators in piloting their material
Sample syllabi
sample student projects
Collaborator videos

Lesson Plan - Varnish making

Syllabi - Web Page Introduction

Web PAGE TEXT -possible text
Syllabi are for inspiration, suggesting readings, modeling integration of hands-on activities with discussion
Student projects
The Making and Knowing Project taught hands-on courses from 2014. [from About pg] Where students in the course Craft and Science: Making Objects in the Early Modern World, taught 2014-18, conducted text-, object-, and laboratory-based research that resulted in essays included in the edition, our students in Making and Knowing in Early Modern Europe: Hands-On History, taught since 2021, explored Secrets of Craft and Nature to create projects—involving all kinds of research—that extend the content of the edition in creative and sometimes surprising ways. Our syllabi for courses that integrate methods and tools of digital scholarship provide information about minimal computing and the open access technology that underlie the edition and our digital publication tool, EditionCrafter.
These syllabi are provided for inspiration, to suggest readings and model the integration of hands-on activities with substantive discussion of relevant texts. Student projects from 2021-2023 for each semester are linked to suggest possible student projects

Add RSA 2022 digital video?

For the RSA 2022 digital conference, we gave a xoom workshop about teaching with the DCE and/or M&K methods. This included: Pamela Smith, Naomi Rosenkranz, Sofia Gans, Tianna Uchacz, Tillmann Taape, Clement Godbarge.

We have permission from the RSA to share. Do we want in the RTC?

If it is to be added to the RSA, we would need:

  • permission from participants
  • captioning
  • add to M&K's vimeo
  • add description

Web Page - change names of buttons

The 6 buttons on the Web Page should be retitled:
Making & Knowing Syllabi [naming protocol: syllabus]
Using M&K Resources [naming protocol: casestudy]
Lesson Plans for Hands-On [activitysheet]
Reflections on Hands-On [reflection] NEW
Student Projects [project]
Digital Fr. 640 [digital] NEW

commission videos from collaborators

Brief that PHS sent to collaborators:

You have all done pilot classes that incorporated M&K activities, and we'd love to include in the RTC short videos from you that record your thoughts about hands-on work in the classroom.
Some of you--Sofia, Monique, Tianna--have given talks at RSA and HSS meetings that would be perfect for this purpose, so if you could record yourselves (by zoom?) giving those talks, they would be a wonderful addition to the RTC!
Or, if you preferred, the video could just include you talking about the experience of doing hands-on activities -- the merits, challenges, pitfalls, whatever!
I hope you might be able to find time to do this and that it doesn't seem too onerous - I know how busy you all are!
We imagine that these videos would include the following (among whatever else you would want to include):
Who you are (and what did you teach)?
What hands-on activities did you do? Any from the Edition?
Challenges?
How did students react?
What difference did doing hands-on activities make to the course, the educational experience (from your perspective and your students' perspectives)?
If possible, it would be wonderful if you could include in your video (by powerpoint presentation or whatever) some photos of the class, the students (if you have permission from the students to record their faces), and the students' work.
These videos would be published (likely on the landing page of the RTC)

Asked:

  • Christina Neilson -- will do as a conversation with students
  • Sofia Gans -- version based on presentation for RSA digital 2022
  • Monique O'Connell -- will start in April
  • Vera Keller -- will work with students
  • Tianna Uchacz -- ways she has adapted for her VIZ students

create standards and protocols for adding and editing resources

Based on M&K's sandbox protocols, but THC and NJR need to adapt.

Some notes from NJR&THC:

From NJR & THC & CMS: Video considerations:

  • Formats, standards, and protocols

  • For syllabi:

  • Collaborator videos

    • Hosting and streaming (we are using a commercial service - Vimeo - what happens if they go away?)
    • Proliferate across services: Flickr, Youtube, Vimeo, look into AWS self-streaming options(?)
    • Think about cost and maintenance of this
    • Archiving
      - Eg through Academic Commons (what we have done for the lab tour playlist) - but need CU Libraries
      - https://academiccommons.columbia.edu/doi/10.7916/d8-8r5c-2564
    • Zenodo? Does not have a player but can archive
    • Formats
    • Captioning - time-consuming!
    • Other ADA compliance and accessibility concerns?
    • Are there any permissions or consent/contributions considerations?

Using M&K Resources - Videos

Videos by collaborators - QUESTIONS:
Collaborator videos (see below)
From NJR & THC & CMS: Video considerations:
Hosting and streaming (we are using a commercial service - Vimeo - what happens if they go away?)
Proliferate across services: Flickr, Youtube, Vimeo, look into AWS self-streaming options(?)
Think about cost and maintenance of this
Archiving
Eg through Academic Commons (what we have done for the lab tour playlist) - but need CU Libraries
https://academiccommons.columbia.edu/doi/10.7916/d8-8r5c-2564
Zenodo? Does not have a player but can archive
Formats
Captioning - time-consuming - collaborator videos
Other ADA compliance and accessibility concerns?
Are there any permissions or consent/contributions considerations?

Digital Fr. 640 - Web page

Catapano, Rosenkranz essay
Godbarge essay
Digital SYLLABI
student projects
Github repos
Link to sandbox
Link to EDITIONCRAFTER HERE?
DCC - digital competency calculator

review publishing-to-rtc.md

@tcatapano and @ps2270, I have edited our publishing-to-rtc.md doc to act as a sort of styleguide for our work. My goal is that everyone can use this as a reference doc as they are working, and a cheatsheet for the markdown styling they might need.

Can you look over and see if there's anything that is glaringly missing?

Syllabi - Decisions and Instructions for proofreading and revising

Decisions:

  • are we creating web pages or leaving as downloadable GD (no!) or pdfs?

When we make that decision, instructions will follow
If we revise extensively, then
Link to the resulting Edition essays and student projects on older syllabi
Link interconnected material in Edition (ie, syllabi that use assignment sheets - link to the assignment sheets)

add content from sandbox to rtc

move over all

  • student projects
  • assignment sheets
  • presentations & resources
  • collaborator pilot courses
  • Assessment and Evaluation Tools

Lesson Plan - Sugar casting

Not sure this should be a lesson plan, or simply a link to the following, noting the difference in results!
Durkin, Celia and Pamela H. Smith. “Molding Fruits and Animals in Sugar.” In Secrets of Craft and Nature in Renaissance France. A Digital Critical Edition and English Translation of BnF Ms. Fr. 640, edited by Making and Knowing Project, Pamela H. Smith, Naomi Rosenkranz, Tianna Helena Uchacz, Tillmann Taape, Clément Godbarge, Sophie Pitman, Jenny Boulboullé, Joel Klein, Donna Bilak, Marc Smith, and Terry Catapano. New York: Making and Knowing Project, 2020. https://edition640.makingandknowing.org/#/essays/ann_017_sp_15. DOI: https://www.doi.org/10.7916/sc91-ay82
AND
https://oberlin.digication.com/audrey-libatique-ingenious-making/casting-sugar

See also: Sugar Casting Assignment (Klein, Sept. 17, 2014)

tasks for today

  • new buttons
  • index pages (putting new content)
  • index pages (reformatting the link syntax and frontmatter)
  • check if all migrated pages from sandbox need frontmatter
  • populate project board

Web Page - Add Buttons

Add 2 additional buttons
Reflections on Hands-On
Digital Fr. 640

The 6 button on the Web Page are:
Making & Knowing Syllabi
Using M&K Resources
Lesson Plans for Hands-On
Reflections on Hands-On
Student Projects
Digital Fr. 640

Naming Protocols for RTC Sections

Also to be found here:
Making & Knowing Syllabi [naming protocol: syllabus]

Using M&K Resources [naming protocol: casestudy]

Lesson Plans for Hands-On [activitysheet]

Reflections on Hands-On [reflection]

Student Projects [project]

Digital Fr. 640 [digital]

create domain name for the rtc

ideas:

  • edition640companion.makingandknowing.org
  • rtc640.makingandknowing.org
  • companion640.makingandknowing.org
  • teaching640.makingandknowing.org

DECISION: teaching640.makingandknowing.org

add example resources

Add some of the pages from M&K's sandbox that are discussed in Resources, eg syllabus for HIST GR8906, a few student projects, activity sheets, etc

Missing markdown files

  • burnsalve.md
  • breadmolding-assignment.md
  • painting-assignment.md
  • verdigris-assignment.md
  • pigment-madder-lake_assignment.md
  • dyes-assignment.md
  • su21_branscum_elizabeth_final-project-medicinal.md
  • su21_fox_mackenzie_final-project-disorganization.md
  • su21_macomber_sophie_final-project-figures.md
  • su21_christensen_anna_final-project-natural-things.md
  • fa21_ghoneima_hana_final-project-oral-culture.md
  • fa21_coutavas_allie_final-project-reds.md
  • fa21_jacobson_beah_final-project-know.md
  • fa21_lin+sundar_danli+anusha_final-project_regimens-remedies.md
  • fa21_weisgall_benjamin_final-project-architecture-workshop.md
  • fa21_alberts_naomi_final-project_ph-lesson.md
  • fa21_atkins+joyce-farley_charlotte+siobhan_pranks.md
  • fa21_zayas+waters_elliot+mac_final-project-soundscape.md
  • sp22_arocho_alejandra_herodotus-workshop.md
  • sp22_lang_theodora_counterproofing.md
  • sp22_wei+yang_jianing+luxi_popup.md
  • su22_fld_cunningham_annika_onion-skin-dyeing.md
  • sp22_fld_rosenkranz_naomi_madder-lake-trio.md

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.