From 664b1d3636f5c6a47a5ad6132cb02b68b2ebec3c Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 21 Aug 2017 20:44:36 +0000 Subject: Merge branch '36533-add-docs-for-group-issues-page-and-group-merge-requests-page' into 'master' Add docs for group issues page and group merge requests page Closes #36533 See merge request !13678 --- doc/user/group/index.md | 6 +++++ doc/user/index.md | 4 +++ .../project/issues/img/group_issues_list_view.png | Bin 0 -> 265130 bytes doc/user/project/issues/img/issue_tracker.png | Bin 37037 -> 0 bytes .../issues/img/project_issues_list_view.png | Bin 0 -> 309131 bytes doc/user/project/issues/index.md | 30 ++++++++++++++++++--- .../img/group_merge_requests_list_view.png | Bin 0 -> 283066 bytes .../img/project_merge_requests_list_view.png | Bin 0 -> 325819 bytes doc/user/project/merge_requests/index.md | 20 ++++++++++++-- doc/user/search/index.md | 8 ++++-- 10 files changed, 60 insertions(+), 8 deletions(-) create mode 100644 doc/user/project/issues/img/group_issues_list_view.png delete mode 100755 doc/user/project/issues/img/issue_tracker.png create mode 100644 doc/user/project/issues/img/project_issues_list_view.png create mode 100644 doc/user/project/merge_requests/img/group_merge_requests_list_view.png create mode 100644 doc/user/project/merge_requests/img/project_merge_requests_list_view.png diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 08da721c71d..4e997fe037b 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -55,6 +55,12 @@ By doing so: - John mentions everyone from his team with `@john-team` - John mentions only his marketing team with `@john-team/marketing` +## Issues and merge requests within a group + +Issues and merge requests are part of projects. For a given group, view all the +[issues](../project/issues/index.md#issues-per-group) and [merge requests](../project/merge_requests/index.md#merge-requests-per-group) across all the projects in that group, +together in a single list view. + ## Create a new group You can create a group in GitLab from: diff --git a/doc/user/index.md b/doc/user/index.md index 1281cc6e4f0..bab149f5026 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -162,6 +162,10 @@ are a tool for working faster and more effectively with your team, by listing all user or group mentions, as well as issues and merge requests you're assigned to. +## Search + +[Search and filter](search/index.md) through groups, projects, issues, merge requests, files, code, and more. + ## Snippets [Snippets](snippets.md) are code blocks that you want to store in GitLab, from which diff --git a/doc/user/project/issues/img/group_issues_list_view.png b/doc/user/project/issues/img/group_issues_list_view.png new file mode 100644 index 00000000000..5d20e8cbc89 Binary files /dev/null and b/doc/user/project/issues/img/group_issues_list_view.png differ diff --git a/doc/user/project/issues/img/issue_tracker.png b/doc/user/project/issues/img/issue_tracker.png deleted file mode 100755 index ab25cb64d13..00000000000 Binary files a/doc/user/project/issues/img/issue_tracker.png and /dev/null differ diff --git a/doc/user/project/issues/img/project_issues_list_view.png b/doc/user/project/issues/img/project_issues_list_view.png new file mode 100644 index 00000000000..2fcc9e8d9da Binary files /dev/null and b/doc/user/project/issues/img/project_issues_list_view.png differ diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index 1f78849a92c..20901e01f6e 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -7,7 +7,7 @@ of solving a problem. It allows you, your team, and your collaborators to share and discuss proposals before and while implementing them. -Issues and the GitLab Issue Tracker are available in all +GitLab Issues and the GitLab Issue Tracker are available in all [GitLab Products](https://about.gitlab.com/products/) as part of the [GitLab Workflow](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/). @@ -48,11 +48,27 @@ for feature proposals and another one for bug reports. ## Issue Tracker -The issue tracker is the collection of opened and closed issues created in a project. +The Issue Tracker is the collection of opened and closed issues created in a project. +It is available for all projects, from the moment the project is created. -![Issue tracker](img/issue_tracker.png) +Find the issue tracker by navigating to your **Project's homepage** > **Issues**. -Find the issue tracker by navigating to your **Project's Dashboard** > **Issues**. +### Issues per project + +When you access your project's issues, GitLab will present them in a list, +and you can use the tabs available to quickly filter by open and closed issues. + +![Project issues list view](img/project_issues_list_view.png) + +You can also [search and filter](../../search/index.md#issues-and-merge-requests-per-project) the results more deeply with GitLab's search capacities. + +### Issues per group + +View all the issues in a group (that is, all the issues across all projects in that +group) by navigating to **Group > Issues**. This view also has the open and closed +issue tabs. + +![Group Issues list view](img/group_issues_list_view.png) ## GitLab Issues Functionalities @@ -120,6 +136,12 @@ to find out more about this feature. With [GitLab Enterprise Edition Starter](https://about.gitlab.com/gitlab-ee/), you can also create various boards per project with [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards). +### External Issue Tracker + +Alternatively to GitLab's built-in Issue Tracker, you can also use an [external +tracker](../../../integration/external-issue-tracker.md) such as Jira, Redmine, +or Bugzilla. + ### Issue's API Read through the [API documentation](../../../api/issues.md). diff --git a/doc/user/project/merge_requests/img/group_merge_requests_list_view.png b/doc/user/project/merge_requests/img/group_merge_requests_list_view.png new file mode 100644 index 00000000000..02a88d0112f Binary files /dev/null and b/doc/user/project/merge_requests/img/group_merge_requests_list_view.png differ diff --git a/doc/user/project/merge_requests/img/project_merge_requests_list_view.png b/doc/user/project/merge_requests/img/project_merge_requests_list_view.png new file mode 100644 index 00000000000..702ec1a2949 Binary files /dev/null and b/doc/user/project/merge_requests/img/project_merge_requests_list_view.png differ diff --git a/doc/user/project/merge_requests/index.md b/doc/user/project/merge_requests/index.md index 9bdf2a998d3..285c40729fe 100644 --- a/doc/user/project/merge_requests/index.md +++ b/doc/user/project/merge_requests/index.md @@ -56,6 +56,23 @@ B. Consider you're a web developer writing a webpage for your company's: 1. Once approved, your merge request is [squashed and merged](https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html), and [deployed to staging with GitLab Pages](https://about.gitlab.com/2016/08/26/ci-deployment-and-environments/) (Squash and Merge is available in GitLab Enterprise Edition Starter) 1. Your production team [cherry picks](#cherry-pick-changes) the merge commit into production +## Merge requests per project + +View all the merge requests within a project by navigating to **Project > Merge Requests**. + +When you access your project's merge requests, GitLab will present them in a list, +and you can use the tabs available to quickly filter by open and closed. You can also [search and filter the results](../../search/index.md#issues-and-merge-requests-per-project). + +![Project merge requests list view](img/project_merge_requests_list_view.png) + +## Merge requests per group + +View all the merge requests in a group (that is, all the merge requests across all projects in that +group) by navigating to **Group > Merge Requests**. This view also has the open, merged, and closed +merge request tabs, from which you can [search and filter the results](../../search/index.md#issues-and-merge-requests-per-group). + +![Group Issues list view](img/group_merge_requests_list_view.png) + ## Authorization for merge requests There are two main ways to have a merge request flow with GitLab: @@ -141,7 +158,6 @@ all your changes will be available to preview by anyone with the Review Apps lin [Read more about Review Apps.](../../../ci/review_apps/index.md) - ## Tips Here are some tips that will help you be more efficient with merge requests in @@ -230,4 +246,4 @@ git checkout origin/merge-requests/1 ``` [protected branches]: ../protected_branches.md -[ee]: https://about.gitlab.com/gitlab-ee/ "GitLab Enterprise Edition" +[ee]: https://about.gitlab.com/gitlab-ee/ "GitLab Enterprise Edition" \ No newline at end of file diff --git a/doc/user/search/index.md b/doc/user/search/index.md index 79f34fd29ba..f5c7ce49e8e 100644 --- a/doc/user/search/index.md +++ b/doc/user/search/index.md @@ -27,7 +27,7 @@ on the search field on the top-right of your screen: ![shortcut to your issues and mrs](img/issues_mrs_shortcut.png) -## Issues and merge requests per project +### Issues and merge requests per project If you want to search for issues present in a specific project, navigate to a project's **Issues** tab, and click on the field **Search or filter results...**. It will @@ -40,7 +40,7 @@ The same process is valid for merge requests. Navigate to your project's **Merge and click **Search or filter results...**. Merge requests can be filtered by author, assignee, milestone, and label. -## Issues and merge requests per group +### Issues and merge requests per group Similar to **Issues and merge requests per project**, you can also search for issues within a group. Navigate to a group's **Issues** tab and query search results in @@ -48,6 +48,10 @@ the same way as you do for projects. ![filter issues in a group](img/group_issues_filter.png) +The same process is valid for merge requests. Navigate to your project's **Merge Requests** tab. +The search and filter UI currently uses dropdowns. In a future release, the same +dynamic UI as above will be carried over here. + ## Search history You can view recent searches by clicking on the little arrow-clock icon, which is to the left of the search input. Click the search entry to run that search again. This feature is available for issues and merge requests. Searches are stored locally in your browser. -- cgit v1.2.1