open-learning-exchange.github.io icon indicating copy to clipboard operation
open-learning-exchange.github.io copied to clipboard

Consistently name <username>, YOUR_USERNAME, YourUsername in git repo tutorial

Open chase-metzger opened this issue 6 years ago • 8 comments

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 -

Screen Shot 2019-07-18 at 8 05 44 PM

Screen Shot 2019-07-18 at 8 07 23 PM

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 avatar Jul 19 '19 03:07 chase-metzger

@chase-metzger I think your_username would be fine. Go ahead and work on this.

Liew211 avatar Jul 19 '19 03:07 Liew211

@Liew211 Thanks, will do

chase-metzger avatar Jul 19 '19 03:07 chase-metzger

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.

Screen Shot 2019-07-18 at 9 00 44 PM

chase-metzger avatar Jul 19 '19 04:07 chase-metzger

@chase-metzger hmm in that case just make all of them username

Liew211 avatar Jul 20 '19 00:07 Liew211

<> symbol was added so people know that it is variable not static text. And this is general concept when you refer to commands.

lmmrssa avatar Jul 22 '19 13:07 lmmrssa

I think this issue was solved and can be closed?

wanglihe2010 avatar Aug 15 '19 04:08 wanglihe2010

@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 avatar Aug 15 '19 20:08 wanglihe2010

@wanglihe2010 its not Q15 and Q16 but Q16 and Q17

robinGiri avatar Nov 11 '19 07:11 robinGiri

There are still multiple instances where different styles are used to indicate that the "GitHub username" should be placed as highlighted below:

  • Step 1 image

  • Step 5 image

  • Step 6 image

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 avatar Jul 17 '24 14:07 AdhamElAsfar99

@AdhamElAsfar99 Yes, you can claim this issue. Go ahead and create a pull request!

xyb994 avatar Jul 17 '24 14:07 xyb994