Skip to content

G
gitlab-ce
Commit 2a45abbf authored by Evan Read's avatar Evan Read
Browse files
Options

Improve markdown and fix links that don't render correctly

parent 31733b6f
Show whitespace changes
Inline Side-by-side
Showing with 131 additions and 136 deletions
doc/university/training/user_training.md
View file @ 2a45abbf
...@@ -6,91 +6,90 @@ comments: false ...@@ -6,91 +6,90 @@ comments: false
--- ---
# Agenda ## Agenda
1. Brief history of Git 1. Brief history of Git.
1. GitLab walkthrough 1. GitLab walkthrough.
1. Configure your environment 1. Configure your environment.
1. Workshop 1. Workshop.
--- ---
# Git introduction ## Git introduction
https://git-scm.com/about <https://git-scm.com/about>
- Distributed version control - Distributed version control.
- Does not rely on connection to a central server - Does not rely on connection to a central server.
- Many copies of the complete history - Many copies of the complete history.
- Powerful branching and merging - Powerful branching and merging.
- Adapts to nearly any workflow - Adapts to nearly any workflow.
- Fast, reliable and stable file format - Fast, reliable and stable file format.
--- ---
# Help! ## Help!
Use the tools at your disposal when you get stuck. Use the tools at your disposal when you get stuck.
- Use '`git help <command>`' command - Use '`git help <command>`' command.
- Use Google - Use Google.
- Read documentation at https://git-scm.com - Read documentation at <https://git-scm.com>.
--- ---
# GitLab Walkthrough ## GitLab Walkthrough
![fit](logo.png) ![fit](logo.png)
--- ---
# Configure your environment ## Configure your environment
- Windows: Install 'Git for Windows' - Windows: Install 'Git for Windows'
> https://git-for-windows.github.io > <https://git-for-windows.github.io>
- Mac: Type '`git`' in the Terminal application. - Mac: Type '`git`' in the Terminal application.
> If it's not installed, it will prompt you to install it. > If it's not installed, it will prompt you to install it.
- Debian: '`sudo apt-get install git-all`' - Debian: '`sudo apt-get install git-all`' or Red Hat '`sudo yum install git-all`'
or Red Hat '`sudo yum install git-all`'
--- ---
# Git Workshop ## Git Workshop
## Overview ### Overview
1. Configure Git 1. Configure Git.
1. Configure SSH Key 1. Configure SSH Key.
1. Create a project 1. Create a project.
1. Committing 1. Committing.
1. Feature branching 1. Feature branching.
1. Merge requests 1. Merge requests.
1. Feedback and Collaboration 1. Feedback and Collaboration.
--- ---
# Configure Git ## Configure Git
One-time configuration of the Git client One-time configuration of the Git client:
```bash ```sh
git config --global user.name "Your Name" git config --global user.name "Your Name"
git config --global user.email you@example.com git config --global user.email you@example.com
``` ```
--- ---
# Configure SSH Key ## Configure SSH Key
```bash ```sh
ssh-keygen -t rsa -b 4096 -C "you@computer-name" ssh-keygen -t rsa -b 4096 -C "you@computer-name"
``` ```
```bash ```sh
# You will be prompted for the following information. Press enter to accept the defaults. Defaults appear in parentheses. # You will be prompted for the following information. Press enter to accept the defaults. Defaults appear in parentheses.
Generating public/private rsa key pair. Generating public/private rsa key pair.
Enter file in which to save the key (/Users/you/.ssh/id_rsa): Enter file in which to save the key (/Users/you/.ssh/id_rsa):
...@@ -102,31 +101,30 @@ The key fingerprint is: ...@@ -102,31 +101,30 @@ The key fingerprint is:
39:fc:ce:94:f4:09:13:95:64:9a:65:c1:de:05:4d:01 you@computer-name 39:fc:ce:94:f4:09:13:95:64:9a:65:c1:de:05:4d:01 you@computer-name
``` ```
Copy your public key and add it to your GitLab profile Copy your public key and add it to your GitLab profile:
```bash ```sh
cat ~/.ssh/id_rsa.pub cat ~/.ssh/id_rsa.pub
``` ```
```bash ```sh
ssh-rsa AAAAB3NzaC1yc2EAAAADAQEL17Ufacg8cDhlQMS5NhV8z3GHZdhCrZbl4gz you@example.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQEL17Ufacg8cDhlQMS5NhV8z3GHZdhCrZbl4gz you@example.com
``` ```
--- ---
# Create a project ## Create a project
- Create a project in your user namespace - Create a project in your user namespace.
- Choose to import from 'Any Repo by URL' and use - Choose to import from 'Any Repo by URL' and use <https://gitlab.com/gitlab-org/training-examples.git>.
https://gitlab.com/gitlab-org/training-examples.git
- Create a '`development`' or '`workspace`' directory in your home directory. - Create a '`development`' or '`workspace`' directory in your home directory.
- Clone the '`training-examples`' project - Clone the '`training-examples`' project.
--- ---
# Commands ## Commands (project)
``` ```sh
mkdir ~/development mkdir ~/development
cd ~/development cd ~/development
...@@ -141,37 +139,37 @@ cd training-examples ...@@ -141,37 +139,37 @@ cd training-examples
--- ---
# Git concepts ## Git concepts
**Untracked files** ### Untracked files
New files that Git has not been told to track previously. New files that Git has not been told to track previously.
**Working area** ### Working area
Files that have been modified but are not committed. Files that have been modified but are not committed.
**Staging area** ### Staging area
Modified files that have been marked to go in the next commit. Modified files that have been marked to go in the next commit.
--- ---
# Committing ## Committing
1. Edit '`edit_this_file.rb`' in '`training-examples`' 1. Edit '`edit_this_file.rb`' in '`training-examples`'.
1. See it listed as a changed file (working area) 1. See it listed as a changed file (working area).
1. View the differences 1. View the differences.
1. Stage the file 1. Stage the file.
1. Commit 1. Commit.
1. Push the commit to the remote 1. Push the commit to the remote.
1. View the git log 1. View the git log.
--- ---
# Commands ## Commands (committing)
``` ```sh
# Edit `edit_this_file.rb` # Edit `edit_this_file.rb`
git status git status
git diff git diff
...@@ -183,29 +181,29 @@ git log ...@@ -183,29 +181,29 @@ git log
--- ---
# Feature branching ## Feature branching
- Efficient parallel workflow for teams - Efficient parallel workflow for teams.
- Develop each feature in a branch - Develop each feature in a branch.
- Keeps changes isolated - Keeps changes isolated.
- Consider a 1-to-1 link to issues - Consider a 1-to-1 link to issues.
- Push branches to the server frequently - Push branches to the server frequently.
- Hint: This is a cheap backup for your work-in-progress code - Hint: This is a cheap backup for your work-in-progress code.
--- ---
# Feature branching ## Feature branching steps
1. Create a new feature branch called 'squash_some_bugs' 1. Create a new feature branch called 'squash_some_bugs'.
1. Edit '`bugs.rb`' and remove all the bugs. 1. Edit '`bugs.rb`' and remove all the bugs.
1. Commit 1. Commit.
1. Push 1. Push.
--- ---
# Commands ## Commands (feature branching)
``` ```sh
git checkout -b squash_some_bugs git checkout -b squash_some_bugs
# Edit `bugs.rb` # Edit `bugs.rb`
git status git status
...@@ -216,51 +214,50 @@ git push origin squash_some_bugs ...@@ -216,51 +214,50 @@ git push origin squash_some_bugs
--- ---
# Merge requests ## Merge requests
- When you want feedback create a merge request - When you want feedback create a merge request.
- Target is the ‘default’ branch (usually master) - Target is the ‘default’ branch (usually master).
- Assign or mention the person you would like to review - Assign or mention the person you would like to review.
- Add 'WIP' to the title if it's a work in progress - Add 'WIP' to the title if it's a work in progress.
- When accepting, always delete the branch - When accepting, always delete the branch.
- Anyone can comment, not just the assignee - Anyone can comment, not just the assignee.
- Push corrections to the same branch - Push corrections to the same branch.
--- ---
# Merge requests ## Merge requests steps
**Create your first merge request** Create your first merge request:
1. Use the blue button in the activity feed 1. Use the blue button in the activity feed.
1. View the diff (changes) and leave a comment 1. View the diff (changes) and leave a comment.
1. Push a new commit to the same branch 1. Push a new commit to the same branch.
1. Review the changes again and notice the update 1. Review the changes again and notice the update.
--- ---
# Feedback and Collaboration ## Feedback and Collaboration
- Merge requests are a time for feedback and collaboration - Merge requests are a time for feedback and collaboration.
- Giving feedback is hard - Giving feedback is hard.
- Be as kind as possible - Be as kind as possible.
- Receiving feedback is hard - Receiving feedback is hard.
- Be as receptive as possible - Be as receptive as possible.
- Feedback is about the best code, not the person. You are not your code - Feedback is about the best code, not the person. You are not your code.
--- ---
# Feedback and Collaboration ## Feedback and Collaboration resources
Review the Thoughtbot code-review guide for suggestions to follow when reviewing merge requests: Review the Thoughtbot code-review guide for suggestions to follow when reviewing merge requests:
[https://github.com/thoughtbot/guides/tree/master/code-review](https://github.com/thoughtbot/guides/tree/master/code-review) <https://github.com/thoughtbot/guides/tree/master/code-review>.
See GitLab merge requests for examples: See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce/merge_requests>.
[https://gitlab.com/gitlab-org/gitlab-ce/merge_requests](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests)
--- ---
# Explore GitLab projects ## Explore GitLab projects
![fit](logo.png) ![fit](logo.png)
...@@ -274,31 +271,29 @@ See GitLab merge requests for examples: ...@@ -274,31 +271,29 @@ See GitLab merge requests for examples:
--- ---
# Tags ## Tags
- Useful for marking deployments and releases - Useful for marking deployments and releases.
- Annotated tags are an unchangeable part of Git history - Annotated tags are an unchangeable part of Git history.
- Soft/lightweight tags can be set and removed at will - Soft/lightweight tags can be set and removed at will.
- Many projects combine an annotated release tag with a stable branch - Many projects combine an annotated release tag with a stable branch.
- Consider setting deployment/release tags automatically - Consider setting deployment/release tags automatically.
--- ---
# Tags ## Tags steps
- Create a lightweight tag
- Create an annotated tag
- Push the tags to the remote repository
**Additional resources** 1. Create a lightweight tag.
1. Create an annotated tag.
1. Push the tags to the remote repository.
[http://git-scm.com/book/en/Git-Basics-Tagging](http://git-scm.com/book/en/Git-Basics-Tagging) Additional resources: <http://git-scm.com/book/en/Git-Basics-Tagging>.
--- ---
# Commands ## Commands (tags)
``` ```sh
git checkout master git checkout master
# Lightweight tag # Lightweight tag
...@@ -313,31 +308,31 @@ git push origin --tags ...@@ -313,31 +308,31 @@ git push origin --tags
--- ---
# Merge conflicts ## Merge conflicts
- Happen often - Happen often.
- Learning to fix conflicts is hard - Learning to fix conflicts is hard.
- Practice makes perfect - Practice makes perfect.
- Force push after fixing conflicts. Be careful! - Force push after fixing conflicts. Be careful!
--- ---
# Merge conflicts ## Merge conflicts steps
1. Checkout a new branch and edit `conflicts.rb`. Add 'Line4' and 'Line5'. 1. Checkout a new branch and edit `conflicts.rb`. Add 'Line4' and 'Line5'.
1. Commit and push 1. Commit and push.
1. Checkout master and edit `conflicts.rb`. Add 'Line6' and 'Line7' below 'Line3'. 1. Checkout master and edit `conflicts.rb`. Add 'Line6' and 'Line7' below 'Line3'.
1. Commit and push to master 1. Commit and push to master.
1. Create a merge request 1. Create a merge request.
--- ---
# Merge conflicts ## Merge conflicts commands
After creating a merge request you should notice that conflicts exist. Resolve After creating a merge request you should notice that conflicts exist. Resolve
the conflicts locally by rebasing. the conflicts locally by rebasing.
``` ```sh
git rebase master git rebase master
# Fix conflicts by editing the files. # Fix conflicts by editing the files.
...@@ -350,7 +345,7 @@ git push origin <branch> -f ...@@ -350,7 +345,7 @@ git push origin <branch> -f
--- ---
# Rebase with squash ## Rebase with squash
You may end up with a commit log that looks like this: You may end up with a commit log that looks like this:
...@@ -368,11 +363,11 @@ Squash these in to meaningful commits using an interactive rebase. ...@@ -368,11 +363,11 @@ Squash these in to meaningful commits using an interactive rebase.
--- ---
# Rebase with squash ## Rebase with squash commands
Squash the commits on the same branch we used for the merge conflicts step. Squash the commits on the same branch we used for the merge conflicts step.
``` ```sh
git rebase -i master git rebase -i master
``` ```
...@@ -380,17 +375,17 @@ In the editor, leave the first commit as 'pick' and set others to 'fixup'. ...@@ -380,17 +375,17 @@ In the editor, leave the first commit as 'pick' and set others to 'fixup'.
--- ---
# Questions? ## Questions?
![fit](logo.png) ![fit](logo.png)
Thank you for your hard work! Thank you for your hard work!
**Additional Resources** ## Additional Resources
GitLab Documentation [http://docs.gitlab.com](http://docs.gitlab.com/) - GitLab Documentation: <http://docs.gitlab.com/>.
GUI Clients [http://git-scm.com/downloads/guis](http://git-scm.com/downloads/guis) - GUI Clients: <http://git-scm.com/downloads/guis>.
Pro git book [http://git-scm.com/book](http://git-scm.com/book) - Pro git book: <http://git-scm.com/book>.
Platzi Course [https://courses.platzi.com/courses/git-gitlab/](https://courses.platzi.com/courses/git-gitlab/) - Platzi Course: <https://courses.platzi.com/courses/git-gitlab/>.
Code School tutorial [http://try.github.io/](http://try.github.io/) - Code School tutorial: <http://try.github.io/>.
Contact Us at `subscribers@gitlab.com` - Contact us at `subscribers@gitlab.com`.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7