open-learning-exchange.github.io
open-learning-exchange.github.io copied to clipboard
Consistently name <username>, YOUR_USERNAME, YourUsername in git repo tutorial
Problem
I noticed while following along with the "Git Repositories" tutorial that goes with Step 5 of VI's first steps, that there are inconsistent ways of referring to the readers Github username as a placeholder. Despite being quite familiar with navigating Github and using git cli this led to a little confusion on my part because it's referring to the same username, I believe, all the time.
Steps to reproduce the problem
open http://open-learning-exchange.github.io/#!./pages/vi/vi-github-and-repositories.md
Screenshots
Two examples below -


Proposed solution
Rewrite vi-github-and-repositories.md to be most consistent about how to refer to the readers Github username (where applicable).
I'm not sure of what I would call the shared username across the sections yet.
Suggestions?
@chase-metzger I think your_username would be fine. Go ahead and work on this.
@Liew211 Thanks, will do
I'm noticing one thing that makes some sentences read odd with your_username as the consistent choice.
There are multiple instances where the word "your" is preceding the username.github.io that is already there. See below for how it would read now.

@chase-metzger hmm in that case just make all of them username
<> symbol was added so people know that it is variable not static text. And this is general concept when you refer to commands.
I think this issue was solved and can be closed?
@chase-metzger I just noticed in the FAQ page of virtual intern, username in Q15 and Q16 are not consistent with what you changed in this issue. It will be better to change them too.
@wanglihe2010 its not Q15 and Q16 but Q16 and Q17
There are still multiple instances where different styles are used to indicate that the "GitHub username" should be placed as highlighted below:
-
Step 1
-
Step 5
-
Step 6
I believe unifying the method used would clear any possible confusion. I can work on it if no one has already been assigned for this issue.
Proposed Solution
Using angle brackets <> since they are considered placeholders in general in git documentation and declaring this in a note at the beginning of the steps would make the process easier for everyone.
@AdhamElAsfar99 Yes, you can claim this issue. Go ahead and create a pull request!