diff options
Diffstat (limited to 'doc/workflow')
| -rw-r--r-- | doc/workflow/README.md | 8 | ||||
| -rw-r--r-- | doc/workflow/img/todo_list_item.png | bin | 18776 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/img/todos_add_todo_sidebar.png | bin | 17524 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/img/todos_icon.png | bin | 4910 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/img/todos_index.png | bin | 98239 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/img/todos_mark_done_sidebar.png | bin | 17619 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/shortcuts.md | 133 | ||||
| -rw-r--r-- | doc/workflow/time_tracking.md | 90 | ||||
| -rw-r--r-- | doc/workflow/time_tracking/img/time_tracking_example_v12_2.png | bin | 16362 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/time_tracking/img/time_tracking_sidebar_v8_16.png | bin | 9068 -> 0 bytes | |||
| -rw-r--r-- | doc/workflow/timezone.md | 40 | ||||
| -rw-r--r-- | doc/workflow/todos.md | 141 | ||||
| -rw-r--r-- | doc/workflow/workflow.md | 34 |
13 files changed, 18 insertions, 428 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md index 6bd78fac647..63f7b83f388 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.md @@ -5,10 +5,9 @@ comments: false # Workflow - [Automatic issue closing](../user/project/issues/managing_issues.md#closing-issues-automatically) -- [Change your time zone](timezone.md) - [Cycle Analytics](../user/project/cycle_analytics.md) - [Description templates](../user/project/description_templates.md) -- [Feature branch workflow](workflow.md) +- [Feature branch workflow](../gitlab-basics/feature_branch_workflow.md) - [Groups](../user/group/index.md) - Issues - The GitLab Issue Tracker is an advanced and complete tool for tracking the evolution of a new idea or the process of solving a problem. @@ -16,7 +15,6 @@ comments: false - [Confidential issues](../user/project/issues/confidential_issues.md) - [Due date for issues](../user/project/issues/due_dates.md) - [Issue Board](../user/project/issue_board.md) -- [Keyboard shortcuts](shortcuts.md) - [File finder](../user/project/repository/file_finder.md) - [File lock](../user/project/file_lock.md) **(PREMIUM)** - [Labels](../user/project/labels.md) @@ -27,7 +25,6 @@ comments: false - [Protected tags](../user/project/protected_tags.md) - [Quick Actions](../user/project/quick_actions.md) - [Sharing projects with groups](../user/project/members/share_project_with_groups.md) -- [Time tracking](time_tracking.md) - [Web Editor](../user/project/repository/web_editor.md) - [Milestones](../user/project/milestones/index.md) - [Merge Requests](../user/project/merge_requests/index.md) @@ -42,7 +39,6 @@ comments: false - [Fast-forward merge requests](../user/project/merge_requests/fast_forward_merge.md) - [Merge request approvals](../user/project/merge_requests/merge_request_approvals.md) **(STARTER)** - [Service Desk](../user/project/service_desk.md) **(PREMIUM)** -- [Importing from SVN, GitHub, Bitbucket, etc](importing/README.md) -- [Todos](todos.md) +- [Importing from SVN, GitHub, Bitbucket, etc](../user/project/import/index.md) - [Snippets](../user/snippets.md) - [Subgroups](../user/group/subgroups/index.md) diff --git a/doc/workflow/img/todo_list_item.png b/doc/workflow/img/todo_list_item.png Binary files differdeleted file mode 100644 index 91bbf9e5373..00000000000 --- a/doc/workflow/img/todo_list_item.png +++ /dev/null diff --git a/doc/workflow/img/todos_add_todo_sidebar.png b/doc/workflow/img/todos_add_todo_sidebar.png Binary files differdeleted file mode 100644 index aefec7a2d9c..00000000000 --- a/doc/workflow/img/todos_add_todo_sidebar.png +++ /dev/null diff --git a/doc/workflow/img/todos_icon.png b/doc/workflow/img/todos_icon.png Binary files differdeleted file mode 100644 index 9fee4337a75..00000000000 --- a/doc/workflow/img/todos_icon.png +++ /dev/null diff --git a/doc/workflow/img/todos_index.png b/doc/workflow/img/todos_index.png Binary files differdeleted file mode 100644 index 99c1575d157..00000000000 --- a/doc/workflow/img/todos_index.png +++ /dev/null diff --git a/doc/workflow/img/todos_mark_done_sidebar.png b/doc/workflow/img/todos_mark_done_sidebar.png Binary files differdeleted file mode 100644 index 2badd880b40..00000000000 --- a/doc/workflow/img/todos_mark_done_sidebar.png +++ /dev/null diff --git a/doc/workflow/shortcuts.md b/doc/workflow/shortcuts.md index 2ec733182f8..4b35c61ec5e 100644 --- a/doc/workflow/shortcuts.md +++ b/doc/workflow/shortcuts.md @@ -1,134 +1,5 @@ --- -type: reference +redirect_to: '../user/shortcuts.md' --- -# GitLab keyboard shortcuts - -GitLab has many useful keyboard shortcuts to make it easier to access different features. -You can see the quick reference sheet within GitLab itself with <kbd>Shift</kbd> + <kbd>?</kbd>. - -The [Global Shortcuts](#global-shortcuts) work from any area of GitLab, but you must -be in specific pages for the other shortcuts to be available, as explained in each -section below. - -## Global Shortcuts - -These shortcuts are available in most areas of GitLab - -| Keyboard Shortcut | Description | -| ------------------------------- | ----------- | -| <kbd>?</kbd> | Show/hide shortcut reference sheet. | -| <kbd>Shift</kbd> + <kbd>p</kbd> | Go to your Projects page. | -| <kbd>Shift</kbd> + <kbd>g</kbd> | Go to your Groups page. | -| <kbd>Shift</kbd> + <kbd>a</kbd> | Go to your Activity page. | -| <kbd>Shift</kbd> + <kbd>l</kbd> | Go to your Milestones page. | -| <kbd>Shift</kbd> + <kbd>s</kbd> | Go to your Snippets page. | -| <kbd>s</kbd> | Put cursor in the issues/merge requests search. | -| <kbd>Shift</kbd> + <kbd>i</kbd> | Go to your Issues page. | -| <kbd>Shift</kbd> + <kbd>m</kbd> | Go to your Merge requests page.| -| <kbd>Shift</kbd> + <kbd>t</kbd> | Go to your To-Do List page. | -| <kbd>p</kbd> + <kbd>b</kbd> | Show/hide the Performance Bar. | - -Additionally, the following shortcuts are available when editing text in text fields, -for example comments, replies, or issue and merge request descriptions: - -| Keyboard Shortcut | Description | -| ---------------------------------------------------------------------- | ----------- | -| <kbd>↑</kbd> | Edit your last comment. You must be in a blank text field below a thread, and you must already have at least one comment in the thread. | -| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>p</kbd> | Toggle Markdown preview, when editing text in a text field that has **Write** and **Preview** tabs at the top. | - -## Project - -These shortcuts are available from any page within a project. You must type them -relatively quickly to work, and they will take you to another page in the project. - -| Keyboard Shortcut | Description | -| --------------------------- | ----------- | -| <kbd>g</kbd> + <kbd>p</kbd> | Go to the project home page (**Project > Details**). | -| <kbd>g</kbd> + <kbd>v</kbd> | Go to the project activity feed (**Project > Activity**). | -| <kbd>g</kbd> + <kbd>r</kbd> | Go to the project releases list (**Project > Releases**). | -| <kbd>g</kbd> + <kbd>f</kbd> | Go to the [project files](#project-files) list (**Repository > Files**). | -| <kbd>t</kbd> | Go to the project file search page. (**Repository > Files**, click **Find Files**). | -| <kbd>g</kbd> + <kbd>c</kbd> | Go to the project commits list (**Repository > Commits**). | -| <kbd>g</kbd> + <kbd>n</kbd> | Go to the [repository graph](#repository-graph) page (**Repository > Graph**). | -| <kbd>g</kbd> + <kbd>d</kbd> | Go to repository charts (**Repository > Charts**). | -| <kbd>g</kbd> + <kbd>i</kbd> | Go to the project issues list (**Issues > List**). | -| <kbd>i</kbd> | Go to the New Issue page (**Issues**, click **New Issue** ). | -| <kbd>g</kbd> + <kbd>b</kbd> | Go to the project issue boards list (**Issues > Boards**). | -| <kbd>g</kbd> + <kbd>m</kbd> | Go to the project merge requests list (**Merge Requests**). | -| <kbd>g</kbd> + <kbd>j</kbd> | Go to the CI/CD jobs list (**CI/CD > Jobs**). | -| <kbd>g</kbd> + <kbd>l</kbd> | Go to the project metrics (**Operations > Metrics**). | -| <kbd>g</kbd> + <kbd>e</kbd> | Go to the project environments (**Operations > Environments**). | -| <kbd>g</kbd> + <kbd>k</kbd> | Go to the project Kubernetes cluster integration page (**Operations > Kubernetes**). Note that you must have at least [`maintainer` permissions](../user/permissions.md) to access this page. | -| <kbd>g</kbd> + <kbd>s</kbd> | Go to the project snippets list (**Snippets**). | -| <kbd>g</kbd> + <kbd>w</kbd> | Go to the project wiki (**Wiki**), if enabled. | - -### Issues and Merge Requests - -These shortcuts are available when viewing issues and merge requests. - -| Keyboard Shortcut | Description | -| ---------------------------- | ----------- | -| <kbd>e</kbd> | Edit description. | -| <kbd>a</kbd> | Change assignee. | -| <kbd>m</kbd> | Change milestone. | -| <kbd>l</kbd> | Change label. | -| <kbd>r</kbd> | Start writing a comment. If any text is selected, it will be quoted in the comment. Can't be used to reply within a thread. | -| <kbd>n</kbd> | Move to next unresolved discussion (Merge requests only). | -| <kbd>p</kbd> | Move to previous unresolved discussion (Merge requests only). | -| <kbd>]</kbd> or <kbd>j</kbd> | Move to next file (Merge requests only). | -| <kbd>[</kbd> or <kbd>k</kbd> | Move to previous file (Merge requests only). | - -### Project Files - -These shortcuts are available when browsing the files in a project (navigate to -**Repository** > **Files**): - -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>↑</kbd> | Move selection up. | -| <kbd>↓</kbd> | Move selection down. | -| <kbd>enter</kbd> | Open selection. | -| <kbd>esc</kbd> | Go back to file list screen (only while searching for files, **Repository > Files** then click on **Find File**). | -| <kbd>y</kbd> | Go to file permalink (only while viewing a file). | - -### Web IDE - -These shortcuts are available when editing a file with the [Web IDE](../user/project/web_ide/index.md): - -| Keyboard Shortcut | Description | -| ------------------------------------------------------- | ----------- | -| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>p</kbd> | Search for, and then open another file for editing. | -| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>Enter</kbd> | Commit (when editing the commit message). | - -### Repository Graph - -These shortcuts are available when viewing the project [repository graph](../user/project/repository/index.md#repository-graph) -page (navigate to **Repository > Graph**): - -| Keyboard Shortcut | Description | -| ------------------------------------------------------------------ | ----------- | -| <kbd>←</kbd> or <kbd>h</kbd> | Scroll left. | -| <kbd>→</kbd> or <kbd>l</kbd> | Scroll right. | -| <kbd>↑</kbd> or <kbd>k</kbd> | Scroll up. | -| <kbd>↓</kbd> or <kbd>j</kbd> | Scroll down. | -| <kbd>Shift</kbd> + <kbd>↑</kbd> or <kbd>Shift</kbd> + <kbd>k</kbd> | Scroll to top. | -| <kbd>Shift</kbd> + <kbd>↓</kbd> or <kbd>Shift</kbd> + <kbd>j</kbd> | Scroll to bottom. | - -### Wiki pages - -This shortcut is available when viewing a [wiki page](../user/project/wiki/index.md): - -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>e</kbd> | Edit wiki page. | - -## Epics **(ULTIMATE)** - -These shortcuts are available when viewing [Epics](../user/group/epics/index.md): - -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>r</kbd> | Start writing a comment. If any text is selected, it will be quoted in the comment. Can't be used to reply within a thread. | -| <kbd>e</kbd> | Edit description. | -| <kbd>l</kbd> | Change label. | +This document was moved to [another location](../user/shortcuts.md). diff --git a/doc/workflow/time_tracking.md b/doc/workflow/time_tracking.md index 3d2e1de24da..e109410e22d 100644 --- a/doc/workflow/time_tracking.md +++ b/doc/workflow/time_tracking.md @@ -1,91 +1,5 @@ --- -type: reference +redirect_to: '../user/project/time_tracking.md' --- -# Time Tracking - -> Introduced in GitLab 8.14. - -Time Tracking allows you to track estimates and time spent on issues and merge -requests within GitLab. - -## Overview - -Time Tracking allows you to: - -- Record the time spent working on an issue or a merge request. -- Add an estimate of the amount of time needed to complete an issue or a merge - request. - -You don't have to indicate an estimate to enter the time spent, and vice versa. - -Data about time tracking is shown on the issue/merge request sidebar, as shown -below. - - - -## How to enter data - -Time Tracking uses two [quick actions](../user/project/quick_actions.md) -that GitLab introduced with this new feature: `/spend` and `/estimate`. - -Quick actions can be used in the body of an issue or a merge request, but also -in a comment in both an issue or a merge request. - -Below is an example of how you can use those new quick actions inside a comment. - - - -Adding time entries (time spent or estimates) is limited to project members. - -### Estimates - -To enter an estimate, write `/estimate`, followed by the time. For example, if -you need to enter an estimate of 3 days, 5 hours and 10 minutes, you would write -`/estimate 3d 5h 10m`. Time units that we support are listed at the bottom of -this help page. - -Every time you enter a new time estimate, any previous time estimates will be -overridden by this new value. There should only be one valid estimate in an -issue or a merge request. - -To remove an estimation entirely, use `/remove_estimate`. - -### Time spent - -To enter a time spent, use `/spend 3d 5h 10m`. - -Every new time spent entry will be added to the current total time spent for the -issue or the merge request. - -You can remove time by entering a negative amount: `/spend -3d` will remove 3 -days from the total time spent. You can't go below 0 minutes of time spent, -so GitLab will automatically reset the time spent if you remove a larger amount -of time compared to the time that was entered already. - -To remove all the time spent at once, use `/remove_time_spent`. - -## Configuration - -The following time units are available: - -- Months (mo) -- Weeks (w) -- Days (d) -- Hours (h) -- Minutes (m) - -Default conversion rates are 1mo = 4w, 1w = 5d and 1d = 8h. - -### Limit displayed units to hours **(CORE ONLY)** - -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/29469/) in GitLab 12.1. - -In GitLab self-managed instances, the display of time units can be limited to -hours through the option in **Admin Area > Settings > Preferences** under **Localization**. - -With this option enabled, `75h` is displayed instead of `1w 4d 3h`. - -## Other interesting links - -- [Time Tracking landing page in the GitLab handbook](https://about.gitlab.com/solutions/time-tracking/) +This document was moved to [another location](../user/project/time_tracking.md). diff --git a/doc/workflow/time_tracking/img/time_tracking_example_v12_2.png b/doc/workflow/time_tracking/img/time_tracking_example_v12_2.png Binary files differdeleted file mode 100644 index 31d8c490ed1..00000000000 --- a/doc/workflow/time_tracking/img/time_tracking_example_v12_2.png +++ /dev/null diff --git a/doc/workflow/time_tracking/img/time_tracking_sidebar_v8_16.png b/doc/workflow/time_tracking/img/time_tracking_sidebar_v8_16.png Binary files differdeleted file mode 100644 index 22124afed6f..00000000000 --- a/doc/workflow/time_tracking/img/time_tracking_sidebar_v8_16.png +++ /dev/null diff --git a/doc/workflow/timezone.md b/doc/workflow/timezone.md index 3594ba19181..f1a2e1af66a 100644 --- a/doc/workflow/timezone.md +++ b/doc/workflow/timezone.md @@ -1,37 +1,5 @@ -# Changing your time zone +--- +redirect_to: '../administration/timezone.md' +--- -The global time zone configuration parameter can be changed in `config/gitlab.yml`: - -```text -# time_zone: 'UTC' -``` - -Uncomment and customize if you want to change the default time zone of the GitLab application. - -## Viewing available timezones - -To see all available time zones, run `bundle exec rake time:zones:all`. - -For Omnibus installations, run `gitlab-rake time:zones:all`. - -NOTE: **Note:** -Currently, this rake task does not list timezones in TZInfo format required by GitLab Omnibus during a reconfigure: [#58672](https://gitlab.com/gitlab-org/gitlab-foss/issues/58672). - -## Changing time zone in Omnibus installations - -GitLab defaults its time zone to UTC. It has a global timezone configuration parameter in `/etc/gitlab/gitlab.rb`. - -To obtain a list of timezones, log in to your GitLab application server and run a command that generates a list of timezones in TZInfo format for the server. For example, install `timedatectl` and run `timedatectl list-timezones`. - -To update, add the timezone that best applies to your location. For example: - -```ruby -gitlab_rails['time_zone'] = 'America/New_York' -``` - -After adding the configuration parameter, reconfigure and restart your GitLab instance: - -```sh -gitlab-ctl reconfigure -gitlab-ctl restart -``` +This document was moved to [another location](../administration/timezone.md). diff --git a/doc/workflow/todos.md b/doc/workflow/todos.md index 5d576d8ff35..48c9a3faf1d 100644 --- a/doc/workflow/todos.md +++ b/doc/workflow/todos.md @@ -1,138 +1,5 @@ -# GitLab To-Do List +--- +redirect_to: '../user/todos.md' +--- -> [Introduced][ce-2817] in GitLab 8.5. - -When you log into GitLab, you normally want to see where you should spend your -time, take some action, or know what you need to keep an eye on without -a huge pile of e-mail notifications. GitLab is where you do your work, -so being able to get started quickly is important. - -Your To-Do List offers a chronological list of items that are waiting for your input, all -in a simple dashboard. - - - -You can quickly access your To-Do List by clicking the checkmark icon next to the -search bar in the top navigation. If the count is: - -- Less than 100, the number in blue is the number of To-Do items. -- 100 or more, the number displays as 99+. The exact number displays - on the To-Do List. -you still have open. Otherwise, the number displays as 99+. The exact number -displays on the To-Do List. - - - -## What triggers a To Do - -A To Do displays on your To-Do List when: - -- An issue or merge request is assigned to you -- You are `@mentioned` in the description or comment of an: - - Issue - - Merge Request - - Epic **(ULTIMATE)** -- You are `@mentioned` in a comment on a commit -- A job in the CI pipeline running for your merge request failed, but this - job is not allowed to fail -- An open merge request becomes unmergeable due to conflict, and you are either: - - The author - - Have set it to automatically merge once the pipeline succeeds - -To-do triggers are not affected by [GitLab Notification Email settings](notifications.md). - -NOTE: **Note:** -When a user no longer has access to a resource related to a To Do (like an issue, merge request, project, or group) the related To-Do items are deleted within the next hour for security reasons. The delete is delayed to prevent data loss, in case the user's access was revoked by mistake. - -### Directly addressing a To Do - -> [Introduced][ce-7926] in GitLab 9.0. - -If you are mentioned at the start of a line, the To Do you receive will be listed -as 'directly addressed'. For example, in this comment: - -```markdown -@alice What do you think? cc: @bob - -- @carol can you please have a look? - ->>> -@dan what do you think? ->>> - -@erin @frank thank you! -``` - -The people receiving directly addressed To-Do items are `@alice`, `@erin`, and -`@frank`. Directly addressed To-Do items only differ from mentions in their type -for filtering purposes; otherwise, they appear as normal. - -### Manually creating a To Do - -You can also add the following to your To-Do List by clicking the **Add a To Do** button on an: - -- Issue -- Merge Request -- Epic **(ULTIMATE)** - - - -## Marking a To Do as done - -Any action to the following will mark the corresponding To Do as done: - -- Issue -- Merge Request -- Epic **(ULTIMATE)** - -Actions that dismiss To-Do items include: - -- Changing the assignee -- Changing the milestone -- Adding/removing a label -- Commenting on the issue - -Your To-Do List is personal, and items are only marked as done if the action comes from -you. If you close the issue or merge request, your To Do is automatically -marked as done. - -To prevent other users from closing issues without you being notified, if someone else closes, merges, or takes action on the any of the following, your To Do will remain pending: - -- Issue -- Merge request -- Epic **(ULTIMATE)** - -There is just one To Do for each of these, so mentioning a user a hundred times in an issue will only trigger one To Do. - -If no action is needed, you can manually mark the To Do as done by clicking the -corresponding **Done** button, and it will disappear from your To-Do List. - - - -You can also mark a To Do as done by clicking the **Mark as done** button in the sidebar of the following: - -- Issue -- Merge Request -- Epic **(ULTIMATE)** - - - -You can mark all your To-Do items as done at once by clicking the **Mark all as -done** button. - -## Filtering your To-Do List - -There are four kinds of filters you can use on your To-Do List. - -| Filter | Description | -| ------- | ----------- | -| Project | Filter by project | -| Group | Filter by group | -| Author | Filter by the author that triggered the To Do | -| Type | Filter by issue, merge request, or epic **(ULTIMATE)** | -| Action | Filter by the action that triggered the To Do | - -You can also filter by more than one of these at the same time. The possible Actions are `Any Action`, `Assigned`, `Mentioned`, `Added`, `Pipelines`, and `Directly Addressed`, [as described above](#what-triggers-a-to-do). - -[ce-2817]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/2817 -[ce-7926]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/7926 +This document was moved to [another location](../user/todos.md). diff --git a/doc/workflow/workflow.md b/doc/workflow/workflow.md index 7fac41c3b6f..c77d95cd326 100644 --- a/doc/workflow/workflow.md +++ b/doc/workflow/workflow.md @@ -1,31 +1,5 @@ -# Feature branch workflow +--- +redirect_to: '../gitlab-basics/feature_branch_workflow.md' +--- -1. Clone project: - - ```bash - git clone git@example.com:project-name.git - ``` - -1. Create branch with your feature: - - ```bash - git checkout -b $feature_name - ``` - -1. Write code. Commit changes: - - ```bash - git commit -am "My feature is ready" - ``` - -1. Push your branch to GitLab: - - ```bash - git push origin $feature_name - ``` - -1. Review your code on commits page. - -1. Create a merge request. - -1. Your team lead will review the code & merge it to the main branch. +This document was moved to [another location](../gitlab-basics/feature_branch_workflow.md). |
