diff options
Diffstat (limited to 'doc/university/training')
-rw-r--r-- | doc/university/training/end-user/README.md | 5 | ||||
-rw-r--r-- | doc/university/training/gitlab_flow.md | 57 | ||||
-rw-r--r-- | doc/university/training/index.md | 8 | ||||
-rw-r--r-- | doc/university/training/topics/explore_gitlab.md | 8 | ||||
-rw-r--r-- | doc/university/training/topics/getting_started.md | 4 | ||||
-rw-r--r-- | doc/university/training/topics/gitlab_flow.md | 3 | ||||
-rw-r--r-- | doc/university/training/user_training.md | 6 |
7 files changed, 16 insertions, 75 deletions
diff --git a/doc/university/training/end-user/README.md b/doc/university/training/end-user/README.md deleted file mode 100644 index c0251229916..00000000000 --- a/doc/university/training/end-user/README.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -redirect_to: 'https://docs.gitlab.com' ---- - -Visit our [documentation page](https://docs.gitlab.com) for information about GitLab. diff --git a/doc/university/training/gitlab_flow.md b/doc/university/training/gitlab_flow.md index f25bff03926..bdc97ff8d28 100644 --- a/doc/university/training/gitlab_flow.md +++ b/doc/university/training/gitlab_flow.md @@ -1,57 +1,8 @@ --- -stage: none -group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments -comments: false -type: reference +redirect_to: '../../topics/gitlab_flow.md' --- -# What is the GitLab Flow +This document was moved to [another location](../../topics/gitlab_flow.md). -- A simplified branching strategy -- All features and fixes first go to master -- Allows for 'production' or 'stable' branches -- Bug fixes/hot fix patches are cherry-picked from master - -## Feature branches - -- Create a feature/bugfix branch to do all work -- Use merge requests to merge to master - -![inline](gitlab_flow/feature_branches.png) - -## Production branch - -- One, long-running production release branch - as opposed to individual stable branches -- Consider creating a tag for each version that gets deployed - -![inline](gitlab_flow/production_branch.png) - -## Release branch - -- Useful if you release software to customers -- When preparing a new release, create stable branch - from master -- Consider creating a tag for each version -- Cherry-pick critical bug fixes to stable branch for patch release -- Never commit bug fixes directly to stable branch - -![inline](gitlab_flow/release_branches.png) - -## More details - -For more information, read through the [GitLab Flow](../../topics/gitlab_flow.md) -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. --> +<!-- This redirect file can be deleted after <2021-05-16>. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/university/training/index.md b/doc/university/training/index.md index deae79e51b0..13cf4184560 100644 --- a/doc/university/training/index.md +++ b/doc/university/training/index.md @@ -8,8 +8,10 @@ type: index # GitLab Training Material +<!-- vale gitlab.Spelling = NO --> All GitLab training material is stored in Markdown format. Slides are -generated using [Deskset](https://www.deckset.com/). +generated using [Deckset](https://www.deckset.com/). +<!-- vale gitlab.Spelling = YES --> All training material is open to public contribution. @@ -20,7 +22,7 @@ This section contains the following topics: - [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](../../gitlab-basics/README.md). +- [Explore GitLab](../../gitlab-basics/index.md). - [Feature branching](topics/feature_branching.md). - [Getting started](topics/getting_started.md). - [GitLab flow](gitlab_flow.md). @@ -40,6 +42,6 @@ This section contains the following topics: 1. [GitLab Documentation](https://docs.gitlab.com) 1. [GUI Clients](https://git-scm.com/downloads/guis) 1. [Pro Git book](https://git-scm.com/book/en/v2) -1. [Platzi Course](https://courses.platzi.com/courses/git-gitlab/) +1. <!-- vale gitlab.Spelling = NO --> [Platzi Course](https://courses.platzi.com/courses/git-gitlab/) <!-- vale gitlab.Spelling = NO --> 1. [Code School tutorial](http://try.github.io/) 1. Contact us at `subscribers@gitlab.com` diff --git a/doc/university/training/topics/explore_gitlab.md b/doc/university/training/topics/explore_gitlab.md deleted file mode 100644 index 584069aa7b0..00000000000 --- a/doc/university/training/topics/explore_gitlab.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: '../../../gitlab-basics/README.md' ---- - -This document was moved to [another location](../../../gitlab-basics/README.md). - -<!-- This redirect file can be deleted after February 1, 2021. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/university/training/topics/getting_started.md b/doc/university/training/topics/getting_started.md index fd600624a25..2c3d5fe15de 100644 --- a/doc/university/training/topics/getting_started.md +++ b/doc/university/training/topics/getting_started.md @@ -21,7 +21,7 @@ comments: false git clone <url> ``` -## Central Repos +## Central Repositories - To instantiate a central repository a `--bare` flag is required. - Bare repositories don't allow file editing or committing changes. @@ -34,7 +34,7 @@ comments: false ## 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 Repository by URL** and use <https://gitlab.com/gitlab-org/training-examples.git>. 1. Create a '`Workspace`' directory in your home directory. 1. Clone the '`training-examples`' project. diff --git a/doc/university/training/topics/gitlab_flow.md b/doc/university/training/topics/gitlab_flow.md deleted file mode 100644 index f6006ce0a60..00000000000 --- a/doc/university/training/topics/gitlab_flow.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -redirect_to: '../gitlab_flow.md' ---- diff --git a/doc/university/training/user_training.md b/doc/university/training/user_training.md index ad8f094d185..75c4fe25842 100644 --- a/doc/university/training/user_training.md +++ b/doc/university/training/user_training.md @@ -102,7 +102,7 @@ ssh-rsa AAAAB3NzaC1yc2EAAAADAQEL17Ufacg8cDhlQMS5NhV8z3GHZdhCrZbl4gz you@example. ## Create a project - 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 Repository by URL** and use <https://gitlab.com/gitlab-org/training-examples.git>. - Create a '`development`' or '`workspace`' directory in your home directory. - Clone the '`training-examples`' project. @@ -214,9 +214,13 @@ Create your first merge request: ## Feedback and Collaboration resources +<!-- vale gitlab.Spelling = NO --> + Review the Thoughtbot code-review guide for suggestions to follow when reviewing merge requests: <https://github.com/thoughtbot/guides/tree/master/code-review>. +<!-- vale gitlab.Spelling = YES --> + See GitLab merge requests for examples: <https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests>. ## Explore GitLab projects |