Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise Resources on Step 3 (Markdown and Fork Tutorial) #807

Open
JLKwong opened this issue Jan 26, 2021 · 1 comment · May be fixed by #814
Open

Revise Resources on Step 3 (Markdown and Fork Tutorial) #807

JLKwong opened this issue Jan 26, 2021 · 1 comment · May be fixed by #814
Labels
ready for VI

Comments

@JLKwong
Copy link
Member

JLKwong commented Jan 26, 2021

Problem

Some instructions in Step 3 are unclear or contain overwhelming amounts of information, which would deter new interns.

  1. "Preparation" is unclear in what one is supposed to do, but this might be caused by issue switch color scheme to white on black #2 (having several pages of links and thousands of words).
  2. Unlike the Markdown and MDwiki links, the GitHub link is extremely verbose, with several pages of links and thousands of words, and it's unclear which sections the intended reading is supposed to include, when the reading is supposed to stop, or what sections should be skimmed. It's also not clear that this is for reading only.
  3. 5 resources for learning Markdown syntax can cause decision paralysis, and some prospective interns may waste time doing all of them 'just in case' despite the note.

Steps to reproduce the problem

N/A

Screenshots

image
image

Proposed solution

  1. Delete Preparation, AND add Readings
  2. Replace GitHub's hyperlink with a link to a more concise summary/reading for GitHub, much like the ones for Markdown and MDwiki. I'm not sure what the original intended learning for this link was supposed to be, and I am not experienced enough with GitHub to recommend resources.
  3. Move the top 3 resources down at the bottom, AND create a new section of these Markdown resources called Additional Resources for Markdown, explaining that these are optional resources that the user might find useful. I left the other 2 resources because they are interactive (active learning promotes long-term learning, especially for syntax).
@BryanGazali
Copy link
Member

BryanGazali commented Jan 28, 2021

We'll approve this issue, but it does seem like a fairly extensive solution to complete. We'll let you try to do this but if this ends up being too hard to complete and you want to move onto something else, that's ok.

@BryanGazali BryanGazali added the ready for VI label Jan 28, 2021
JLKwong pushed a commit to JLKwong/JLKwong.github.io that referenced this issue Feb 2, 2021
JLKwong pushed a commit to JLKwong/JLKwong.github.io that referenced this issue Feb 2, 2021
JLKwong pushed a commit to JLKwong/JLKwong.github.io that referenced this issue Feb 2, 2021
@JLKwong JLKwong linked a pull request Feb 2, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for VI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants