8000 Setting up Git: <Missing Information on SSH Key Creation and Git Directory Navigation> · Issue #29397 · TheOdinProject/curriculum · GitHub
[go: up one dir, main page]

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

Setting up Git: <Missing Information on SSH Key Creation and Git Directory Navigation> #29397

Open
3 tasks done
TinkuGoel920 opened this issue Feb 10, 2025 · 1 comment
Open
3 tasks done

Comments

@TinkuGoel920
Copy link

Checks

Describe your suggestion

Issue Report:

Summary: In the current curriculum, while setting up Git configurations and creating SSH keys, there is an important step that is not clearly mentioned. As a beginner, I found that I needed to enter the .git directory in order to generate an SSH key, but this detail was missing in the lesson.

Problem:

When following the instructions for setting up Git configurations, it would be helpful to explicitly mention that, to create an SSH key for Git, you must first navigate to a Git repository directory (or initialize one).
The curriculum does not provide clear instructions on how to find the .git folder or how to navigate to a Git repository in the first place.
As a beginner, this step was not intuitive and led to confusion while trying to follow along.
Suggested Improvement:

Include a clear explanation that users need to be inside a Git repository (or initialize one with git init) before proceeding with SSH key creation.
Add a note on how to check if the current folder is a Git repository, such as using the git status command, or by verifying the presence of the .git folder.
Provide instructions on how to find or initialize a Git repository to ensure users are in the right directory before proceeding with SSH key creation.
Conclusion: Including these details in the curriculum would make the process smoother for beginners, ensuring they don't miss essential steps when setting up their development environment.

Path

Foundations

Lesson Url

https://www.theodinproject.com/lessons/foundations-setting-up-git

(Optional) Discord Name

https://www.theodinproject.com/lessons/foundations-setting-up-git

(Optional) Additional Comments

No response

@JoshDevHub
Copy link
Contributor

Hello @TinkuGoel920 thank you for making an issue.

I have a couple questions:

  1. What operating system are you using?
  2. What was the exact problem you were encountering when trying to generate an SSH key without "being inside of a git repository"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants
0