Developing Collaborative Documents

This workshop was first run in 2021 using this presentation and has been revised with new material for 2022. Please find your specific workshop from the list below which will link directly to the slides that were used in your session.

• If you are part of the Pharmaco-Epi Collective, please refer to this presentation.
• If you were at CarpentriesCon in 2022 learning how to Git Good, your presentation is here.
• If you are an Enrichment student who attened the Effective Collaboration in a Distributed World Workshop from Tools, Practices and Systems, your presentation is here.

References used in this course are taken from Mozilla Science Lab's Study Group Orientation and Kirstie Whitaker's presentation on Friendly GitHub Intro.

About this repository

This repository offers learning material for a practical session on "Developing Collaborative Documents", which will introduce you to GitHub as a tool for creating documents online with your collaborators.

GitHub provides a Web-based graphical interface to maintain and share your projects (repositories) and maintain the different versions of your documents with information such as which files change, what changed, who changed them, and why those updates were made.

GitHub also provides access control (who can access your files, who can read or edit them) and several collaboration features, such as wikis and basic task management tools for every project.

For learners

If you cannot find your specific workshop presentation from the list above, please use this presentation to guide your learning pace.

Prerequisite

No prior experience with GitHub is needed. Bring any real-life scenario, where developing collaborative documents will be useful for you. Please bring your laptop to this event.

Learning outcome

• The goal is to make you comfortable with a Collaborative workflow in the GitHub interface.
• Practice adding resources to online project folders, working with tasks and issues, writing messages when committing to any change, making and reviewing change requests from others, and merging them.
• You'll also practice good communication with contributors.

For the instructors

1. Define the goal for this project.
2. Decide on the date, time, and venue for this course.
3. Define your target audience and their requirements.
4. Create a README file and add the information there.
5. Create handout material covering the following areas:
   • Collaboration and version control (versioning)
   • GitHub
   • GitHub folder/project is also known as repository/repo
   • Creating a repo
   • Playing around with the repo
   • Collaborating with others
   • Useful GitHub features

Main reference: Friendly GitHub Intro by Kirstie Whitaker

1. Collaboration, Version Control, and GitHub
2. Getting to know GitHub
3. Github for collaboration