Skip to content

Commit

Permalink
Add Glossary page (#14)
Browse files Browse the repository at this point in the history
* Add glossary of commands

Signed-off-by: Will Beason <[email protected]>

* Fix erroneous link

Signed-off-by: Will Beason <[email protected]>

---------

Signed-off-by: Will Beason <[email protected]>
  • Loading branch information
willbeason authored Feb 3, 2025
1 parent e7b1980 commit eb209be
Show file tree
Hide file tree
Showing 10 changed files with 921 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/current/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<link href="site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap-2d68896013072191d2a921d5e9046201.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="site_libs/bootstrap/bootstrap-f2151062440e71a1d76e61548d0dfb49.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
Expand Down
2 changes: 1 addition & 1 deletion docs/current/oss_syllabus.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<link href="site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap-2d68896013072191d2a921d5e9046201.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="site_libs/bootstrap/bootstrap-f2151062440e71a1d76e61548d0dfb49.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
Expand Down
33 changes: 33 additions & 0 deletions docs/current/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -1171,5 +1171,38 @@
"Appendices",
"<span class='chapter-number'>A</span>  <span class='chapter-title'>Skills faq</span>"
]
},
{
"objectID": "skills/glossary.html",
"href": "skills/glossary.html",
"title": "Appendix B — Glossary of Commands",
"section": "",
"text": "B.1 Git",
"crumbs": [
"Appendices",
"<span class='chapter-number'>B</span>  <span class='chapter-title'>Glossary of Commands</span>"
]
},
{
"objectID": "skills/glossary.html#git",
"href": "skills/glossary.html#git",
"title": "Appendix B — Glossary of Commands",
"section": "",
"text": "git init initializes a new Git repository in the current working directory.\n\ngit init [DIRECTORY] like above, but in the specified directory.\n\ngit add [FILE] tracks changes in the specified file, but does not commit those changes.\n\ngit add . tracks changes in all files in the current directory and all subdirectories. Be careful not to track changes you didn’t intend!\n\ngit commit -m \"[MESSAGE]\" commits all tracked changes to the repository with a specified message. Remember the quotes around the message!\n\ngit commit is like the above, but uses the default text editor (probably vim). You can exit that editor by typing :cq and hitting enter. If that fails, you may want to kill your terminal and restart.\n\ngit status shows the state Git thinks the repository is currently in. By default it shows what branch you’re on, staged and unstaged changes, and untracked files.\ngit log shows the history of the git repository. If the history is longer than your current terminal screen, you can navigate history with the arrow keys. Hit q to quit.\n\ngit viz is an alias we made for this class that shows the commit history in an easier-to-read format.\n\ngit config manages local (for one repository) and global (for all repositories on your computer) configuration. These can change many aspects of how Git functions. Most functionality offered by this command is not part of this class.\n\ngit config --global alias.[NAME] \"[COMMAND]\" creates a new global subcommand for git that executes the passed command named NAME. This is how we made git viz.",
"crumbs": [
"Appendices",
"<span class='chapter-number'>B</span>  <span class='chapter-title'>Glossary of Commands</span>"
]
},
{
"objectID": "skills/glossary.html#command-line-tools",
"href": "skills/glossary.html#command-line-tools",
"title": "Appendix B — Glossary of Commands",
"section": "B.2 Command Line Tools",
"text": "B.2 Command Line Tools\nFor many of these commands, if you type --help after the command, it will print out detailed documentation.\n\npwd, shows the path to your current working directory.\nls, lists the contents of your current directory.\ncd [DIRECTORY], changes the directory you’re in.\n\ncd .., moves to the parent directory of the current working directory.\nPaths starting with / indicate absolute paths rather than ones relative to your working directory.\n\nmkdir, makes a new directory.\ntouch, creates a new (empty) file.\n\nThe command has other uses, but those aren’t part of this class.\n\nrm, removes files and directories.",
"crumbs": [
"Appendices",
"<span class='chapter-number'>B</span>  <span class='chapter-title'>Glossary of Commands</span>"
]
}
]

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion docs/current/skills/git_basic_workflow.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-2d68896013072191d2a921d5e9046201.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-f2151062440e71a1d76e61548d0dfb49.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
Expand Down Expand Up @@ -317,6 +317,12 @@
<a href="../skills/skills_faq.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">A</span>&nbsp; <span class="chapter-title">Skills faq</span></span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../skills/glossary.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">B</span>&nbsp; <span class="chapter-title">Glossary of Commands</span></span></a>
</div>
</li>
</ul>
</li>
Expand Down
8 changes: 7 additions & 1 deletion docs/current/skills/git_rewinding_work.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../site_libs/bootstrap/bootstrap-2d68896013072191d2a921d5e9046201.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<link href="../site_libs/bootstrap/bootstrap-f2151062440e71a1d76e61548d0dfb49.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
Expand Down Expand Up @@ -317,6 +317,12 @@
<a href="../skills/skills_faq.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">A</span>&nbsp; <span class="chapter-title">Skills faq</span></span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../skills/glossary.html" class="sidebar-item-text sidebar-link">
<span class="menu-text"><span class="chapter-number">B</span>&nbsp; <span class="chapter-title">Glossary</span></span></a>
</div>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit eb209be

Please sign in to comment.