diff --git a/book/intro/workshop/summary.md b/book/intro/workshop/summary.md index 990ed7e..cc3ec68 100644 --- a/book/intro/workshop/summary.md +++ b/book/intro/workshop/summary.md @@ -1,9 +1,5 @@ # Summary of Workshop: All Exercises -This page gives an overview of exercises and tasks on the previous pages as part of the workshop. - -## TeachBooks Workflow - With the exercises, you did all the steps of our TeachBooks workflow! ```{figure} ../figures/TeachBooks_flowchart_v04.png @@ -22,61 +18,4 @@ Here is how the exercises relate to the workflow. | 3 | Edit the book | 1, 2, 3| Editing `.md`-files, the `_toc.yml` and the `_config.yml` | | 4 | Check changes online | 1, 2, 3 | Workflows and Actions Summary | | 5 | Repeat edit and checking | 1, 2, 3, 4, 5 | Keep on doing all the steps until it's ready| -| 6 | Submit for review | 5, 6 | Open and merge a Pull Request, from a branch or forks | - -## 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!](template.md) 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: _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! \ No newline at end of file +| 6 | Submit for review | 5, 6 | Open and merge a Pull Request, from a branch or forks | \ No newline at end of file