Skip to content

Commit 0ce0155

Browse files
author
GitHub Workshop Bot
committed
docs: batch accessibility and structure fixes for 00-pre-workshop-setup.md
- Update 2FA text to reflect GitHub platform-wide requirement (closes #152) - Convert Quick steps to enable 2FA to proper heading (closes #153) - Convert Detailed setup notes to proper heading (closes #154) - Convert Authenticating Git with GitHub to proper heading (closes #155) - Orphaned ## already fixed on main (closes #157) - Stray --- separators already fixed on main (closes #158) - Add Who are maintainers explanation in Profile section (closes #159) - Change profile picture from optional to strongly recommended (closes #160) - Convert Recovery and backup to proper heading - Convert Workshop policy to proper heading
1 parent 9c8059a commit 0ce0155

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/00-pre-workshop-setup.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ GitHub also sends a **separate** email verification link after account creation.
111111

112112
### Enable two-factor authentication (2FA): detailed guidance and workshop policy
113113

114-
Two-factor authentication (2FA) adds a second verification step each time you sign in, protecting your account if your password is compromised. For this workshop, 2FA is required. We recommend using the **GitHub Mobile app** for the smoothest experience - see the options below.
114+
Two-factor authentication (2FA) adds a second verification step each time you sign in, protecting your account if your password is compromised. GitHub now requires 2FA for all accounts, so you may already have it enabled. If not, set it up now. We recommend using the **GitHub Mobile app** for the smoothest experience - see the options below.
115115

116-
Quick steps to enable 2FA
116+
### Quick steps to enable 2FA
117117

118118
1. Open the [GitHub security settings page](https://github.com/settings/security) while signed in.
119119
2. Under **Two-factor authentication**, choose **Enable** and follow the prompts.
@@ -123,7 +123,7 @@ Quick steps to enable 2FA
123123
- **Security key / passkey** (most secure): hardware security keys (YubiKey, etc.) or platform passkeys (biometric device credentials).
124124
- **SMS / text message** (least preferred): can be used if other options are unavailable.
125125

126-
Detailed setup notes
126+
### Detailed setup notes
127127

128128
- Authenticator app (recommended):
129129
- Visual users: scan the QR code with your authenticator app and enter the 6-digit code shown.
@@ -135,12 +135,12 @@ Detailed setup notes
135135
- SMS / text message:
136136
- Enter your phone number and verify the code sent via text. Use only if authenticator apps or keys are unavailable.
137137

138-
Recovery and backup
138+
### Recovery and backup
139139

140140
- After enabling 2FA, GitHub will display **recovery (single-use) codes**. Immediately copy, download, or securely store these codes (password manager or physically secure location). They are the only fallback if you lose your second-factor device.
141141
- Consider registering more than one second-factor method (e.g., authenticator app + a hardware key) to avoid account lockout.
142142

143-
Authenticating Git with GitHub: browser-based sign-in (OAuth)
143+
### Authenticating Git with GitHub: browser-based sign-in (OAuth)
144144

145145
When you use Git inside VS Code or GitHub Desktop, you do not need to manage passwords, tokens, or SSH keys manually. These tools use **browser-based OAuth sign-in** - the same "Sign in with GitHub" flow you use on any website:
146146

@@ -163,7 +163,7 @@ That is it. No tokens to generate, no keys to create, no strings to paste. If yo
163163
164164
> **Tip - GitHub Mobile for push notification 2FA:** If you have not already, install the free [GitHub Mobile](https://github.com/mobile) app (iOS and Android). Once linked to your account, every 2FA prompt becomes a single tap on a push notification instead of typing a 6-digit code. The app supports VoiceOver (iOS) and TalkBack (Android).
165165
166-
Workshop policy
166+
### Workshop policy
167167

168168
For this workshop, participants need a GitHub account with 2FA enabled. The browser-based sign-in described above handles all Git authentication automatically - no additional setup is required beyond having a working GitHub account.
169169

@@ -279,6 +279,10 @@ Theme is on a separate page: [GitHub Appearance Settings](https://github.com/set
279279

280280
Your GitHub profile is your public identity in the open source community. Setting it up properly helps maintainers know who you are.
281281

282+
### Who are maintainers?
283+
284+
Maintainers are the people who manage a repository -- they review contributions, respond to issues, merge pull requests, and keep the project running. When you open an issue or submit a pull request, a maintainer is the person who will see it and respond. Setting up your profile helps maintainers know who you are and builds trust in the community.
285+
282286
### Update your profile
283287

284288
1. Navigate to [Settings → Public profile](https://github.com/settings/profile)
@@ -289,9 +293,9 @@ Your GitHub profile is your public identity in the open source community. Settin
289293
- **Website or social links** - optional
290294
- **Pronouns** - GitHub supports adding pronouns to your profile
291295

292-
### Add a profile picture (optional)
296+
### Add a profile picture (strongly recommended)
293297

294-
A profile picture humanizes your contributions. It can be a photo or any image. If you prefer not to use a photo, GitHub generates a default avatar based on your username.
298+
A profile picture is strongly recommended because it humanizes your contributions and helps maintainers and collaborators recognize you across issues, pull requests, and comments. It can be a photo or any image that represents you. If you prefer not to use a photo, GitHub generates a default avatar based on your username.
295299

296300
### Set your notification email
297301

0 commit comments

Comments
 (0)