summaryrefslogtreecommitdiff
path: root/doc/university
diff options
context:
space:
mode:
authorBrett Walker <bwalker@gitlab.com>2018-09-06 16:52:18 +0000
committerSean McGivern <sean@mcgivern.me.uk>2018-09-06 16:52:18 +0000
commitb0be58a1b313df976ea4b0e37163f8fea81ce5f4 (patch)
tree9f24d3c53f6d47fb6266f00db9f60f514447ed2a /doc/university
parent2d16f4794b43966595e8c6b6405b55c60e94e866 (diff)
downloadgitlab-ce-b0be58a1b313df976ea4b0e37163f8fea81ce5f4.tar.gz
Resolve "CE documentation is not CommonMark compliant"
Diffstat (limited to 'doc/university')
-rw-r--r--doc/university/README.md8
-rw-r--r--doc/university/high-availability/aws/README.md4
-rw-r--r--doc/university/support/README.md42
-rw-r--r--doc/university/training/topics/bisect.md2
-rw-r--r--doc/university/training/topics/env_setup.md4
-rw-r--r--doc/university/training/topics/getting_started.md25
-rw-r--r--doc/university/training/topics/git_add.md38
-rw-r--r--doc/university/training/topics/git_log.md35
-rw-r--r--doc/university/training/topics/rollback_commits.md28
-rw-r--r--doc/university/training/topics/stash.md58
-rw-r--r--doc/university/training/topics/unstage.md27
11 files changed, 147 insertions, 124 deletions
diff --git a/doc/university/README.md b/doc/university/README.md
index 595fc480887..203981b85ec 100644
--- a/doc/university/README.md
+++ b/doc/university/README.md
@@ -73,10 +73,10 @@ The curriculum is composed of GitLab videos, screencasts, presentations, project
#### 1.7 Community and Support
1. [Getting Help](https://about.gitlab.com/getting-help/)
- - Proposing Features and Reporting and Tracking bugs for GitLab
- - The GitLab IRC channel, Gitter Chat Room, Community Forum and Mailing List
- - Getting Technical Support
- - Being part of our Great Community and Contributing to GitLab
+ - Proposing Features and Reporting and Tracking bugs for GitLab
+ - The GitLab IRC channel, Gitter Chat Room, Community Forum and Mailing List
+ - Getting Technical Support
+ - Being part of our Great Community and Contributing to GitLab
1. [Getting Started with the GitLab Development Kit (GDK)](https://about.gitlab.com/2016/06/08/getting-started-with-gitlab-development-kit/)
1. [Contributing Technical Articles to the GitLab Blog](https://about.gitlab.com/2016/01/26/call-for-writers/)
1. [GitLab Training Workshops](https://docs.gitlab.com/ce/university/training/end-user/)
diff --git a/doc/university/high-availability/aws/README.md b/doc/university/high-availability/aws/README.md
index 4e7eae19844..1bff1488746 100644
--- a/doc/university/high-availability/aws/README.md
+++ b/doc/university/high-availability/aws/README.md
@@ -395,5 +395,5 @@ 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](http://docs.gitlab.com/ce/administration/high_availability/README.html#sts=High Availability)
- * [GitLab Geo](http://docs.gitlab.com/ee/gitlab-geo/README.html)
+* [GitLab High Availability](http://docs.gitlab.com/ce/administration/high_availability/README.html#sts=High%20Availability)
+* [GitLab Geo](http://docs.gitlab.com/ee/gitlab-geo/README.html)
diff --git a/doc/university/support/README.md b/doc/university/support/README.md
index d1d5db6bbcd..0cbae71d1f5 100644
--- a/doc/university/support/README.md
+++ b/doc/university/support/README.md
@@ -55,13 +55,13 @@ Sometimes we need to upgrade customers from old versions of GitLab to latest, so
- Keep this up-to-date as patch and version releases become available, just like our customers would
- Try out the following installation path
- [Install GitLab 4.2 from source](https://gitlab.com/gitlab-org/gitlab-ce/blob/d67117b5a185cfb15a1d7e749588ff981ffbf779/doc/install/installation.md)
- - External MySQL database
- - External NGINX
+ - External MySQL database
+ - External NGINX
- Create some test data
- - Populated Repos
- - Users
- - Groups
- - Projects
+ - Populated Repos
+ - Users
+ - Groups
+ - Projects
- [Backup using our Backup rake task](https://docs.gitlab.com/ce/raketasks/backup_restore.html#create-a-backup-of-the-gitlab-system)
- [Upgrade to 5.0 source using our Upgrade documentation](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/doc/update/4.2-to-5.0.md)
- [Upgrade to 5.1 source](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/doc/update/5.0-to-5.1.md)
@@ -72,7 +72,7 @@ Sometimes we need to upgrade customers from old versions of GitLab to latest, so
- [Upgrade to Omnibus 7.14](https://docs.gitlab.com/omnibus/update/README.html#upgrading-from-a-non-omnibus-installation-to-an-omnibus-installation)
- [Restore backup using our Restore rake task](https://docs.gitlab.com/ce/raketasks/backup_restore.html#restore-a-previously-created-backup)
- [Upgrade to latest EE](https://about.gitlab.com/downloads-ee)
- - (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](https://docs.gitlab.com/ee/downgrade_ee_to_ce/README.html)
#### Start to learn about some of the integrations that we support
@@ -98,9 +98,9 @@ Our integrations add great value to GitLab. User questions often relate to integ
- [Environment Information and maintenance checks](https://docs.gitlab.com/ce/raketasks/maintenance.html)
- [GitLab check](https://docs.gitlab.com/ce/raketasks/check.html)
- Omnibus commands
- - [Status](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#get-service-status)
- - [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)
+ - [Status](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/maintenance/README.md#get-service-status)
+ - [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)
#### Learn about the Support process
@@ -118,16 +118,16 @@ Zendesk is our Support Centre and our main communication line with our Customers
- Here you will find a large variety of queries mainly from our Users who are self hosting GitLab CE
- Understand the questions that are asked and dig in to try to find a solution
- [Proceed on to the GitLab.com Support Forum](https://about.gitlab.com/handbook/support/#gitlabcom-support-trackera-namesupp-foruma)
- - Here you will find queries regarding our own GitLab.com
- - Helping Users here will give you an understanding of our Admin interface and other tools
+ - Here you will find queries regarding our own GitLab.com
+ - Helping Users here will give you an understanding of our Admin interface and other tools
- [Proceed on to the Twitter tickets in Zendesk](https://about.gitlab.com/handbook/support/#twitter)
- - Here you will gain a great insight into our userbase
- - Learn from any complaints and problems and feed them back to the team
- - Tweets can range from help needed with GitLab installations, the API and just general queries
+ - Here you will gain a great insight into our userbase
+ - Learn from any complaints and problems and feed them back to the team
+ - Tweets can range from help needed with GitLab installations, the API and just general queries
- [Proceed on to Regular email Support tickets](https://about.gitlab.com/handbook/support/#regular-zendesk-tickets-a-nameregulara)
- - Here you will find tickets from our GitLab EE Customers and GitLab CE Users
- - Tickets here are extremely varied and often very technical
- - You should be prepared for these tickets, given the knowledge gained from previous tiers and your training
+ - Here you will find tickets from our GitLab EE Customers and GitLab CE Users
+ - Tickets here are extremely varied and often very technical
+ - You should be prepared for these tickets, given the knowledge gained from previous tiers and your training
- Check out your colleagues' responses
- Hop on to the #support-live-feed channel in Slack and see the tickets as they come in and are updated
- Read through old tickets that your colleagues have worked on
@@ -135,10 +135,10 @@ Zendesk is our Support Centre and our main communication line with our Customers
- [Learn about Cisco WebEx](https://about.gitlab.com/handbook/support/onboarding/#webexa-namewebexa)
- Training calls
- Information gathering calls
- - It's good to find out how new and prospective customers are going to be using the product and how they will set up their infrastructure
+ - It's good to find out how new and prospective customers are going to be using the product and how they will set up their infrastructure
- Diagnosis calls
- - When email isn't enough we may need to hop on a call and do some debugging along side the customer
- - These paired calls are a great learning experience
+ - When email isn't enough we may need to hop on a call and do some debugging along side the customer
+ - These paired calls are a great learning experience
- Upgrade calls
- Emergency calls
diff --git a/doc/university/training/topics/bisect.md b/doc/university/training/topics/bisect.md
index 2d5ab107fe6..01e93e4dcb0 100644
--- a/doc/university/training/topics/bisect.md
+++ b/doc/university/training/topics/bisect.md
@@ -10,7 +10,7 @@ comments: false
- Find a commit that introduced a bug
- Works through a process of elimination
-- Specify a known good and bad revision to begin
+- Specify a known good and bad revision to begin
----------
diff --git a/doc/university/training/topics/env_setup.md b/doc/university/training/topics/env_setup.md
index b7bec83ed8a..bdf805711e0 100644
--- a/doc/university/training/topics/env_setup.md
+++ b/doc/university/training/topics/env_setup.md
@@ -16,10 +16,10 @@ comments: false
- **Linux**
```bash
- sudo yum install git-all
+ sudo yum install git-all
```
```bash
- sudo apt-get install git-all
+ sudo apt-get install git-all
```
----------
diff --git a/doc/university/training/topics/getting_started.md b/doc/university/training/topics/getting_started.md
index 153b45fb4da..1441e4b89b2 100644
--- a/doc/university/training/topics/getting_started.md
+++ b/doc/university/training/topics/getting_started.md
@@ -9,13 +9,15 @@ comments: false
## Instantiating Repositories
* Create a new repository by instantiating it through
-```bash
-git init
-```
+
+ ```bash
+ git init
+ ```
* Copy an existing project by cloning the repository through
-```bash
-git clone <url>
-```
+
+ ```bash
+ git clone <url>
+ ```
----------
@@ -24,17 +26,18 @@ git clone <url>
* To instantiate a central repository a `--bare` flag is required.
* Bare repositories don't allow file editing or committing changes.
* Create a bare repo with
-```bash
-git init --bare project-name.git
-```
+
+ ```bash
+ git init --bare project-name.git
+ ```
----------
## Instantiate workflow with clone
1. Create a project in your user namespace
- - Choose to import from 'Any Repo by URL' and use
- https://gitlab.com/gitlab-org/training-examples.git
+ - Choose to import from 'Any Repo by URL' and use
+ https://gitlab.com/gitlab-org/training-examples.git
2. Create a '`Workspace`' directory in your home directory.
3. Clone the '`training-examples`' project
diff --git a/doc/university/training/topics/git_add.md b/doc/university/training/topics/git_add.md
index 651366e0d49..b1483e725fe 100644
--- a/doc/university/training/topics/git_add.md
+++ b/doc/university/training/topics/git_add.md
@@ -11,27 +11,35 @@ comments: false
Adds content to the index or staging area.
* Adds a list of file
-```bash
-git add <files>
-```
+
+ ```bash
+ git add <files>
+ ```
+
* Adds all files including deleted ones
-```bash
-git add -A
-```
+
+ ```bash
+ git add -A
+ ```
----------
## Git add continued
* Add all text files in current dir
-```bash
-git add *.txt
-```
+
+ ```bash
+ git add *.txt
+ ```
+
* Add all text file in the project
-```bash
-git add "*.txt*"
-```
+
+ ```bash
+ git add "*.txt*"
+ ```
+
* Adds all files in directory
-```bash
-git add views/layouts/
-```
+
+ ```bash
+ git add views/layouts/
+ ```
diff --git a/doc/university/training/topics/git_log.md b/doc/university/training/topics/git_log.md
index f2709ae3890..3e39ea5cc9a 100644
--- a/doc/university/training/topics/git_log.md
+++ b/doc/university/training/topics/git_log.md
@@ -9,31 +9,36 @@ comments: false
Git log lists commit history. It allows searching and filtering.
* Initiate log
-```
-git log
-```
+
+ ```
+ git log
+ ```
* Retrieve set number of records:
-```
-git log -n 2
-```
+
+ ```
+ git log -n 2
+ ```
* Search commits by author. Allows user name or a regular expression.
-```
-git log --author="user_name"
-```
+
+ ```
+ git log --author="user_name"
+ ```
----------
* Search by comment message.
-```
-git log --grep="<pattern>"
-```
+
+ ```
+ git log --grep="<pattern>"
+ ```
* Search by date
-```
-git log --since=1.month.ago --until=3.weeks.ago
-```
+
+ ```
+ git log --since=1.month.ago --until=3.weeks.ago
+ ```
----------
diff --git a/doc/university/training/topics/rollback_commits.md b/doc/university/training/topics/rollback_commits.md
index 0db1d93d1dc..11cb557651f 100644
--- a/doc/university/training/topics/rollback_commits.md
+++ b/doc/university/training/topics/rollback_commits.md
@@ -9,26 +9,30 @@ comments: false
## Undo Commits
* Undo last commit putting everything back into the staging area.
-```
-git reset --soft HEAD^
-```
+
+ ```
+ git reset --soft HEAD^
+ ```
* Add files and change message with:
-```
-git commit --amend -m "New Message"
-```
+
+ ```
+ git commit --amend -m "New Message"
+ ```
----------
* Undo last and remove changes
-```
-git reset --hard HEAD^
-```
+
+ ```
+ git reset --hard HEAD^
+ ```
* Same as last one but for two commits back
-```
-git reset --hard HEAD^^
-```
+
+ ```
+ git reset --hard HEAD^^
+ ```
** Don't reset after pushing **
diff --git a/doc/university/training/topics/stash.md b/doc/university/training/topics/stash.md
index 5b27ac12f77..315ced1a196 100644
--- a/doc/university/training/topics/stash.md
+++ b/doc/university/training/topics/stash.md
@@ -10,50 +10,52 @@ 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.
* Stash
-```
-git stash save
-# or
-git stash
-# or with a message
-git stash save "this is a message to display on the list"
-```
+
+ ```
+ git stash save
+ # or
+ git stash
+ # or with a message
+ git stash save "this is a message to display on the list"
+ ```
* Apply stash to keep working on it
-```
-git stash apply
-# or apply a specific one from out stack
-git stash apply stash@{3}
-```
+
+ ```
+ git stash apply
+ # or apply a specific one from out stack
+ git stash apply stash@{3}
+ ```
----------
* Every time we save a stash it gets stacked so by using list we can see all our
stashes.
-```
-git stash list
-# or for more information (log methods)
-git stash list --stat
-```
+ ```
+ git stash list
+ # or for more information (log methods)
+ git stash list --stat
+ ```
* To clean our stack we need to manually remove them.
-```
-# drop top stash
-git stash drop
-# or
-git stash drop <name>
-# to clear all history we can use
-git stash clear
-```
+ ```
+ # drop top stash
+ git stash drop
+ # or
+ git stash drop <name>
+ # to clear all history we can use
+ git stash clear
+ ```
----------
* Apply and drop on one command
-```
- git stash pop
-```
+ ```
+ git stash pop
+ ```
* If we meet conflicts we need to either reset or commit our changes.
diff --git a/doc/university/training/topics/unstage.md b/doc/university/training/topics/unstage.md
index fc72949ade9..ee7913637b9 100644
--- a/doc/university/training/topics/unstage.md
+++ b/doc/university/training/topics/unstage.md
@@ -10,26 +10,27 @@ comments: false
* To remove files from stage use reset HEAD. Where HEAD is the last commit of the current branch.
-```bash
-git reset HEAD <file>
-```
+ ```bash
+ git reset HEAD <file>
+ ```
* This will unstage the file but maintain the modifications. To revert the file back to the state it was in before the changes we can use:
-```bash
-git checkout -- <file>
-```
+ ```bash
+ git checkout -- <file>
+ ```
----------
* To remove a file from disk and repo use 'git rm' and to rm a dir use the '-r' flag.
-```
-git rm '*.txt'
-git rm -r <dirname>
-```
+ ```
+ git rm '*.txt'
+ 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`.
-```
-git rm <filename> --cache
-```
+
+ ```
+ git rm <filename> --cache
+ ```