Context
git-basics.html uses "fork", "upstream", "branch", "commit" and "remote" freely. The glossary defines all of them. The two pages do not know about each other, so a reader who hits an unfamiliar word has to go looking.
What to change
Files: git-basics.html, and js/glossary.js if you take the automatic route
Requirements:
- Link the first use of each glossary term on the page to its glossary entry
- First use only — linking every occurrence turns the page into a sea of blue
- Depends on issue about per-entry ids, so agree an id format or coordinate with whoever has that one
- Prefer doing this in the HTML over scanning and rewriting text in JavaScript; the automatic approach mangles text inside code blocks
Acceptance criteria
How to verify locally
python3 -m http.server 8000
Then open http://localhost:8000.
Difficulty
Intermediate. The judgement about which occurrences to link is the hard part, not the code.
New here? Comment /claim on this issue and a bot will assign it to you. Then read CONTRIBUTING.md.
Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).
Context
git-basics.htmluses "fork", "upstream", "branch", "commit" and "remote" freely. The glossary defines all of them. The two pages do not know about each other, so a reader who hits an unfamiliar word has to go looking.What to change
Files:
git-basics.html, andjs/glossary.jsif you take the automatic routeRequirements:
Acceptance criteria
<code>or<pre>blocksHow to verify locally
Then open http://localhost:8000.
Difficulty
Intermediate. The judgement about which occurrences to link is the hard part, not the code.
New here? Comment
/claimon this issue and a bot will assign it to you. Then read CONTRIBUTING.md.Stuck at any point? Comment here saying what you have tried and where it stopped working — that is not an admission of failure, it is how we find out the instructions were unclear. You can also come to a PR Debug Clinic (Oct 12 or Oct 21).