diff --git a/docs/fixing-commits.md b/docs/fixing-commits.md index 8efc3095dd..d171b50992 100644 --- a/docs/fixing-commits.md +++ b/docs/fixing-commits.md @@ -29,5 +29,5 @@ Sometimes, you want to make one commit out of a bunch of commits. To do this, 1. `git rebase -i HEAD~n` where `n` is the number of commits you are interested in 2. Reorder the lines containing the commits and save -# Pushing commits after tidying them +## Pushing commits after tidying them 1. `git push origin +my-feature-branch` (Note the `+` there and substitute your actual branch name.) diff --git a/docs/git-cheat-detailed.md b/docs/git-cheat-sheet-detailed.md similarity index 92% rename from docs/git-cheat-detailed.md rename to docs/git-cheat-sheet-detailed.md index 1d1923a178..6d4559e540 100644 --- a/docs/git-cheat-detailed.md +++ b/docs/git-cheat-sheet-detailed.md @@ -1,5 +1,7 @@ +# Git Cheat Sheet (Detailed) + See also -[fixing commits](https://github.com/zulip/zulip-gci/blob/master/docs/fixing-commits.md) +[fixing commits][fix-commit] Commands: @@ -11,7 +13,7 @@ Commands: - `git checkout master`: switch to your `master` branch - `git checkout old-branch-name`: switch to an existing branch `old-branch-name` - commit - - `git commit --amend`: changing the last commit message. Read more [here](https://github.com/zulip/zulip-gci/blob/master/docs/fixing-commits.md) + - `git commit --amend`: changing the last commit message. Read more [here][fix-commit] - config - `git config --global core.editor nano`: set core editor to `nano` (you can set this to `vim` or others) - `git config --global core.symlinks true`: allow symbolic links @@ -49,4 +51,4 @@ Commands: - status - `git status`: show the working tree status, unstaged and staged files - +[fix-commit]: fixing-commits.html diff --git a/docs/git-cheat-sheet.md b/docs/git-cheat-sheet.md index 5b845a4de6..55b1c857ef 100644 --- a/docs/git-cheat-sheet.md +++ b/docs/git-cheat-sheet.md @@ -1,5 +1,6 @@ -See also -[fixing commits](https://github.com/zulip/zulip-gci/blob/master/docs/fixing-commits.md) +# Git Cheat Sheet + +See also [fixing commits][fix-commit] Commands: @@ -48,4 +49,4 @@ Commands: - status - `git status` - +[fix-commit]: fixing-commits.html diff --git a/docs/index.rst b/docs/index.rst index 62b60816c1..f1749f1564 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -84,6 +84,11 @@ Contents: life-of-a-request reading-list screenshot-and-gif-software + fixing-commits + git-cheat-sheet-detailed + git-cheat-sheet + shell-tips + working-copies .. _code-contribution-guide: diff --git a/docs/shell-tips.md b/docs/shell-tips.md index a4fc3483c3..84e455572a 100644 --- a/docs/shell-tips.md +++ b/docs/shell-tips.md @@ -4,7 +4,7 @@ The *shell* is a **command line interpreter**. To use it you can open a *terminal* (sometimes called a *console*). This is how most terminal windows look like: -![An example shell window](shell-screenshot.png) +![An example shell window](images/shell-screenshot.png) If you haven't used it before, you should probably take a look at [this tutorial](http://linuxcommand.org/lc3_learning_the_shell.php). @@ -329,7 +329,10 @@ extremely useful and even easy to use (at least the 99% of the time). To learn more about how to use it, read [our docs](http://zulip.readthedocs.io/en/latest/git-guide.html) on Git and Github. -[This cheatsheet](https://github.com/zulip/zulip-gci/blob/master/docs/git-cheat-detailed.md) + +[This cheatsheet][git-cheat-detailed] will be useful in your journey, as well. ![Git - XKCD 1597](https://imgs.xkcd.com/comics/git.png) + +[git-cheat-detailed]: git-cheat-sheet-detailed.html diff --git a/docs/working-copies.md b/docs/working-copies.md index c58858be2c..12081d51a7 100644 --- a/docs/working-copies.md +++ b/docs/working-copies.md @@ -1,4 +1,4 @@ -## Intro +# Working copies When you work on Zulip code, there are three working copies of the Zulip git repo that you are generally concerned with: @@ -48,7 +48,6 @@ working copies: - `git fetch`: This grabs code from another repo to your local copy. - `git push`: This pushes code from your local repo to one of the remotes. -- `git remote`: This helps you configure short names for remotes. (Your - mentor can help you with this.) +- `git remote`: This helps you configure short names for remotes. - `git pull`: **Do not use this, please**!