Skip to content

G
gitlab-ce
Commit c403fdd7 authored by Evan Read's avatar Evan Read Committed by Achilleas Pipinellis
Browse files
Options

SSoT audit fixes for GitLab U topics 

Also improves the markdown in that section.
parent 6050b348
Show whitespace changes
Inline Side-by-side
Showing with 266 additions and 775 deletions
doc/administration/index.md
View file @ c403fdd7
...@@ -36,7 +36,7 @@ Learn how to install, configure, update, and maintain your GitLab instance. ...@@ -36,7 +36,7 @@ Learn how to install, configure, update, and maintain your GitLab instance.
- [Omnibus support for external MySQL DB](https://docs.gitlab.com/omnibus/settings/database.html#using-a-mysql-database-management-server-enterprise-edition-only): Omnibus package supports configuring an external MySQL database. **[STARTER ONLY]** - [Omnibus support for external MySQL DB](https://docs.gitlab.com/omnibus/settings/database.html#using-a-mysql-database-management-server-enterprise-edition-only): Omnibus package supports configuring an external MySQL database. **[STARTER ONLY]**
- [Omnibus support for log forwarding](https://docs.gitlab.com/omnibus/settings/logs.html#udp-log-shipping-gitlab-enterprise-edition-only) **[STARTER ONLY]** - [Omnibus support for log forwarding](https://docs.gitlab.com/omnibus/settings/logs.html#udp-log-shipping-gitlab-enterprise-edition-only) **[STARTER ONLY]**
- [High Availability](high_availability/README.md): Configure multiple servers for scaling or high availability. - [High Availability](high_availability/README.md): Configure multiple servers for scaling or high availability.
- [High Availability on AWS](../university/high-availability/aws/README.md): Set up GitLab HA on Amazon AWS. - [Installing GitLab HA on Amazon Web Services (AWS)](../install/aws/index.md): Set up GitLab High Availability on Amazon AWS.
- [Geo](geo/replication/index.md): Replicate your GitLab instance to other geographic locations as a read-only fully operational version. **[PREMIUM ONLY]** - [Geo](geo/replication/index.md): Replicate your GitLab instance to other geographic locations as a read-only fully operational version. **[PREMIUM ONLY]**
- [Disaster Recovery](geo/disaster_recovery/index.md): Quickly fail-over to a different site with minimal effort in a disaster situation. **[PREMIUM ONLY]** - [Disaster Recovery](geo/disaster_recovery/index.md): Quickly fail-over to a different site with minimal effort in a disaster situation. **[PREMIUM ONLY]**
- [Pivotal Tile](../install/pivotal/index.md): Deploy GitLab as a pre-configured appliance using Ops Manager (BOSH) for Pivotal Cloud Foundry. **[PREMIUM ONLY]** - [Pivotal Tile](../install/pivotal/index.md): Deploy GitLab as a pre-configured appliance using Ops Manager (BOSH) for Pivotal Cloud Foundry. **[PREMIUM ONLY]**
......
doc/university/README.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: index
--- ---
# GitLab University # GitLab University
...@@ -8,26 +9,22 @@ GitLab University is a great place to start when learning about version control ...@@ -8,26 +9,22 @@ GitLab University is a great place to start when learning about version control
If you're looking for a GitLab subscription for _your university_, see our [Education](https://about.gitlab.com/solutions/education/) page. If you're looking for a GitLab subscription for _your university_, see our [Education](https://about.gitlab.com/solutions/education/) page.
## GitLab University Curriculum The GitLab University curriculum is composed of GitLab videos, screencasts, presentations, projects and external GitLab content hosted on other services and has been organized into the following sections:
The curriculum is composed of GitLab videos, screencasts, presentations, projects and external GitLab content hosted on other services and has been organized into the following sections. 1. [GitLab Beginner](#1-gitlab-beginner).
1. [GitLab Intermediate](#2-gitlab-intermediate).
1. [GitLab Advanced](#3-gitlab-advanced).
1. [External Articles](#4-external-articles).
1. [Resources for GitLab Team Members](#5-resources-for-gitlab-team-members).
1. [GitLab Beginner](#1-gitlab-beginner) ## 1. GitLab Beginner
1. [GitLab Intermediate](#2-gitlab-intermediate)
1. [GitLab Advanced](#3-gitlab-advanced)
1. [External Articles](#4-external-articles)
1. [Resources for GitLab Team Members](#5-resources-for-gitlab-team-members)
--- ### 1.1. Version Control and Git
### 1. GitLab Beginner
#### 1.1. Version Control and Git
1. [Version Control Systems](https://docs.google.com/presentation/d/16sX7hUrCZyOFbpvnrAFrg6tVO5_yT98IgdAqOmXwBho/edit#slide=id.g72f2e4906_2_29) 1. [Version Control Systems](https://docs.google.com/presentation/d/16sX7hUrCZyOFbpvnrAFrg6tVO5_yT98IgdAqOmXwBho/edit#slide=id.g72f2e4906_2_29)
1. [Code School: An Introduction to Git](https://www.codeschool.com/account/courses/try-git) 1. [Code School: An Introduction to Git](https://www.codeschool.com/account/courses/try-git)
#### 1.2. GitLab Basics ### 1.2. GitLab Basics
1. [An Overview of GitLab.com - Video](https://www.youtube.com/watch?v=WaiL5DGEMR4) 1. [An Overview of GitLab.com - Video](https://www.youtube.com/watch?v=WaiL5DGEMR4)
1. [Why Use Git and GitLab - Slides](https://docs.google.com/a/gitlab.com/presentation/d/1RcZhFmn5VPvoFu6UMxhMOy7lAsToeBZRjLRn0LIdaNc/edit?usp=drive_web) 1. [Why Use Git and GitLab - Slides](https://docs.google.com/a/gitlab.com/presentation/d/1RcZhFmn5VPvoFu6UMxhMOy7lAsToeBZRjLRn0LIdaNc/edit?usp=drive_web)
...@@ -36,12 +33,12 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -36,12 +33,12 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [Git and GitLab Basics - Online Course](https://courses.platzi.com/classes/git-gitlab/concepto/part-1/part-23370/material/) 1. [Git and GitLab Basics - Online Course](https://courses.platzi.com/classes/git-gitlab/concepto/part-1/part-23370/material/)
1. [Comparison of GitLab Versions](https://about.gitlab.com/features/#compare) 1. [Comparison of GitLab Versions](https://about.gitlab.com/features/#compare)
#### 1.3. Your GitLab Account ### 1.3. Your GitLab Account
1. [Create a GitLab Account - Online Course](https://courses.platzi.com/classes/git-gitlab/concepto/first-steps/create-an-account-on-gitlab/material/) 1. [Create a GitLab Account - Online Course](https://courses.platzi.com/classes/git-gitlab/concepto/first-steps/create-an-account-on-gitlab/material/)
1. [Create and Add your SSH key to GitLab - Video](https://www.youtube.com/watch?v=54mxyLo3Mqk) 1. [Create and Add your SSH key to GitLab - Video](https://www.youtube.com/watch?v=54mxyLo3Mqk)
#### 1.4. GitLab Projects ### 1.4. GitLab Projects
1. [Repositories, Projects and Groups - Video](https://www.youtube.com/watch?v=4TWfh1aKHHw&index=1&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e) 1. [Repositories, Projects and Groups - Video](https://www.youtube.com/watch?v=4TWfh1aKHHw&index=1&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e)
1. [Creating a Project in GitLab - Video](https://www.youtube.com/watch?v=7p0hrpNaJ14) 1. [Creating a Project in GitLab - Video](https://www.youtube.com/watch?v=7p0hrpNaJ14)
...@@ -49,14 +46,14 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -49,14 +46,14 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [GitLab Todos](https://about.gitlab.com/2016/03/02/gitlab-todos-feature-highlight/) 1. [GitLab Todos](https://about.gitlab.com/2016/03/02/gitlab-todos-feature-highlight/)
1. [GitLab's Work in Progress (WIP) Flag](https://about.gitlab.com/2016/01/08/feature-highlight-wip/) 1. [GitLab's Work in Progress (WIP) Flag](https://about.gitlab.com/2016/01/08/feature-highlight-wip/)
#### 1.5. Migrating from other Source Control ### 1.5. Migrating from other Source Control
1. [Migrating from BitBucket/Stash](../user/project/import/bitbucket.md) 1. [Migrating from BitBucket/Stash](../user/project/import/bitbucket.md)
1. [Migrating from GitHub](../user/project/import/github.md) 1. [Migrating from GitHub](../user/project/import/github.md)
1. [Migrating from SVN](../user/project/import/svn.md) 1. [Migrating from SVN](../user/project/import/svn.md)
1. [Migrating from Fogbugz](../user/project/import/fogbugz.md) 1. [Migrating from Fogbugz](../user/project/import/fogbugz.md)
#### 1.6. GitLab Inc. ### 1.6. GitLab Inc.
1. [About GitLab](https://about.gitlab.com/about/) 1. [About GitLab](https://about.gitlab.com/about/)
1. [GitLab Direction](https://about.gitlab.com/direction/) 1. [GitLab Direction](https://about.gitlab.com/direction/)
...@@ -67,7 +64,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -67,7 +64,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [The GitLab Book Club](bookclub/index.md) 1. [The GitLab Book Club](bookclub/index.md)
1. [GitLab Resources](https://about.gitlab.com/resources/) 1. [GitLab Resources](https://about.gitlab.com/resources/)
#### 1.7 Community and Support ### 1.7 Community and Support
1. [Getting Help](https://about.gitlab.com/getting-help/) 1. [Getting Help](https://about.gitlab.com/getting-help/)
- Proposing Features and Reporting and Tracking bugs for GitLab - Proposing Features and Reporting and Tracking bugs for GitLab
...@@ -79,22 +76,20 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -79,22 +76,20 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [GitLab Training Workshops](https://docs.gitlab.com/ce/university/training/end-user/) 1. [GitLab Training Workshops](https://docs.gitlab.com/ce/university/training/end-user/)
1. [GitLab Professional Services](https://about.gitlab.com/services/) 1. [GitLab Professional Services](https://about.gitlab.com/services/)
#### 1.8 GitLab Training Material ### 1.8 GitLab Training Material
1. [Git and GitLab Terminology](glossary/README.md) 1. [Git and GitLab Terminology](glossary/README.md)
1. [Git and GitLab Workshop - Slides](https://docs.google.com/presentation/d/1JzTYD8ij9slejV2-TO-NzjCvlvj6mVn9BORePXNJoMI/edit?usp=drive_web) 1. [Git and GitLab Workshop - Slides](https://docs.google.com/presentation/d/1JzTYD8ij9slejV2-TO-NzjCvlvj6mVn9BORePXNJoMI/edit?usp=drive_web)
--- ## 2. GitLab Intermediate
### 2. GitLab Intermediate
#### 2.1 GitLab Pages ### 2.1 GitLab Pages
1. [Using any Static Site Generator with GitLab Pages](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/) 1. [Using any Static Site Generator with GitLab Pages](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/)
1. [Securing GitLab Pages with SSL](https://about.gitlab.com/2016/06/24/secure-gitlab-pages-with-startssl/) 1. [Securing GitLab Pages with SSL](https://about.gitlab.com/2016/06/24/secure-gitlab-pages-with-startssl/)
1. [GitLab Pages Documentation](../user/project/pages/index.md) 1. [GitLab Pages Documentation](../user/project/pages/index.md)
#### 2.2. GitLab Issues ### 2.2. GitLab Issues
1. [Markdown in GitLab](../user/markdown.md) 1. [Markdown in GitLab](../user/markdown.md)
1. [Issues and Merge Requests - Video](https://www.youtube.com/watch?v=raXvuwet78M) 1. [Issues and Merge Requests - Video](https://www.youtube.com/watch?v=raXvuwet78M)
...@@ -106,7 +101,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -106,7 +101,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [Designing GitLab Issue Board](https://about.gitlab.com/2016/08/31/designing-issue-boards/) 1. [Designing GitLab Issue Board](https://about.gitlab.com/2016/08/31/designing-issue-boards/)
1. [From Idea to Production with GitLab - Video](https://www.youtube.com/watch?v=25pHyknRgEo&index=14&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e) 1. [From Idea to Production with GitLab - Video](https://www.youtube.com/watch?v=25pHyknRgEo&index=14&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e)
#### 2.3. Continuous Integration ### 2.3. Continuous Integration
1. [Operating Systems, Servers, VMs, Containers and Unix - Video](https://www.youtube.com/watch?v=V61kL6IC-zY&index=8&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e) 1. [Operating Systems, Servers, VMs, Containers and Unix - Video](https://www.youtube.com/watch?v=V61kL6IC-zY&index=8&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e)
1. [GitLab CI - Product Page](https://about.gitlab.com/gitlab-ci/) 1. [GitLab CI - Product Page](https://about.gitlab.com/gitlab-ci/)
...@@ -125,7 +120,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -125,7 +120,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [TechBeacon: Doing continuous delivery? Focus first on reducing release cycle times](https://techbeacon.com/doing-continuous-delivery-focus-first-reducing-release-cycle-times) 1. [TechBeacon: Doing continuous delivery? Focus first on reducing release cycle times](https://techbeacon.com/doing-continuous-delivery-focus-first-reducing-release-cycle-times)
1. See **[Integrations](#39-integrations)** for integrations with other CI services. 1. See **[Integrations](#39-integrations)** for integrations with other CI services.
#### 2.4. Workflow ### 2.4. Workflow
1. [GitLab Flow - Video](https://youtu.be/enMumwvLAug?list=PLFGfElNsQthZnwMUFi6rqkyUZkI00OxIV) 1. [GitLab Flow - Video](https://youtu.be/enMumwvLAug?list=PLFGfElNsQthZnwMUFi6rqkyUZkI00OxIV)
1. [GitLab Flow vs Forking in GitLab - Video](https://www.youtube.com/watch?v=UGotqAUACZA) 1. [GitLab Flow vs Forking in GitLab - Video](https://www.youtube.com/watch?v=UGotqAUACZA)
...@@ -133,7 +128,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -133,7 +128,7 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [Always Start with an Issue](https://about.gitlab.com/2016/03/03/start-with-an-issue/) 1. [Always Start with an Issue](https://about.gitlab.com/2016/03/03/start-with-an-issue/)
1. [GitLab Flow Documentation](../workflow/gitlab_flow.md) 1. [GitLab Flow Documentation](../workflow/gitlab_flow.md)
#### 2.5. GitLab Comparisons ### 2.5. GitLab Comparisons
1. [GitLab Compared to Other Tools](https://about.gitlab.com/comparison/) 1. [GitLab Compared to Other Tools](https://about.gitlab.com/comparison/)
1. [Comparing GitLab Terminology](https://about.gitlab.com/2016/01/27/comparing-terms-gitlab-github-bitbucket/) 1. [Comparing GitLab Terminology](https://about.gitlab.com/2016/01/27/comparing-terms-gitlab-github-bitbucket/)
...@@ -141,17 +136,15 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -141,17 +136,15 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [GitLab Position FAQ](https://about.gitlab.com/handbook/positioning-faq) 1. [GitLab Position FAQ](https://about.gitlab.com/handbook/positioning-faq)
1. [Customer review of GitLab with points on why they prefer GitLab](https://www.enovate.co.uk/web-design-blog/2015/11/25/gitlab-review/) 1. [Customer review of GitLab with points on why they prefer GitLab](https://www.enovate.co.uk/web-design-blog/2015/11/25/gitlab-review/)
--- ## 3. GitLab Advanced
### 3. GitLab Advanced ### 3.1. Dev Ops
#### 3.1. Dev Ops
1. [Xebia Labs: Dev Ops Terminology](https://xebialabs.com/glossary/) 1. [Xebia Labs: Dev Ops Terminology](https://xebialabs.com/glossary/)
1. [Xebia Labs: Periodic Table of DevOps Tools](https://xebialabs.com/periodic-table-of-devops-tools/) 1. [Xebia Labs: Periodic Table of DevOps Tools](https://xebialabs.com/periodic-table-of-devops-tools/)
1. [Puppet Labs: State of Dev Ops 2016 - Book](https://puppet.com/resources/white-paper/2016-state-of-devops-report) 1. [Puppet Labs: State of Dev Ops 2016 - Book](https://puppet.com/resources/white-paper/2016-state-of-devops-report)
#### 3.2. Installing GitLab with Omnibus ### 3.2. Installing GitLab with Omnibus
1. [What is Omnibus - Video](https://www.youtube.com/watch?v=XTmpKudd-Oo) 1. [What is Omnibus - Video](https://www.youtube.com/watch?v=XTmpKudd-Oo)
1. [How to Install GitLab with Omnibus - Video](https://www.youtube.com/watch?v=Q69YaOjqNhg) 1. [How to Install GitLab with Omnibus - Video](https://www.youtube.com/watch?v=Q69YaOjqNhg)
...@@ -161,34 +154,34 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -161,34 +154,34 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [Installing GitLab on Microsoft Azure](https://about.gitlab.com/2016/07/13/how-to-setup-a-gitlab-instance-on-microsoft-azure/) 1. [Installing GitLab on Microsoft Azure](https://about.gitlab.com/2016/07/13/how-to-setup-a-gitlab-instance-on-microsoft-azure/)
1. [Installing GitLab on Digital Ocean](https://about.gitlab.com/2016/04/27/getting-started-with-gitlab-and-digitalocean/) 1. [Installing GitLab on Digital Ocean](https://about.gitlab.com/2016/04/27/getting-started-with-gitlab-and-digitalocean/)
#### 3.3. Permissions ### 3.3. Permissions
1. [How to Manage Permissions in GitLab EE - Video](https://www.youtube.com/watch?v=DjUoIrkiNuM) 1. [How to Manage Permissions in GitLab EE - Video](https://www.youtube.com/watch?v=DjUoIrkiNuM)
#### 3.4. Large Files ### 3.4. Large Files
1. [Big files in Git (Git LFS) - Video](https://www.youtube.com/watch?v=DawznUxYDe4) 1. [Big files in Git (Git LFS) - Video](https://www.youtube.com/watch?v=DawznUxYDe4)
#### 3.5. LDAP and Active Directory ### 3.5. LDAP and Active Directory
1. [How to Manage LDAP, Active Directory in GitLab - Video](https://www.youtube.com/watch?v=HPMjM-14qa8) 1. [How to Manage LDAP, Active Directory in GitLab - Video](https://www.youtube.com/watch?v=HPMjM-14qa8)
#### 3.6 Custom Languages ### 3.6 Custom Languages
1. [How to add Syntax Highlighting Support for Custom Languages to GitLab - Video](https://youtu.be/6WxTMqatrrA) 1. [How to add Syntax Highlighting Support for Custom Languages to GitLab - Video](https://youtu.be/6WxTMqatrrA)
#### 3.7. Scalability and High Availability ### 3.7. Scalability and High Availability
1. [Scalability and High Availability - Video](https://www.youtube.com/watch?v=cXRMJJb6sp4&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e&index=2) 1. [Scalability and High Availability - Video](https://www.youtube.com/watch?v=cXRMJJb6sp4&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e&index=2)
1. [High Availability - Video](https://www.youtube.com/watch?v=36KS808u6bE&index=15&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e) 1. [High Availability - Video](https://www.youtube.com/watch?v=36KS808u6bE&index=15&list=PLFGfElNsQthbQu_IWlNOxul0TbS_2JH-e)
1. [High Availability Documentation](https://about.gitlab.com/high-availability/) 1. [High Availability Documentation](https://about.gitlab.com/high-availability/)
#### 3.8 Cycle Analytics ### 3.8 Cycle Analytics
1. [GitLab Cycle Analytics Overview](https://about.gitlab.com/2016/09/21/cycle-analytics-feature-highlight/) 1. [GitLab Cycle Analytics Overview](https://about.gitlab.com/2016/09/21/cycle-analytics-feature-highlight/)
1. [GitLab Cycle Analytics - Product Page](https://about.gitlab.com/product/cycle-analytics/) 1. [GitLab Cycle Analytics - Product Page](https://about.gitlab.com/product/cycle-analytics/)
#### 3.9. Integrations ### 3.9. Integrations
1. [How to Integrate JIRA and Jenkins with GitLab - Video](https://gitlabmeetings.webex.com/gitlabmeetings/ldr.php?RCID=44b548147a67ab4d8a62274047146415) 1. [How to Integrate JIRA and Jenkins with GitLab - Video](https://gitlabmeetings.webex.com/gitlabmeetings/ldr.php?RCID=44b548147a67ab4d8a62274047146415)
1. [How to Integrate Jira with GitLab](../user/project/integrations/jira.md) 1. [How to Integrate Jira with GitLab](../user/project/integrations/jira.md)
...@@ -198,25 +191,21 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project ...@@ -198,25 +191,21 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
1. [How to Integrate Convox with GitLab](https://about.gitlab.com/2016/06/09/continuous-delivery-with-gitlab-and-convox/) 1. [How to Integrate Convox with GitLab](https://about.gitlab.com/2016/06/09/continuous-delivery-with-gitlab-and-convox/)
1. [Getting Started with GitLab and Shippable CI](https://about.gitlab.com/2016/05/05/getting-started-gitlab-and-shippable/) 1. [Getting Started with GitLab and Shippable CI](https://about.gitlab.com/2016/05/05/getting-started-gitlab-and-shippable/)
--- ## 4. External Articles
### 4. External Articles
1. [2011 WSJ article by Marc Andreessen - Software is Eating the World](https://www.wsj.com/articles/SB10001424053111903480904576512250915629460) 1. [2011 WSJ article by Marc Andreessen - Software is Eating the World](https://www.wsj.com/articles/SB10001424053111903480904576512250915629460)
1. [2014 Blog post by Chris Dixon - Software eats software development](http://cdixon.org/2014/04/13/software-eats-software-development/) 1. [2014 Blog post by Chris Dixon - Software eats software development](http://cdixon.org/2014/04/13/software-eats-software-development/)
1. [2015 Venture Beat article - Actually, Open Source is Eating the World](http://venturebeat.com/2015/12/06/its-actually-open-source-software-thats-eating-the-world/) 1. [2015 Venture Beat article - Actually, Open Source is Eating the World](http://venturebeat.com/2015/12/06/its-actually-open-source-software-thats-eating-the-world/)
--- ## 5. Resources for GitLab Team Members
### 5. Resources for GitLab Team Members
NOTE: **Note:** NOTE: **Note:**
Some content can only be accessed by GitLab team members Some content can only be accessed by GitLab team members.
1. [Support Path](support/README.md) 1. [Support Path](support/README.md)
1. [Sales Path (redirect to sales handbook)](https://about.gitlab.com/handbook/sales-onboarding/) 1. [Sales Path](https://about.gitlab.com/handbook/sales-onboarding/)
1. [User Training](training/user_training.md) 1. [User Training](training/user_training.md)
1. [GitLab Flow Training](training/gitlab_flow.md) 1. [GitLab Flow Training](training/gitlab_flow.md)
1. [Training Topics](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/university/training/topics/) 1. [Training Topics](training/index.md)
1. [GitLab architecture for noobs](https://dev.gitlab.org/gitlab/gitlabhq/blob/master/doc/development/architecture.md) 1. [GitLab architecture](../development/architecture.md)
1. [Client Assessment of GitLab versus GitHub](https://docs.google.com/a/gitlab.com/spreadsheets/d/18cRF9Y5I6I7Z_ab6qhBEW55YpEMyU4PitZYjomVHM-M/edit?usp=sharing) 1. [Client Assessment of GitLab versus GitHub](https://docs.google.com/a/gitlab.com/spreadsheets/d/18cRF9Y5I6I7Z_ab6qhBEW55YpEMyU4PitZYjomVHM-M/edit?usp=sharing)
doc/university/bookclub/booklist.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: index
--- ---
# Books # Books
List of books and resources, that may be worth reading. List of books and resources that may be worth reading.
## Papers ## Papers
......
doc/university/bookclub/index.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: index
--- ---
# The GitLab Book Club # The GitLab Book Club
......
doc/university/high-availability/aws/README.md
View file @ c403fdd7
--- ---
comments: false redirect_to: '../../../install/aws/index.md'
--- ---
> **Note**: We **do not** recommend using the AWS Elastic File System (EFS), as it can result This document was moved to [another location](../../../install/aws/index.md).
in [significantly degraded performance](../../../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs).
# High Availability on AWS
GitLab on AWS can leverage many of the services that are already
configurable with High Availability. These services have a lot of
flexibility and are able to adapt to most companies, best of all is the
ability to automate both vertical and horizontal scaling.
In this article we'll go through a basic HA setup where we'll start by
configuring our Virtual Private Cloud and subnets to later integrate
services such as RDS for our database server and ElastiCache as a Redis
cluster to finally manage them within an auto scaling group with custom
scaling policies.
***
## Where to Start
Login to your AWS account through the `My Account` dropdown on
`https://aws.amazon.com` or through the URI assigned to your team such as
`https://myteam.signin.aws.amazon.com/console/`. You'll start on the
Amazon Web Services console from where we can choose all of the services
we'll be using to configure our cloud infrastructure.
### Reference Architecture
![Reference Architecture](img/reference-arch2.png)
***
## Network
We'll start by creating a VPC for our GitLab cloud infrastructure, then
we can create subnets to have public and private instances in at least
two AZs. Public subnets will require a Route Table keep an associated
Internet Gateway.
### VPC
Start by looking for the VPC option on the web console. Now create a new
VPC. We can use `10.0.0.0/16` for the CIDR block and leave tenancy as
default if we don't require dedicated hardware.
![New VPC](img/new_vpc.png)
If you're setting up the Elastic File System service then select the VPC
and from the Actions dropdown choose Edit DNS Hostnames and select Yes.
### Subnet
Now let's create some subnets in different Availability Zones. Make sure
that each subnet is associated to the VPC we just created, that it has
a distinct VPC and lastly that CIDR blocks don't overlap. This will also
allow us to enable multi-AZ for redundancy.
We will create private and public subnets to match load balancers and
RDS instances as well.
![Subnet Creation](img/subnet.png)
The subnets are listed with their name, AZ and CIDR block:
- gitlab-public-10.0.0.0 - us-west-2a - 10.0.0.0
- gitlab-private-10.0.1.0 - us-west-2a - 10.0.1.0
- gitlab-public-10.0.2.0 - us-west-2b - 10.0.2.0
- gitlab-private-10.0.3.0 - us-west-2b - 10.0.3.0
### Route Table
Up to now all our subnets are private. We need to create a Route Table
to associate an Internet Gateway. On the same VPC dashboard choose
Route Tables on the left column and give it a name and associate it to
our newly created VPC.
![Route Table](img/route_table.png)
### Internet Gateway
Now still on the same dashboard head over to Internet Gateways and
create a new one. After its created press on the `Attach to VPC` button and
select our VPC.
![Internet Gateway](img/ig.png)
### Configure Subnets
Go back to the Router Tables screen and select the newly created one,
press the Routes tab on the bottom section and edit it. We need to add a
new target which will be our Internet Gateway and have it receive
traffic from any destination.
![Subnet Config](img/ig-rt.png)
Before leaving this screen select the next tab to the right which is
Subnet Associations and add our public subnets. If you followed our
naming convention they should be easy to find.
***
## Database with RDS
For our database server we will use Amazon RDS which offers Multi-AZ
for redundancy. Let's start by creating a subnet group and then we'll
create the actual RDS instance.
### Subnet Group
From the RDS dashboard select Subnet Groups. Lets select our VPC from
the VPC ID dropdown and at the bottom we can add our private subnets.
![Subnet Group](img/db-subnet-group.png)
### RDS
Select the RDS service from the Database section and create a new
PostgreSQL instance. After choosing between a Production or
Development instance we'll start with the actual configuration. On the
image below we have the settings for this article but note the
following two options which are of particular interest for HA:
1. Multi-AZ-Deployment is recommended as redundancy. Read more at
[High Availability (Multi-AZ)](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html)
1. While we chose a General Purpose (SSD) for this article a Provisioned
IOPS (SSD) is best suited for HA. Read more about it at
[Storage for Amazon RDS](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)
![RDS Instance Specs](img/instance_specs.png)
The rest of the setting on this page request a DB identifier, username,
and a master password. We've chosen to use `gitlab-ha`, `gitlab` and a
very secure password respectively. Keep these in hand for later.
![Network and Security](img/rds-net-opt.png)
Make sure to choose our gitlab VPC, our subnet group, not have it public,
and to leave it to create a new security group. The only additional
change which will be helpful is the database name for which we can use
`gitlabhq_production`.
***
## ElastiCache
EC is an in-memory hosted caching solution. Redis maintains its own
persistence and is used for certain types of application.
Let's choose the ElastiCache service in the Database section from our
AWS console. Now let's create a cache subnet group which will be very
similar to the RDS subnet group. Make sure to select our VPC and its
private subnets.
![ElastiCache](img/ec-subnet.png)
Now press the Launch a Cache Cluster and choose Redis for our
DB engine. You'll be able to configure details such as replication,
Multi-AZ and node types. The second section will allow us to choose our
subnet and security group and
![Redis Cluster details](img/redis-cluster-det.png)
![Redis Network](img/redis-net.png)
***
## Network File System
GitLab requires a shared filesystem such as NFS. The file share(s) will be
mounted on all application servers. There are a variety of ways to build an
NFS server on AWS.
One option is to use a third-party AMI that offers NFS as a service. A [search
for 'NFS' in the AWS Marketplace](https://aws.amazon.com/marketplace/search/results?x=0&y=0&searchTerms=NFS&page=1&ref_=nav_search_box)
shows options such as NetApp, SoftNAS and others.
Another option is to build a simple NFS server using a vanilla Linux server backed
by AWS Elastic Block Storage (EBS).
> **Note:** GitLab does not recommend using AWS Elastic File System (EFS). See
details in [High Availability NFS documentation](../../../administration/high_availability/nfs.md#avoid-using-awss-elastic-file-system-efs)
***
## Initiate AMI
We are going to launch an EC2 instance and bake an image so that we can
later use it for auto scaling. We'll also take this opportunity to add an
extension to our RDS through this temporary EC2 instance.
### EC2 Instance
Look for the EC2 option and choose to create an instance. We'll need at
least a t2.medium type and for this article we'll choose an Ubuntu 14.04
HVM 64-bit. In the Configure Instance section choose our GitLab VPC and
a public subnet. I'd choose at least 10GB of storage.
In the security group we'll create a new one considering that we need to
SSH into the instance and also try it out through http. So let's add the
http traffic from anywhere and name it something such as
`gitlab-ec2-security-group`.
While we wait for it to launch we can allocate an Elastic IP and
associate it with our new EC2 instance.
### RDS and Redis Security Group
After the instance is being created we will navigate to our EC2 security
groups and add a small change for our EC2 instances to be able to
connect to RDS. First copy the security group name we just defined,
namely `gitlab-ec2-security-group`, and edit select the RDS security
group and edit the inbound rules. Choose the rule type to be PostgreSQL
and paste the name under source.
![RDS security group](img/rds-sec-group.png)
Similar to the above we'll jump to the `gitlab-ec2-security-group` group
and add a custom TCP rule for port 6379 accessible within itself.
### Install GitLab
To connect through SSH you will need to have the `pem` file which you
chose available and with the correct permissions such as `400`.
After accessing your server don't forget to update and upgrade your
packages.
sudo apt-get update && sudo apt-get upgrade -y
Then follow installation instructions from
[GitLab](https://about.gitlab.com/downloads-ee/#ubuntu1404), but before
running reconfigure we need to make sure all our services are tied down
so just leave the reconfigure command until after we edit our gitlab.rb
file.
### Extension for PostgreSQL
Connect to your new RDS instance to verify access and to install
a required extension. We can find the host or endpoint by selecting the
instance and we just created and after the details drop down we'll find
it labeled as 'Endpoint'; do remember not to include the colon and port
number.
sudo /opt/gitlab/embedded/bin/psql -U gitlab -h <rds-endpoint> -d gitlabhq_production
psql (9.4.7)
Type "help" for help.
gitlab=# CREATE EXTENSION pg_trgm;
gitlab=# \q
### Configure GitLab
While connected to your server edit the `gitlab.rb` file at `/etc/gitlab/gitlab.rb`
find the `external_url 'http://gitlab.example.com'` option and change it
to the domain you will be using or the public IP address of the current
instance to test the configuration.
For a more detailed description about configuring GitLab read [Configuring GitLab for HA](http://docs.gitlab.com/ee/administration/high_availability/gitlab.html)
Now look for the GitLab database settings and uncomment as necessary. In
our current case we'll specify the adapter, encoding, host, db name,
username, and password.
gitlab_rails['db_adapter'] = "postgresql"
gitlab_rails['db_encoding'] = "unicode"
gitlab_rails['db_database'] = "gitlabhq_production"
gitlab_rails['db_username'] = "gitlab"
gitlab_rails['db_password'] = "mypassword"
gitlab_rails['db_host'] = "<rds-endpoint>"
Next, we only need to configure the Redis section by adding the host and
uncommenting the port.
The last configuration step is to [change the default file locations ](http://docs.gitlab.com/ee/administration/high_availability/nfs.html)
to make the EFS integration easier to manage.
gitlab_rails['redis_host'] = "<redis-endpoint>"
gitlab_rails['redis_port'] = 6379
Finally, run reconfigure. You might find it useful to run a check and
a service status to make sure everything has been set up correctly.
sudo gitlab-ctl reconfigure
sudo gitlab-rake gitlab:check
sudo gitlab-ctl status
If everything looks good copy the Elastic IP over to your browser and
test the instance manually.
### AMI
After you finish testing your EC2 instance go back to its dashboard and
while the instance is selected press on the Actions dropdown to choose
Image -> Create an Image. Give it a name and description and confirm.
***
## Load Balancer
On the same dashboard look for Load Balancer on the left column and press
the Create button. Choose a classic Load Balancer, our gitlab VPC, not
internal and make sure its listening for HTTP and HTTPS on port 80.
Here is a tricky part though, when adding subnets we need to associate
public subnets instead of the private ones where our instances will
actually live.
On the security group section let's create a new one named
`gitlab-loadbalancer-sec-group` and allow both HTTP ad HTTPS traffic
from anywhere.
The Load Balancer Health will allow us to indicate where to ping and what
makes up a healthy or unhealthy instance.
We won't add the instance on the next session because we'll destroy it
momentarily as we'll be using the image we were creating. We will keep
the Enable Cross-Zone and Enable Connection Draining active.
After we finish creating the Load Balancer we can revisit our Security
Groups to improve access only through the ELB and any other requirement
you might have.
***
## Auto Scaling Group
Our AMI should be done by now so we can start working on our Auto
Scaling Group.
This option is also available through the EC2 dashboard on the left
sidebar. Press on the create button. Select the new image on My AMIs and
give it a `t2.medium` size. To be able to use Elastic File System we need
to add a script to mount EFS automatically at launch. We'll do this at
the Advanced Details section where we have a [User Data](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html)
text area that allows us to add a lot of custom configurations which
allows you to add a custom script for when launching an instance. Let's
add the following script to the User Data section:
#cloud-config
package_upgrade: true
packages:
- nfs-common
runcmd:
- mkdir -p /gitlab-data
- chown ec2-user:ec2-user /gitlab-data
- echo "$(curl --silent http://169.254.169.254/latest/meta-data/placement/availability-zone).file-system-id.aws-region.amazonaws.com:/ /gitlab-data nfs defaults,vers=4.1 0 0" >> /etc/fstab
- mount -a -t nfs
- sudo gitlab-ctl reconfigure
On the security group section we can choose our existing
`gitlab-ec2-security-group` group which has already been tested.
After this is launched we are able to start creating our Auto Scaling
Group. Start by giving it a name and assigning it our VPC and private
subnets. We also want to always start with two instances and if you
scroll down to Advanced Details we can choose to receive traffic from ELBs.
Let's enable that option and select our ELB. We also want to use the ELB's
health check.
![Auto scaling](img/auto-scaling-det.png)
### Policies
This is the really great part of Auto Scaling, we get to choose when AWS
launches new instances and when it removes them. For this group we'll
scale between 2 and 4 instances where one instance will be added if CPU
utilization is greater than 60% and one instance is removed if it falls
to less than 45%. Here are the complete policies:
![Policies](img/policies.png)
You'll notice that after we save this AWS starts launching our two
instances in different AZs and without a public IP which is exactly what
we where aiming for.
***
## Final Thoughts
After you're done with the policies section have some fun trying to break
instances. You should be able to see how the Auto Scaling Group and the
EC2 screen starts bringing them up again.
High Availability is a vast area, we went mostly through scaling and
some redundancy options but it might also imply Geographic replication.
There is a lot of ground yet to cover so have a read through these other
resources and feel free to open an issue to request additional material.
- [GitLab High Availability](../../../administration/high_availability/README.md)
- [GitLab Geo](../../../administration/geo/replication/index.md)
doc/university/support/README.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: reference
--- ---
# Support Boot Camp # Support Boot Camp
**Goal:** Prepare new Service Engineers at GitLab **Goal:** Prepare new Service Engineers at GitLab
For each stage there are learning goals and content to support the learning of the engineer. For each stage, there are learning goals and content to support the learning of the engineer.
The goal of this boot camp is to have every Service Engineer prepared to help our customers The goal of this boot camp is to have every Service Engineer prepared to help our customers
with whatever needs they might have and to also assist our awesome community with their with whatever needs they might have and to also assist our awesome community with their
questions. questions.
...@@ -15,7 +16,7 @@ Always start with the [University Overview](../README.md) and then work ...@@ -15,7 +16,7 @@ Always start with the [University Overview](../README.md) and then work
your way here for more advanced and specific training. Once you feel comfortable your way here for more advanced and specific training. Once you feel comfortable
with the topics of the current stage, move to the next. with the topics of the current stage, move to the next.
### Stage 1 ## Stage 1
Follow the topics on the [University Overview](../README.md), concentrate on it Follow the topics on the [University Overview](../README.md), concentrate on it
during your first Stage, but also: during your first Stage, but also:
...@@ -23,22 +24,22 @@ during your first Stage, but also: ...@@ -23,22 +24,22 @@ during your first Stage, but also:
- Perform the [first steps](https://about.gitlab.com/handbook/support/onboarding/#first-steps) of - Perform the [first steps](https://about.gitlab.com/handbook/support/onboarding/#first-steps) of
the on-boarding process for new Service Engineers the on-boarding process for new Service Engineers
#### Goals ### Goals
Aim to have a good overview of the Product and main features, Git and the Company Aim to have a good overview of the Product and main features, Git and the Company
### Stage 2 ## Stage 2
Continue to look over remaining portions of the [University Overview](../README.md) and continue on to these topics: Continue to look over remaining portions of the [University Overview](../README.md) and continue on to these topics:
#### Set up your development machine ### Set up your development machine
Get your development machine ready to familiarize yourself with the codebase, the components, and to be prepared to reproduce issues that our users encounter Get your development machine ready to familiarize yourself with the codebase, the components, and to be prepared to reproduce issues that our users encounter
- Install the [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit) - Install the [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit)
- [Set up OpenLDAP as part of this](https://gitlab.com/gitlab-org/gitlab-development-kit#openldap) - [Set up OpenLDAP as part of this](https://gitlab.com/gitlab-org/gitlab-development-kit#openldap)
#### Become comfortable with the Installation processes that we support ### Become comfortable with the Installation processes that we support
It's important to understand how to install GitLab in the same way that our users do. Try installing different versions and upgrading and downgrading between them. Installation from source will give you a greater understanding of the components that we employ and how everything fits together. It's important to understand how to install GitLab in the same way that our users do. Try installing different versions and upgrading and downgrading between them. Installation from source will give you a greater understanding of the components that we employ and how everything fits together.
...@@ -73,7 +74,7 @@ Sometimes we need to upgrade customers from old versions of GitLab to latest, so ...@@ -73,7 +74,7 @@ Sometimes we need to upgrade customers from old versions of GitLab to latest, so
- (GitLab inc. only) Acquire and apply a license for the Enterprise Edition product, ask in #support - (GitLab inc. only) Acquire and apply a license for the Enterprise Edition product, ask in #support
- Perform a downgrade from [EE to CE](../../downgrade_ee_to_ce/README.md) - Perform a downgrade from [EE to CE](../../downgrade_ee_to_ce/README.md)
#### Start to learn about some of the integrations that we support ### Start to learn about some of the integrations that we support
Our integrations add great value to GitLab. User questions often relate to integrating GitLab with existing external services and the configuration involved Our integrations add great value to GitLab. User questions often relate to integrating GitLab with existing external services and the configuration involved
...@@ -83,16 +84,16 @@ Our integrations add great value to GitLab. User questions often relate to integ ...@@ -83,16 +84,16 @@ Our integrations add great value to GitLab. User questions often relate to integ
- [Jenkins](../../integration/jenkins.md) - [Jenkins](../../integration/jenkins.md)
- [SAML](../../integration/saml.md) - [SAML](../../integration/saml.md)
#### Goals ### Goals
- Aim to be comfortable with installation of the GitLab product and configuration of some of the major integrations - Aim to be comfortable with installation of the GitLab product and configuration of some of the major integrations
- Aim to have an installation available for reproducing customer reports - Aim to have an installation available for reproducing customer reports
### Stage 3 ## Stage 3
#### Understand the gathering of diagnostics for GitLab instances ### Understand the gathering of diagnostics for GitLab instances
- Learn about the GitLab checks that are available - Learn about the GitLab checks that are available:
- [Environment Information and maintenance checks](../../raketasks/maintenance.md) - [Environment Information and maintenance checks](../../raketasks/maintenance.md)
- [GitLab check](../../raketasks/check.md) - [GitLab check](../../raketasks/check.md)
- Omnibus commands - Omnibus commands
...@@ -100,11 +101,11 @@ Our integrations add great value to GitLab. User questions often relate to integ ...@@ -100,11 +101,11 @@ Our integrations add great value to GitLab. User questions often relate to integ
- [Starting and stopping services](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#starting-and-stopping) - [Starting and stopping services](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#starting-and-stopping)
- [Starting a rails console](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#invoking-rake-tasks) - [Starting a rails console](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#invoking-rake-tasks)
#### Learn about the Support process ### Learn about the Support process
Zendesk is our Support Centre and our main communication line with our Customers. We communicate with customers through several other channels too Zendesk is our Support Centre and our main communication line with our Customers. We communicate with customers through several other channels too
- Familiarize yourself with ZenDesk - Familiarize yourself with ZenDesk:
- [UI Overview](https://support.zendesk.com/hc/en-us/articles/203661806-Introduction-to-the-Zendesk-agent-interface) - [UI Overview](https://support.zendesk.com/hc/en-us/articles/203661806-Introduction-to-the-Zendesk-agent-interface)
- [Updating Tickets](https://support.zendesk.com/hc/en-us/articles/212530318-Updating-and-solving-tickets) - [Updating Tickets](https://support.zendesk.com/hc/en-us/articles/212530318-Updating-and-solving-tickets)
- [Working w/ Tickets](https://support.zendesk.com/hc/en-us/articles/203690856-Working-with-tickets) *Read: avoiding agent collision.* - [Working w/ Tickets](https://support.zendesk.com/hc/en-us/articles/203690856-Working-with-tickets) *Read: avoiding agent collision.*
...@@ -140,7 +141,7 @@ Zendesk is our Support Centre and our main communication line with our Customers ...@@ -140,7 +141,7 @@ Zendesk is our Support Centre and our main communication line with our Customers
- Upgrade calls - Upgrade calls
- Emergency calls - Emergency calls
#### Learn about the Escalation process for tickets ### Learn about the Escalation process for tickets
Some tickets need specific knowledge or a deep understanding of a particular component and will need to be escalated to a Senior Service Engineer or Developer Some tickets need specific knowledge or a deep understanding of a particular component and will need to be escalated to a Senior Service Engineer or Developer
...@@ -148,7 +149,7 @@ Some tickets need specific knowledge or a deep understanding of a particular com ...@@ -148,7 +149,7 @@ Some tickets need specific knowledge or a deep understanding of a particular com
- Find the macros in Zendesk for ticket escalations - Find the macros in Zendesk for ticket escalations
- Take a look at the [GitLab.com Team page](https://about.gitlab.com/team/) to find the resident experts in their fields - Take a look at the [GitLab.com Team page](https://about.gitlab.com/team/) to find the resident experts in their fields
#### Learn about raising issues and fielding feature proposals ### Learn about raising issues and fielding feature proposals
- Understand what's in the pipeline and proposed features at GitLab: [Direction Page](https://about.gitlab.com/direction/) - Understand what's in the pipeline and proposed features at GitLab: [Direction Page](https://about.gitlab.com/direction/)
- Practice searching issues and filtering using [labels](https://gitlab.com/gitlab-org/gitlab-ce/labels) to find existing feature proposals and bugs - Practice searching issues and filtering using [labels](https://gitlab.com/gitlab-org/gitlab-ce/labels) to find existing feature proposals and bugs
...@@ -157,15 +158,15 @@ Some tickets need specific knowledge or a deep understanding of a particular com ...@@ -157,15 +158,15 @@ Some tickets need specific knowledge or a deep understanding of a particular com
- Take a look at the [existing issue templates](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker) to see what is expected - Take a look at the [existing issue templates](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker) to see what is expected
- Raise issues for bugs in a manner that would make the issue easily reproducible. A Developer or a contributor may work on your issue - Raise issues for bugs in a manner that would make the issue easily reproducible. A Developer or a contributor may work on your issue
#### Goals ### Goals
- Aim to have a good understanding of the problems that customers are facing - Aim to have a good understanding of the problems that customers are facing
- Aim to have gained experience in scheduling and participating in calls with customers - Aim to have gained experience in scheduling and participating in calls with customers
- Aim to have a good understanding of ticket flow through Zendesk and how to interact with our various channels - Aim to have a good understanding of ticket flow through Zendesk and how to interact with our various channels
### Stage 4 ## Stage 4
#### Advanced GitLab topics ### Advanced GitLab topics
Move on to understanding some of GitLab's more advanced features. You can make use of GitLab.com to understand the features from an end-user perspective and then use your own instance to understand setup and configuration of the feature from an Administrative perspective Move on to understanding some of GitLab's more advanced features. You can make use of GitLab.com to understand the features from an end-user perspective and then use your own instance to understand setup and configuration of the feature from an Administrative perspective
...@@ -179,11 +180,23 @@ Move on to understanding some of GitLab's more advanced features. You can make u ...@@ -179,11 +180,23 @@ Move on to understanding some of GitLab's more advanced features. You can make u
and the [CE codebase](https://gitlab.com/gitlab-org/gitlab-ce) and the [CE codebase](https://gitlab.com/gitlab-org/gitlab-ce)
- Ask as many questions as you can think of on the `#support` chat channel - Ask as many questions as you can think of on the `#support` chat channel
#### Get initiated for on-call duty ### Get initiated for on-call duty
- Read over the [public run-books to understand common tasks](https://gitlab.com/gitlab-com/runbooks) - Read over the [public run-books to understand common tasks](https://gitlab.com/gitlab-com/runbooks)
- Create an issue on the internal Organization tracker to schedule time with the DevOps / Production team, so that you learn how to handle GitLab.com going down. Once you are trained for this, you are ready to be added to the on-call rotation. - Create an issue on the internal Organization tracker to schedule time with the DevOps / Production team, so that you learn how to handle GitLab.com going down. Once you are trained for this, you are ready to be added to the on-call rotation.
#### Goals ### Goals
- Aim to become a fully-fledged Service Engineer! - Aim to become a fully-fledged Service Engineer!
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
doc/university/training/gitlab_flow.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: reference
--- ---
# What is the GitLab Flow # What is the GitLab Flow
...@@ -41,5 +42,17 @@ comments: false ...@@ -41,5 +42,17 @@ comments: false
## More details ## More details
For more information read through the [GitLab Flow](../../workflow/gitlab_flow.md) For more information, read through the [GitLab Flow](../../workflow/gitlab_flow.md)
documentation. documentation.
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
doc/university/training/index.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: index
--- ---
# GitLab Training Material # GitLab Training Material
...@@ -8,3 +9,34 @@ All GitLab training material is stored in markdown format. Slides are ...@@ -8,3 +9,34 @@ All GitLab training material is stored in markdown format. Slides are
generated using [Deskset](http://www.decksetapp.com/). generated using [Deskset](http://www.decksetapp.com/).
All training material is open to public contribution. All training material is open to public contribution.
This section contains the following topics:
- [Agile and Git](topics/agile_git.md).
- [Bisect](topics/bisect.md).
- [Cherry pick](topics/cherry_picking.md).
- [Code review and collaboration with Merge Requests](topics/merge_requests.md).
- [Configure your environment](topics/env_setup.md).
- [Explore GitLab](topics/explore_gitlab.md).
- [Feature branching](topics/feature_branching.md).
- [Getting started](topics/getting_started.md).
- [GitLab flow](gitlab_flow.md).
- [GitLab Git workshop](user_training.md).
- [Git add](topics/git_add.md).
- [Git introduction](topics/git_intro.md).
- [Git log](topics/git_log.md).
- [Git stash](topics/stash.md).
- [Merge conflicts](topics/merge_conflicts.md).
- [Rollback commits](topics/rollback_commits.md).
- [Subtree](topics/subtree.md).
- [Tags](topics/tags.md).
- [Unstage](topics/unstage.md).
## Additional Resources
1. [GitLab Documentation](http://docs.gitlab.com)
1. [GUI Clients](http://git-scm.com/downloads/guis)
1. [Pro Git book](http://git-scm.com/book)
1. [Platzi Course](https://courses.platzi.com/courses/git-gitlab/)
1. [Code School tutorial](http://try.github.io/)
1. Contact us at `subscribers@gitlab.com`
doc/university/training/topics/additional_resources.md deleted 100644 → 0
View file @ 6050b348
---
comments: false
---
# Additional Resources
1. GitLab Documentation: <http://docs.gitlab.com>.
1. GUI Clients: <http://git-scm.com/downloads/guis>.
1. Pro Git book: <http://git-scm.com/book>.
1. Platzi Course: <https://courses.platzi.com/courses/git-gitlab/>.
1. Code School tutorial: <http://try.github.io/>.
1. Contact us at `subscribers@gitlab.com`.
doc/university/training/topics/agile_git.md
View file @ c403fdd7
...@@ -4,22 +4,16 @@ comments: false ...@@ -4,22 +4,16 @@ comments: false
# Agile and Git # Agile and Git
----------
## Agile ## Agile
Lean software development methods focused on collaboration and interaction Lean software development methods focused on collaboration and interaction
with fast and smaller deployment cycles. with fast and smaller deployment cycles.
----------
## Where Git comes in ## Where Git comes in
Git is an excellent tool for an Agile team considering that it allows Git is an excellent tool for an Agile team considering that it allows
decentralized and simultaneous development. decentralized and simultaneous development.
----------
### Branching And Workflows ### Branching And Workflows
Branching in an Agile environment usually happens around user stories with one Branching in an Agile environment usually happens around user stories with one
...@@ -30,8 +24,7 @@ with his/her initials, and US id. ...@@ -30,8 +24,7 @@ with his/her initials, and US id.
After its tested merge into master and remove the branch. After its tested merge into master and remove the branch.
----------
## What about GitLab ## What about GitLab
Tools like GitLab enhance collaboration by adding dialog around code mainly Tools like GitLab enhance collaboration by adding dialog around code mainly
through issues and merge requests. through issues and merge requests.
doc/university/training/topics/bisect.md
View file @ c403fdd7
...@@ -4,16 +4,12 @@ comments: false ...@@ -4,16 +4,12 @@ comments: false
# Bisect # Bisect
----------
## Bisect ## Bisect
- Find a commit that introduced a bug - Find a commit that introduced a bug
- Works through a process of elimination - Works through a process of elimination
- Specify a known good and bad revision to begin - Specify a known good and bad revision to begin
----------
## Bisect ## Bisect
1. Start the bisect process 1. Start the bisect process
...@@ -23,11 +19,9 @@ comments: false ...@@ -23,11 +19,9 @@ comments: false
1. Tell bisect the result 1. Tell bisect the result
1. Repeat the previous 2 items until you find the offending commit 1. Repeat the previous 2 items until you find the offending commit
----------
## Setup ## Setup
``` ```sh
mkdir bisect-ex mkdir bisect-ex
cd bisect-ex cd bisect-ex
touch index.html touch index.html
...@@ -44,9 +38,7 @@ comments: false ...@@ -44,9 +38,7 @@ comments: false
vi index.html vi index.html
``` ```
---------- ```sh
```
# Add all good 3 # Add all good 3
git add -A git add -A
git commit -m "fourth commit" git commit -m "fourth commit"
...@@ -64,11 +56,9 @@ comments: false ...@@ -64,11 +56,9 @@ comments: false
git commit -m "seventh commit" git commit -m "seventh commit"
``` ```
----------
## Commands ## Commands
``` ```sh
git bisect start git bisect start
# Test your code # Test your code
git bisect bad git bisect bad
......
doc/university/training/topics/cherry_picking.md
View file @ c403fdd7
...@@ -4,16 +4,12 @@ comments: false ...@@ -4,16 +4,12 @@ comments: false
# Cherry Pick # Cherry Pick
----------
## Cherry Pick ## Cherry Pick
- Given an existing commit on one branch, apply the change to another branch - Given an existing commit on one branch, apply the change to another branch
- Useful for backporting bug fixes to previous release branches - Useful for backporting bug fixes to previous release branches
- Make the commit on the master branch and pick in to stable - Make the commit on the master branch and pick in to stable
----------
## Cherry Pick ## Cherry Pick
1. Check out a new 'stable' branch from 'master' 1. Check out a new 'stable' branch from 'master'
...@@ -23,8 +19,6 @@ comments: false ...@@ -23,8 +19,6 @@ comments: false
1. Check out the 'stable' branch 1. Check out the 'stable' branch
1. Cherry pick the commit using the SHA obtained earlier 1. Cherry pick the commit using the SHA obtained earlier
----------
## Commands ## Commands
```bash ```bash
......
doc/university/training/topics/env_setup.md
View file @ c403fdd7
...@@ -4,7 +4,6 @@ comments: false ...@@ -4,7 +4,6 @@ comments: false
# Configure your environment # Configure your environment
----------
## Install ## Install
- **Windows** - **Windows**
...@@ -22,8 +21,6 @@ comments: false ...@@ -22,8 +21,6 @@ comments: false
sudo apt-get install git-all sudo apt-get install git-all
``` ```
----------
## Configure Git ## Configure Git
One-time configuration of the Git client One-time configuration of the Git client
...@@ -33,8 +30,6 @@ git config --global user.name "Your Name" ...@@ -33,8 +30,6 @@ 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 ```bash
......
doc/university/training/topics/explore_gitlab.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Explore GitLab projects # Explore GitLab projects
----------
- Dashboard - Dashboard
- User Preferences - User Preferences
- Issues - Issues
......
doc/university/training/topics/feature_branching.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# 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
...@@ -13,8 +11,6 @@ comments: false ...@@ -13,8 +11,6 @@ comments: false
- 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
1. Create a new feature branch called 'squash_some_bugs' 1. Create a new feature branch called 'squash_some_bugs'
...@@ -22,11 +18,9 @@ comments: false ...@@ -22,11 +18,9 @@ comments: false
1. Commit 1. Commit
1. Push 1. Push
----------
## Commands ## Commands
``` ```sh
git checkout -b squash_some_bugs git checkout -b squash_some_bugs
# Edit `bugs.rb` # Edit `bugs.rb`
git status git status
......
doc/university/training/topics/getting_started.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Getting Started # Getting Started
----------
## Instantiating Repositories ## Instantiating Repositories
- Create a new repository by instantiating it through: - Create a new repository by instantiating it through:
...@@ -19,8 +17,6 @@ comments: false ...@@ -19,8 +17,6 @@ comments: false
git clone <url> git clone <url>
``` ```
----------
## Central Repos ## Central Repos
- To instantiate a central repository a `--bare` flag is required. - To instantiate a central repository a `--bare` flag is required.
...@@ -31,8 +27,6 @@ comments: false ...@@ -31,8 +27,6 @@ comments: false
git init --bare project-name.git git init --bare project-name.git
``` ```
----------
## Instantiate workflow with clone ## Instantiate workflow with clone
1. Create a project in your user namespace. 1. Create a project in your user namespace.
...@@ -40,18 +34,15 @@ comments: false ...@@ -40,18 +34,15 @@ comments: false
1. Create a '`Workspace`' directory in your home directory. 1. Create a '`Workspace`' directory in your home directory.
1. Clone the '`training-examples`' project. 1. Clone the '`training-examples`' project.
----------
## Commands ## Commands
``` ```sh
mkdir ~/workspace mkdir ~/workspace
cd ~/workspace cd ~/workspace
git clone git@gitlab.example.com:<username>/training-examples.git git clone git@gitlab.example.com:<username>/training-examples.git
cd training-examples cd training-examples
``` ```
----------
## Git concepts ## Git concepts
...@@ -67,8 +58,6 @@ Files that have been modified but are not committed. ...@@ -67,8 +58,6 @@ Files that have been modified but are not committed.
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 Workflow ## Committing Workflow
1. Edit '`edit_this_file.rb`' in '`training-examples`' 1. Edit '`edit_this_file.rb`' in '`training-examples`'
...@@ -79,11 +68,9 @@ Modified files that have been marked to go in the next commit. ...@@ -79,11 +68,9 @@ Modified files that have been marked to go in the next 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
``` ```sh
# Edit `edit_this_file.rb` # Edit `edit_this_file.rb`
git status git status
git diff git diff
...@@ -93,8 +80,6 @@ git push origin master ...@@ -93,8 +80,6 @@ git push origin master
git log git log
``` ```
----------
## Note ## Note
- git fetch vs pull - git fetch vs pull
......
doc/university/training/topics/git_add.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Git Add # Git Add
----------
## Git Add ## Git Add
Adds content to the index or staging area. Adds content to the index or staging area.
...@@ -22,8 +20,6 @@ Adds content to the index or staging area. ...@@ -22,8 +20,6 @@ Adds content to the index or staging area.
git add -A git add -A
``` ```
----------
## Git add continued ## Git add continued
- Add all text files in current dir: - Add all text files in current dir:
......
doc/university/training/topics/git_intro.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Git introduction # Git introduction
----------
## Intro ## Intro
<https://git-scm.com/about> <https://git-scm.com/about>
...@@ -17,8 +15,6 @@ comments: false ...@@ -17,8 +15,6 @@ comments: false
- 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.
......
doc/university/training/topics/git_log.md
View file @ c403fdd7
...@@ -4,44 +4,38 @@ comments: false ...@@ -4,44 +4,38 @@ comments: false
# Git Log # Git Log
----------
Git log lists commit history. It allows searching and filtering. Git log lists commit history. It allows searching and filtering.
- Initiate log: - Initiate log:
``` ```sh
git log git log
``` ```
- Retrieve set number of records: - Retrieve set number of records:
``` ```sh
git log -n 2 git log -n 2
``` ```
- Search commits by author. Allows user name or a regular expression. - Search commits by author. Allows user name or a regular expression.
``` ```sh
git log --author="user_name" git log --author="user_name"
``` ```
----------
- Search by comment message: - Search by comment message:
``` ```sh
git log --grep="<pattern>" git log --grep="<pattern>"
``` ```
- Search by date: - Search by date:
``` ```sh
git log --since=1.month.ago --until=3.weeks.ago git log --since=1.month.ago --until=3.weeks.ago
``` ```
----------
## Git Log Workflow ## Git Log Workflow
1. Change to workspace directory 1. Change to workspace directory
...@@ -51,11 +45,9 @@ Git log lists commit history. It allows searching and filtering. ...@@ -51,11 +45,9 @@ Git log lists commit history. It allows searching and filtering.
1. Search by date 1. Search by date
1. Combine 1. Combine
----------
## Commands ## Commands
``` ```sh
cd ~/workspace cd ~/workspace
git clone git@gitlab.com:gitlab-org/gitlab-runner.git git clone git@gitlab.com:gitlab-org/gitlab-runner.git
cd gitlab-runner cd gitlab-runner
......
doc/university/training/topics/merge_conflicts.md
View file @ c403fdd7
...@@ -4,15 +4,11 @@ comments: false ...@@ -4,15 +4,11 @@ comments: false
# 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
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'.
...@@ -26,11 +22,9 @@ comments: false ...@@ -26,11 +22,9 @@ comments: false
1. Force push the changes. 1. Force push the changes.
1. Finally continue with the Merge Request. 1. Finally continue with the Merge Request.
----------
## Commands ## Commands
``` ```sh
git checkout -b conflicts_branch git checkout -b conflicts_branch
# vi conflicts.rb # vi conflicts.rb
...@@ -49,7 +43,7 @@ git push origin master ...@@ -49,7 +43,7 @@ git push origin master
Create a merge request on the GitLab web UI. You'll see a conflict warning. Create a merge request on the GitLab web UI. You'll see a conflict warning.
``` ```sh
git checkout conflicts_branch git checkout conflicts_branch
git fetch git fetch
git rebase master git rebase master
...@@ -65,7 +59,6 @@ git rebase --continue ...@@ -65,7 +59,6 @@ git rebase --continue
# need to force push so that our remote branch is restructured # need to force push so that our remote branch is restructured
git push origin conflicts_branch -f git push origin conflicts_branch -f
``` ```
----------
## Note ## Note
......
doc/university/training/topics/merge_requests.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Code review and collaboration with Merge Requests # Code review and collaboration with 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
...@@ -14,8 +12,6 @@ comments: false ...@@ -14,8 +12,6 @@ comments: false
- 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
**Create your first merge request** **Create your first merge request**
...@@ -25,8 +21,6 @@ comments: false ...@@ -25,8 +21,6 @@ comments: false
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
...@@ -36,8 +30,6 @@ comments: false ...@@ -36,8 +30,6 @@ comments: false
- 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
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:
......
doc/university/training/topics/rollback_commits.md
View file @ c403fdd7
...@@ -4,40 +4,34 @@ comments: false ...@@ -4,40 +4,34 @@ comments: false
# Rollback Commits # Rollback Commits
----------
## Undo Commits ## Undo Commits
- Undo last commit putting everything back into the staging area: - Undo last commit putting everything back into the staging area:
``` ```sh
git reset --soft HEAD^ git reset --soft HEAD^
``` ```
- Add files and change message with: - Add files and change message with:
``` ```sh
git commit --amend -m "New Message" git commit --amend -m "New Message"
``` ```
----------
- Undo last and remove changes: - Undo last and remove changes:
``` ```sh
git reset --hard HEAD^ git reset --hard HEAD^
``` ```
- Same as last one but for two commits back: - Same as last one but for two commits back:
``` ```sh
git reset --hard HEAD^^ git reset --hard HEAD^^
``` ```
** Don't reset after pushing ** ** Don't reset after pushing **
----------
## Reset Workflow ## Reset Workflow
1. Edit file again 'edit_this_file.rb' 1. Edit file again 'edit_this_file.rb'
...@@ -51,11 +45,9 @@ comments: false ...@@ -51,11 +45,9 @@ comments: false
1. Pull for updates 1. Pull for updates
1. Push changes 1. Push changes
----------
## Commands ## Commands
``` ```sh
# Change file edit_this_file.rb # Change file edit_this_file.rb
git status git status
git commit -am "kjkfjkg" git commit -am "kjkfjkg"
...@@ -68,15 +60,13 @@ git pull origin master ...@@ -68,15 +60,13 @@ git pull origin master
git push origin master git push origin master
``` ```
----------
## Note ## Note
- git revert vs git reset - git revert vs git reset
- Reset removes the commit while revert removes the changes but leaves the commit - Reset removes the commit while revert removes the changes but leaves the commit
- Revert is safer considering we can revert a revert - Revert is safer considering we can revert a revert
``` ```sh
# Changed file # Changed file
git commit -am "bug introduced" git commit -am "bug introduced"
git revert HEAD git revert HEAD
......
doc/university/training/topics/stash.md
View file @ c403fdd7
...@@ -4,14 +4,12 @@ comments: false ...@@ -4,14 +4,12 @@ comments: false
# Git Stash # Git Stash
----------
We use git stash to store our changes when they are not ready to be committed We use git stash to store our changes when they are not ready to be committed
and we need to change to a different branch. and we need to change to a different branch.
- Stash: - Stash:
``` ```sh
git stash save git stash save
# or # or
git stash git stash
...@@ -21,18 +19,16 @@ and we need to change to a different branch. ...@@ -21,18 +19,16 @@ and we need to change to a different branch.
- Apply stash to keep working on it: - Apply stash to keep working on it:
``` ```sh
git stash apply git stash apply
# or apply a specific one from out stack # or apply a specific one from out stack
git stash apply stash@{3} git stash apply stash@{3}
``` ```
----------
- Every time we save a stash it gets stacked so by using list we can see all our - Every time we save a stash it gets stacked so by using list we can see all our
stashes. stashes.
``` ```sh
git stash list git stash list
# or for more information (log methods) # or for more information (log methods)
git stash list --stat git stash list --stat
...@@ -40,7 +36,7 @@ and we need to change to a different branch. ...@@ -40,7 +36,7 @@ and we need to change to a different branch.
- To clean our stack we need to manually remove them: - To clean our stack we need to manually remove them:
``` ```sh
# drop top stash # drop top stash
git stash drop git stash drop
# or # or
...@@ -49,19 +45,15 @@ and we need to change to a different branch. ...@@ -49,19 +45,15 @@ and we need to change to a different branch.
git stash clear git stash clear
``` ```
----------
- Apply and drop on one command: - Apply and drop on one command:
``` ```sh
git stash pop git stash pop
``` ```
- If we meet conflicts we need to either reset or commit our changes. - If we meet conflicts we need to either reset or commit our changes.
- Conflicts through `pop` will not drop a stash afterwards. - Conflicts through `pop` will not drop a stash afterwards.
----------
## Git Stash ## Git Stash
1. Modify a file 1. Modify a file
...@@ -72,11 +64,9 @@ and we need to change to a different branch. ...@@ -72,11 +64,9 @@ and we need to change to a different branch.
1. Apply with pop 1. Apply with pop
1. View list to confirm changes 1. View list to confirm changes
----------
## Commands ## Commands
``` ```sh
# Modify edit_this_file.rb file # Modify edit_this_file.rb file
git add . git add .
......
doc/university/training/topics/subtree.md
View file @ c403fdd7
...@@ -9,19 +9,15 @@ comments: false ...@@ -9,19 +9,15 @@ comments: false
- For these cases we need a dependency control system. - For these cases we need a dependency control system.
- Command are painfully long so aliases are necessary. - Command are painfully long so aliases are necessary.
----------
## Subtree Aliases ## Subtree Aliases
- Add: git subtree add --prefix <target-folder> <url> <branch> --squash. - Add: `git subtree add --prefix <target-folder> <url> <branch> --squash`.
- Pull: git subtree add --prefix <target-folder> <url> <branch> --squash. - Pull: `git subtree add --prefix <target-folder> <url> <branch> --squash`.
- Push: git subtree add --prefix <target-folder> <url> <branch>. - Push: `git subtree add --prefix <target-folder> <url> <branch>`.
- Ex: git config alias.sbp 'subtree pull --prefix st / - Ex: `git config alias.sbp 'subtree pull --prefix st /
git@gitlab.com:balameb/subtree-nested-example.git master --squash'. git@gitlab.com:balameb/subtree-nested-example.git master --squash'`.
----------
``` ```sh
# Add an alias # Add an alias
# Add # Add
git config alias.sba 'subtree add --prefix st / git config alias.sba 'subtree add --prefix st /
...@@ -41,9 +37,7 @@ comments: false ...@@ -41,9 +37,7 @@ comments: false
``` ```
---------- ```sh
```
# Adding, or committing won't change the sub repo at remote # Adding, or committing won't change the sub repo at remote
# even if we push # even if we push
git add -A git add -A
......
doc/university/training/topics/tags.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: reference
--- ---
# 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
- Create a lightweight tag - Create a lightweight tag
...@@ -24,11 +21,9 @@ comments: false ...@@ -24,11 +21,9 @@ comments: false
<https://git-scm.com/book/en/Git-Basics-Tagging> <https://git-scm.com/book/en/Git-Basics-Tagging>
----------
# Commands # Commands
``` ```sh
git checkout master git checkout master
# Lightweight tag # Lightweight tag
...@@ -40,3 +35,15 @@ git tag ...@@ -40,3 +35,15 @@ git tag
git push origin --tags git push origin --tags
``` ```
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
doc/university/training/topics/unstage.md
View file @ c403fdd7
...@@ -4,8 +4,6 @@ comments: false ...@@ -4,8 +4,6 @@ comments: false
# Unstage # Unstage
----------
## Unstage ## Unstage
- To remove files from stage use reset HEAD where HEAD is the last commit of the current branch. This will unstage the file but maintain the modifications. - To remove files from stage use reset HEAD where HEAD is the last commit of the current branch. This will unstage the file but maintain the modifications.
...@@ -20,17 +18,15 @@ comments: false ...@@ -20,17 +18,15 @@ comments: false
git checkout -- <file> git checkout -- <file>
``` ```
----------
- To remove a file from disk and repo use 'git rm' and to rm a dir use the '-r' flag: - To remove a file from disk and repo use 'git rm' and to rm a dir use the '-r' flag:
``` ```sh
git rm '*.txt' git rm '*.txt'
git rm -r <dirname> git rm -r <dirname>
``` ```
- If we want to remove a file from the repository but keep it on disk, say we forgot to add it to our `.gitignore` file then use `--cache`: - If we want to remove a file from the repository but keep it on disk, say we forgot to add it to our `.gitignore` file then use `--cache`:
``` ```sh
git rm <filename> --cache git rm <filename> --cache
``` ```
doc/university/training/user_training.md
View file @ c403fdd7
--- ---
comments: false comments: false
type: reference
--- ---
# GitLab Git Workshop # GitLab Git Workshop
---
## Agenda ## Agenda
1. Brief history of Git. 1. Brief history of Git.
...@@ -13,8 +12,6 @@ comments: false ...@@ -13,8 +12,6 @@ comments: false
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>
...@@ -26,8 +23,6 @@ comments: false ...@@ -26,8 +23,6 @@ comments: false
- 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.
...@@ -36,14 +31,10 @@ Use the tools at your disposal when you get stuck. ...@@ -36,14 +31,10 @@ Use the tools at your disposal when you get stuck.
- 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'
...@@ -56,8 +47,6 @@ Use the tools at your disposal when you get stuck. ...@@ -56,8 +47,6 @@ Use the tools at your disposal when you get stuck.
- Debian: '`sudo apt-get install git-all`' or Red Hat '`sudo yum install git-all`' - Debian: '`sudo apt-get install git-all`' or Red Hat '`sudo yum install git-all`'
---
## Git Workshop ## Git Workshop
### Overview ### Overview
...@@ -70,8 +59,6 @@ Use the tools at your disposal when you get stuck. ...@@ -70,8 +59,6 @@ Use the tools at your disposal when you get stuck.
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:
...@@ -81,8 +68,6 @@ git config --global user.name "Your Name" ...@@ -81,8 +68,6 @@ 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
```sh ```sh
...@@ -111,8 +96,6 @@ cat ~/.ssh/id_rsa.pub ...@@ -111,8 +96,6 @@ cat ~/.ssh/id_rsa.pub
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.
...@@ -120,8 +103,6 @@ ssh-rsa AAAAB3NzaC1yc2EAAAADAQEL17Ufacg8cDhlQMS5NhV8z3GHZdhCrZbl4gz you@example. ...@@ -120,8 +103,6 @@ ssh-rsa AAAAB3NzaC1yc2EAAAADAQEL17Ufacg8cDhlQMS5NhV8z3GHZdhCrZbl4gz you@example.
- 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 (project) ## Commands (project)
```sh ```sh
...@@ -137,8 +118,6 @@ git clone git@gitlab.example.com:<username>/training-examples.git ...@@ -137,8 +118,6 @@ git clone git@gitlab.example.com:<username>/training-examples.git
cd training-examples cd training-examples
``` ```
---
## Git concepts ## Git concepts
### Untracked files ### Untracked files
...@@ -153,8 +132,6 @@ Files that have been modified but are not committed. ...@@ -153,8 +132,6 @@ Files that have been modified but are not committed.
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`'.
...@@ -165,8 +142,6 @@ Modified files that have been marked to go in the next commit. ...@@ -165,8 +142,6 @@ Modified files that have been marked to go in the next 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 (committing) ## Commands (committing)
```sh ```sh
...@@ -179,8 +154,6 @@ git push origin master ...@@ -179,8 +154,6 @@ git push origin master
git log git log
``` ```
---
## Feature branching ## Feature branching
- Efficient parallel workflow for teams. - Efficient parallel workflow for teams.
...@@ -190,8 +163,6 @@ git log ...@@ -190,8 +163,6 @@ git log
- 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 steps ## Feature branching steps
1. Create a new feature branch called 'squash_some_bugs'. 1. Create a new feature branch called 'squash_some_bugs'.
...@@ -199,8 +170,6 @@ git log ...@@ -199,8 +170,6 @@ git log
1. Commit. 1. Commit.
1. Push. 1. Push.
---
## Commands (feature branching) ## Commands (feature branching)
```sh ```sh
...@@ -212,8 +181,6 @@ git commit -m 'Fix some buggy code' ...@@ -212,8 +181,6 @@ git commit -m 'Fix some buggy code'
git push origin squash_some_bugs 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.
...@@ -224,8 +191,6 @@ git push origin squash_some_bugs ...@@ -224,8 +191,6 @@ git push origin squash_some_bugs
- 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 steps ## Merge requests steps
Create your first merge request: Create your first merge request:
...@@ -235,8 +200,6 @@ Create your first merge request: ...@@ -235,8 +200,6 @@ Create your first merge request:
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.
...@@ -246,8 +209,6 @@ Create your first merge request: ...@@ -246,8 +209,6 @@ Create your first merge request:
- 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 resources ## 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:
...@@ -255,8 +216,6 @@ Review the Thoughtbot code-review guide for suggestions to follow when reviewing ...@@ -255,8 +216,6 @@ Review the Thoughtbot code-review guide for suggestions to follow when reviewing
See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce/merge_requests>. See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce/merge_requests>.
---
## Explore GitLab projects ## Explore GitLab projects
![fit](logo.png) ![fit](logo.png)
...@@ -269,8 +228,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce ...@@ -269,8 +228,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce
- Manage project members - Manage project members
- Project settings - Project settings
---
## Tags ## Tags
- Useful for marking deployments and releases. - Useful for marking deployments and releases.
...@@ -279,8 +236,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce ...@@ -279,8 +236,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce
- 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 steps ## Tags steps
1. Create a lightweight tag. 1. Create a lightweight tag.
...@@ -289,8 +244,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce ...@@ -289,8 +244,6 @@ See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-ce
Additional resources: <http://git-scm.com/book/en/Git-Basics-Tagging>. Additional resources: <http://git-scm.com/book/en/Git-Basics-Tagging>.
---
## Commands (tags) ## Commands (tags)
```sh ```sh
...@@ -306,8 +259,6 @@ git tag ...@@ -306,8 +259,6 @@ git tag
git push origin --tags git push origin --tags
``` ```
---
## Merge conflicts ## Merge conflicts
- Happen often. - Happen often.
...@@ -315,8 +266,6 @@ git push origin --tags ...@@ -315,8 +266,6 @@ git push origin --tags
- Practice makes perfect. - Practice makes perfect.
- Force push after fixing conflicts. Be careful! - Force push after fixing conflicts. Be careful!
---
## Merge conflicts steps ## 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'.
...@@ -325,8 +274,6 @@ git push origin --tags ...@@ -325,8 +274,6 @@ git push origin --tags
1. Commit and push to master. 1. Commit and push to master.
1. Create a merge request. 1. Create a merge request.
---
## Merge conflicts commands ## 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
...@@ -343,8 +290,6 @@ git rebase --continue ...@@ -343,8 +290,6 @@ git rebase --continue
git push origin <branch> -f 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:
...@@ -361,8 +306,6 @@ Does this work? ...@@ -361,8 +306,6 @@ Does this work?
Squash these in to meaningful commits using an interactive rebase. Squash these in to meaningful commits using an interactive rebase.
---
## Rebase with squash commands ## 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.
...@@ -373,8 +316,6 @@ git rebase -i master ...@@ -373,8 +316,6 @@ git rebase -i master
In the editor, leave the first commit as 'pick' and set others to 'fixup'. In the editor, leave the first commit as 'pick' and set others to 'fixup'.
---
## Questions? ## Questions?
![fit](logo.png) ![fit](logo.png)
...@@ -383,9 +324,16 @@ Thank you for your hard work! ...@@ -383,9 +324,16 @@ Thank you for your hard work!
## Additional Resources ## Additional Resources
- GitLab Documentation: <http://docs.gitlab.com/>. See [additional resources](index.md#additional-resources).
- GUI Clients: <http://git-scm.com/downloads/guis>.
- Pro Git book: <http://git-scm.com/book>. <!-- ## Troubleshooting
- Platzi Course: <https://courses.platzi.com/courses/git-gitlab/>.
- Code School tutorial: <http://try.github.io/>. Include any troubleshooting steps that you can foresee. If you know beforehand what issues
- Contact us at `subscribers@gitlab.com`. one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
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