Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Latest commit 8daf1da Apr 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
2019-04-06-week-1-fail-log.md Add example fail log. Apr 6, 2019
README.md How to edit README.md Apr 6, 2019

README.md

example_fail-log_craftingDH

This GitHub repository is an example fail log for the Crafting Digital History Workbook. The point of a fail log is to openly discuss your worries, pose questions, and reflect on your weekly learning. Dr. Graham will review your fail log and offer individual or class-wide feedback. Note that while this work can seem daunting, a fail log will help generate open discussion and track your educational growth. The log is meant to help document your work. Remember: Document what you do, and do what you document.

In the first week of the course, you will fork this repository to begin curating a weekly fail log.

Update your fail log

Follow the instructions below to create your first example fail log:

  1. Navigate to the root of this GitHub repository.
  2. At the top right of the page, click the button labelled Fork.
  3. You will now notice that the top left resembles the following - this means you now have your own copy of the fail log to get started:
YourUsername\example_fail-log_craftingDH
forked from rblades\example_fail-log_craftingDH
  1. In your new forked repository, open the file 2019-04-06-week-1-fail-log.md.
  2. Change the date in the file title to today's date (using the YYYY-MM-DD convention). You may also wish to change the week-1-fail-log to something more descriptive.
  3. Each week you will include a link to your 3 most important Hypothes.is annotations and reflect on how the 3 annotations were meaningful to your learning.
  4. In the first week you will also reflect on your worries for the course, any technical issues you encountered, etc.

You can also edit this main file (README.md) in your forked copy of the repository to contain a summary of your fail logs. The README file is the first file people read when they visit your repository. To edit this file, follow the instruction below:

  1. Click the README.md file to open it.
  2. To the right of the button group labelled Raw, Blame, and History, click the pen/pencil icon to edit the README.md file. README.md is a Markdown (.md) file. For more information on the Markdown syntax, read Daring Fireball's instroduction to Markdown. We cover Markdown in-depth in Module 1, Exercise 1 of the Crafting Digital History Workbook.
  3. Change the title text to something relevant.
  4. Delete all these instructions and add a relevant summary of your fail logs. You can continue updating this file.

Create a new file in GitHub in the browser

Each week you will create a new fail log file at the root of your forked repository. To create a new file in your GitHub repository, follow the instructions below:

  1. At the root of your repository, click the button labelled Create new file. For reference, visit GitHub's instructional guide for creating new files.
  2. Title your file to resemble the following: 2019-04-12-week-2-fail-log.md. Always title your file with the date first (using the YYYY-MM-DD convention).
  3. This creates a new markdown (.md) file.
  4. Add your fail log for that week.
  5. At the bottom of the file, enter a brief 'commit' message about what you updated.
  6. Click the green button at the bottom labelled Commit new file.

Create a new folder in GitHub in the browser

You may also wish to organize each week into separate folders. That way you can add more files for each week. For example, for Module 1 you have your file log and a file containing all the commands you entered into the DH Box terminal that week. Adding a new folder is just as simple as adding a new file in your GitHub repository. Follow the instructions below:

  1. At the root of your repository, click the button labelled Create new file. For reference, visit GitHub's instructional guide for creating new files.
  2. However, in this case you type your folder name followed by a slash /. This will create the new folder.
  3. Then you type the file name. For reference, visit KirstieJane's instructions on creating a new folder in GitHub.
  4. Add your text to the new file.
  5. At the bottom of the file, enter a brief 'commit' message about what you updated.
  6. Click the green button at the bottom labelled Commit new file.
You can’t perform that action at this time.