lc-git icon indicating copy to clipboard operation
lc-git copied to clipboard

Unclear file edit instructions in Getting started with Git

Open yoyology opened this issue 3 years ago • 2 comments

In https://github.com/LibraryCarpentry/lc-git/blob/gh-pages/_episodes/02-getting-started.md?plain=1, starting at line 244, the instructions read, "We will open the file index.md with any text editor we have at hand (e.g. Notepad on Windows or TextEdit on Mac OSX) and enter # Hello, world!. The hash character is one way of writing a header with Markdown. Now, let’s save the file within the text editor and check if Git has spotted the changes."

Up until this point, we have done everything in Git Bash. Taking this step requires knowing where the file is located in your file system, opening it with an editor, and making changes. That's a lot of assumed knowledge packed into three sentences. Not to mention that Markdown has only been mentioned once in passing previously.

I can write different instructions here, but they would be Windows-specific, as I have almost no experience with modern Macs.

yoyology avatar Jan 19 '22 16:01 yoyology

Hello @yoyology ! I am sorry it has taken so long for someone to respond to your observation about the complexity packed into that part of Episode 2. Thank you for providing the quotation from the lesson so that I do know exactly what you are talking about. I will attempt to make a revision and get another maintainer or yourself to review it.

emcaulay avatar Oct 18 '23 00:10 emcaulay

Oh, this might be connected to my PR#159. As I observed it today, it ran smoothly enough, but I didn't think to transcribe that part of the session. Happy to follow up sometime (Dec is better for me).

jas58 avatar Nov 13 '23 22:11 jas58