Summary of Workshop: All Exercises

This page gives an overview of exercises and tasks on the previous pages as part of the workshop.

Are you already comfortable with Git, GitHub and the concept of using software to parse text-based files and create marked-up documents? Then you can try completing the exercises by following the steps as outlined below. If something is not clear, refer back to the relevant exercise page.

TeachBooks Workflow

Table overview:

Workflow Steps (DIAGRAM TO SIDE?)

Here is how the exercises relate to the workflow.

Step No.	Name	Exercise	Description
1	Get and idea	N/A
2	Create your version of the book	5	Create a branch
3	Edit the book	1, 3, 4, 5	Several ways to do this
4	Check changes online	2, 5	Workflows and Actions Summary
5	Repeat edit and checking	N/A
6	Submit for review	6, 7	Open and merge a Pull Request. Forks and PR's.

Overview of Exercises and Tasks

Exercise 0: Preparation

The exercises here assume you have created a book using the TeachBooks Template repository on GitHub. If you haven't done this yet, please go back to the page It only takes 10 clicks! page.

Exercise 1: Edit Contents

Use the GitHub browser interface to edit a single file in your book.
Make a commit to save your changes.
Check that the changes are reflected in the book website.

Exercise 2: How it's Made

Visit the GitHub Actions tab in your repository.
Identify the key jobs that make up the entire workflow
Read the summary page and answer the H5p questions.

Exercise 3: Metadata

Use the GitHub browser interface to edit the _config.yml file.
Visit the Actions page and watch the build process
Open the job and see the command line output
Once the job is complete, check that the changes are incorporated in the book website.

Exercise 4: Online Editor

Open the "Visual Studio Code for the Web" editor (VSC Web) using the shortcut . from your repository homepage
Explore the file structure of your book
Explore the editor interface, for example, use side-by-side file editing; look at the git tab
Open multiple files and make changes to them
Commit your changes using a single commit
Check that the changes are reflected in the book website.

Exercise 5: Your Version of the Book

Create a branch
Open VSC Web editor
Open the _toc.yml file and replace one page with another
Commit your changes
Visit the Actions to see results
Open both versions of the book and confirm that the changes made in your branch are visible
Confirm that the URL's of each book match the branch names

Exercise 6: Submit for Review

Open a Pull Request (GitHub will often prompt you to do this)
Review the changes in the "Files changed" tab (note the commit summary also)
Pretend that you are another team member (reviewer) and leave a comment
Merge pull request
Check Actions tab to see the workflow run
Delete branch

Exercise 7: Collaborate

find a partner
go to their repo and create a fork
make a change to their book
open a pull request, taking care that your forked repo/branch will be merged into their repo/branch (base)
ask your partner to review and merge the pull request
do the same for your partner in your repository

Exercise n

Form your team, study the Manual, work on your book, enjoy!

3.4 KiB Raw Blame History