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

Unclear file edit instructions in Getting started with Git #124

Open
yoyology opened this issue Jan 19, 2022 · 2 comments
Open

Unclear file edit instructions in Getting started with Git #124

yoyology opened this issue Jan 19, 2022 · 2 comments
Assignees
Labels
type:enhancement Propose enhancement to the lesson

Comments

@yoyology
Copy link

yoyology commented Jan 19, 2022

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.

@emcaulay
Copy link
Contributor

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 emcaulay self-assigned this Oct 18, 2023
@emcaulay emcaulay added the type:enhancement Propose enhancement to the lesson label Oct 18, 2023
@jas58
Copy link
Contributor

jas58 commented Nov 13, 2023

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Propose enhancement to the lesson
Projects
None yet
Development

No branches or pull requests

3 participants