Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,21 @@ A repo to play with the common git operations in and learn how to get working wi
# FILL THINGS OUT BELOW THIS LINE AND DO IT IN MARKDOWN

## Working definition of Git and what it's done for

Git is a version control platform that uses the command line to manipulate branches.
## What do you think the top 3 reasons to use GitHub / GitLab are?
1.
2.
3.
1. It's the most popular version control system out there.
2. **The community is alive.**
3. *Github is very user-friendly.*

## What is a Pull Request?

A pull request is informing other users of a project about the changes you are pushing to a branch. Pull requests can become conversations discussing the changes once opened.
## Links to relevent Github / git tutorials
- [Github](https://github.com/)
- Add a resource link here
- Add another resource link here
- [Help - Github](https://help.github.com/en)
- [YouTube](https://www.youtube.com/)


### Change this image to be something else with different alt data
You can also do images like the one just below here using the !
![Oh Spongebob](https://media.giphy.com/media/3oEjI4sFlp73fvEYgw/giphy.gif).
![Forever Alone](https://media.giphy.com/media/gtoONZQegPnPy/giphy.gif)
29 changes: 20 additions & 9 deletions Reflection.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# My Reflection / Blog
Use this file to submit your blog post to your github account / repo. In it, include some markdown to practice, especially a link to your video.
*Screencast submission* - [YouTube video by HAXcms core contributor Michael Potter](https://www.youtube.com/watch?v=5aPae031TxM&list=PLJQupiji7J5cGYiOflGYFwXSEoHMoowkP&index=17&t=0s)
Here's a reminder of how you do the link above as code.
```markdown
*Screencast submission* - [YouTube video by HAXcms core contributor Michael Potter](https://www.youtube.com/watch?v=5aPae031TxM&list=PLJQupiji7J5cGYiOflGYFwXSEoHMoowkP&index=17&t=0s)
```

Good luck!
# My Reflection / Blog - Mhykol W
**Class Section:** IST 402.002
**Date:** September 8, 2019

## MWiz - Markdown Explanation + Video
This is MWiz today and I will be discussing the popular text-to-HTML conversion tool used in Github, Markdown. Markdown is a text-to-HTML tool meaning that it takes text information and transforms it into HTML for better readability on documentation. Markdown is very popular with software developers, especially on version control software like Git. A popular alternative to Markdown is reStructuredText which both seem very similar on the surface but differ in semantics and extensibility (“reStructuredText vs Markdown for documentation”). There exists plenty of helpful guides on the web for learning an using Markdown:
- Markdown Guide Website: [Site](https://www.markdownguide.org/getting-started)
- Github’s Guide to Markdown: [Site](https://guides.github.com/features/mastering-markdown/)
- Markdown Cheat-sheet: [Site](https://www.markdownguide.org/cheat-sheet/)


*M Wiz explains it: Markdown* - [video](https://youtu.be/oL6i30vi4LQ)

## My Thoughts:

### Struggles
Markdown is an excellent lightweight markup language and text-to-HTML conversion tool, but I did not fully understand it when I had started using it. For one, the goal behind Markdown is the idea of **readability**. Readability is being able to make any piece of information as easy to understand as possible if that information is only read. This is accomplished by appealing to the mind’s perceptive nature by making certain things bolder, italicized, underlined, bigger, or smaller, to emphasize the purpose of the information. Markdown is not just limited to doing just that, it can also separate things via boxes, use lists to number information (or to better represent attributes of the key piece of information), and much more. As someone without too much experience about what formatting should be used to emphasize what, I may not be making my documentation as readable as it should be. I may be abusing the **bold** formatting too much when I should be *italicizing* more and I would not know. Feedback is extremely important by people whom have experience in Markdown and using Markdown for documentation, as I can better understand which formatting I should use to appeal to the reader and make my documentation more understandable.

### What I liked
My favorite aspect of Markdown is how simple most of the formatting is accomplished. It limits a lot of the potential spelling errors that could be made writing normal HTML. Making a word bold in HTML uses the tags <b> and </b> to close the bold tag but in Markdown it is reduced to just two asterisks between a word or series of words: *This sentence is definitely foo, but not bar*. It’s not a difficult markup language to pick up at all and it is very effective when applied to documentation.