This assignment is a way of introducing you to the Markdown syntax and demonstrates how we will be communicating to the public through the web. Additionally, you will practice using git by submitting your file to the course's online repository.
Requirements
Name your .Rmd file "about" + "-" + your GitHub user name in all lowercase (e.g., about-dtwoods.Rmd) in the parent repository directory.
Include an embedded image (something appropriate)
Include at least one definition list (e.g., bio, hobbies, website, etc.)
Include an ordered and/or unordered list.
Include a type of text formatting (e.g., italics, bold, strikethrough) outside a header or definition term.
Keep your markdown formatting clean, clear, and consistent.
Practice Challenge
If this is your first time writing in Markdown, practice some basic features (e.g., headings, lists, links, images, and emphasis) in an online environment, such as StackEdit.io, then open 2--3 "About the Coder" pages from a previous semester and paste them in StackEdit.io to see how they look compared to their web-rendered version. Notice how markdown renderers stylize content differently. Be sure to reference the Pandoc + R markdown syntax, which is what your site will be rendered using.
When you are ready to write your "About" page:
Review the "about-dtwoods.Rmd" file located in the organization repository's parent directory along with all other about pages from past team members.
You may copy an existing about page and rename it using your GitHub user name (i.e., "about-YOURUSERNAME.Rmd") or start a new file from scratch; remember to use all lowercase letters for your username; keep "Rmd" with a capital "R".
Open your file using a text editor of your choice (or the online text editor) and delete everything below the YAML header (the set of "---" lines at the top of the file).
Update your name, edit date and semester in the YAML header; note that the header keywords are case sensitive!
Add an image you would like to associate with your bio.
Use a definition list, ordered/unordered list, and a text emphasis format somewhere in your file.
PLEASE: NO SAMPLE SCRIPT IN YOUR FIRST SUBMISSION
If you copy another about.Rmd file from the repository, you can delete the section called "Sample Script." You will add your utility script to your "About the Coder" page in the next assignment.
Instructions - Using GitHub
The GitHub web interface allows you to do almost everything needed for this class without the fuss of using the command line.
Should you choose to go this route,
log in to GitHub and find the organization repository
be sure you are on the "Code" page
click "Add file - Create new file" in the drop-down menu
give your new file an appropriate name (e.g., about-dtwoods.Rmd); note that you must provide the file extension
use the web-based markdown editor to type your document
when ready, use the green button below the editor to "Commit new file"
Instructions - Using Git
If you have not already, create a folder for our course repository, clone the repository on to your computer, and configure your git workspace using the commands below.
# On the Terminal / Command Prompt
cd [path to repository] # replace "[path to repository]" with the directory path
git clone https://github.com/spatial-data-discovery/spatial-data-discovery.github.io.git
cd spatial-data-discovery.github.io # change into the repository directory
git config user.name [username] # replace "[username]" with your GitHub user name
git config user.email [email] # replace "[email]" with the email associated with GitHub
git config push.default simple # optional configuration
Example text in markdown:
---
title: "About the Coder"
author: "YOUR NAME"
date: "Edited: TODAY'S DATE"
semester: "Fall 2021"
---
Bio
: YOUR BIO LINE
INCLUDE AN (ORDERED/UNORDERED) LIST
- UNORDERED ITEM 1
- UNORDERED ITEM 2
INCLUDE A TEXT EMPHASIS FORMAT (*ITALICS*, **BOLD**, ~~STRIKETHROUGH~~)
Save and close your file, stage it, commit it and push it to the course's online repository.
# On the Terminal / Command Prompt</span>
git pull # check for remote changes on the repository
git add [your .Rmd file] # replace "[your .Rmd file]" with your file name
git commit -m "Create my about .Rmd file. Addresses #45"
git push # you may be prompted to enter your GitHub username and password
dt-woods
commented
3 years ago
About the Coder Assignment | Fall 2020
This assignment is a way of introducing you to the Markdown syntax and demonstrates how we will be communicating to the public through the web. Additionally, you will practice using git by submitting your file to the course's online repository.
Requirements
strikethrough) outside a header or definition term.When you are ready to write your "About" page:
Instructions - Using GitHub
The GitHub web interface allows you to do almost everything needed for this class without the fuss of using the command line. Should you choose to go this route,
about-dtwoods.Rmd); note that you must provide the file extensionInstructions - Using Git
If you have not already, create a folder for our course repository, clone the repository on to your computer, and configure your git workspace using the commands below.
Example text in markdown:
Save and close your file, stage it, commit it and push it to the course's online repository.