Skip to content

Clarify email address requirement for ssh-keygen -C in Episode 7 #1121

@gjduine

Description

@gjduine

How could the content be improved?

Problem

The example in Episode 7, line 206 shows:

$ ssh-keygen -t ed25519 -C "a.linguini@ratatouille.fr"

For beginners, it's unclear whether the email must be their GitHub account email or if any email works.

Suggested Improvement
Add a note clarifying that the -C flag adds a comment/label to identify the key:

Note: The email address in the -C option is used as a label to identify this SSH key. Use the email address associated with your GitHub account so you can easily remember which key belongs to which account.

This will help new learners choose the correct email without confusion.

### Which part of the content does your suggestion apply to?

episode 7 in git-novice

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions