From 78c52a3a9bbb5e273e77feaf5ecf84140a938f8d Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Wed, 28 Jun 2017 18:41:06 -0300 Subject: improve site search for "issues" --- doc/user/project/issues/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index fe87e6f9495..e55e2aea023 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -1,4 +1,4 @@ -# Issues documentation +# Issues The GitLab Issue Tracker is an advanced and complete tool for tracking the evolution of a new idea or the process -- cgit v1.2.1 From 93646acc1c63baa03c2406d09e3a11036e520d6f Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Wed, 28 Jun 2017 19:48:26 -0300 Subject: capitalize feature name, add overview and use cases w/ multiple boards (EE) --- doc/user/project/issue_board.md | 42 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index ebea7062ecb..89819189864 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -1,4 +1,4 @@ -# Issue board +# Issue Board >**Notes:** - [Introduced][ce-5554] in GitLab 8.11. @@ -22,6 +22,42 @@ With the Issue Board you can have a different view of your issues while also maintaining the same filtering and sorting abilities you see across the issue tracker. +With [Multiple Issue Boards](#multiple-issue-boards), available only in [GitLab +Enterprise Edition](https://about.gitlab.com/gitlab-ee/), your workflow gets +empowered with the ability to create multiple boards per project. + +## Use-cases + +GitLab Workflow allows you to discuss proposals in issues, categorize them +with labels, and and from there organize and prioritize them in Issue Boards. + +- For example, let's consider this simplified development workflow: +you have a repository hosting your app's codebase +and your team actively contributing to code. Your backend team starts working a new +implementation, gathers feedback and approval, and pass it to frontend. +From there, when frontend is complete, the new feature +is deployed to staging to be tested. When successful, it goes to production. If we have +the labels "backend", "frontend", "staging", and "production", and an Issue Board with +a list for each, we can: + - Visualize the entire flow of implementations since the +beginning of the dev lifecycle until deployed to production + - Prioritize the issues in a list by moving them vertically + - Move issues between lists to organize them according to the labels you've set + +To enhance the workflow exemplified above, with [Multiple Issue Boards](#multiple-issue-boards), +available only in [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/), +each team (frontend and backend) can have their own boards to organize their flow among the +members of their teams. For that, we could have, therefore, three Issue Boards for this case: + + - **Backend**, for the backend team and their own labels and workflow + - **Frontend**, same as above, for the frontend team + - **Deployment**, for the entire process (backend > frontend > staging > production) + +For a broader use-case, please check the blog post +[GitLab Workflow, an Overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/#gitlab-workflow-use-case-scenario). + +## Issue Board terminology + Below is a table of the definitions used for GitLab's Issue Board. | What we call it | What it means | @@ -57,7 +93,7 @@ In short, here's a list of actions you can take in an Issue Board: If you are not able to perform one or more of the things above, make sure you have the right [permissions](#permissions). -## First time using the issue board +## First time using the Issue Board The first time you navigate to your Issue Board, you will be presented with a default list (**Done**) and a welcoming message that gives @@ -98,7 +134,7 @@ list view that is removed. You can always add it back later if you need. ## Adding issues to a list You can add issues to a list by clicking the **Add issues** button that is -present in the upper right corner of the issue board. This will open up a modal +present in the upper right corner of the Issue Board. This will open up a modal window where you can see all the issues that do not belong to any list. Select one or more issues by clicking on the cards and then click **Add issues** -- cgit v1.2.1 From 07b9f48fb3b4eaf7c3c5ca83109fa758a7c23b13 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Wed, 28 Jun 2017 20:51:59 -0300 Subject: remove multiple IB part --- doc/user/project/issue_board.md | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 89819189864..ebd7b72d404 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -22,10 +22,6 @@ With the Issue Board you can have a different view of your issues while also maintaining the same filtering and sorting abilities you see across the issue tracker. -With [Multiple Issue Boards](#multiple-issue-boards), available only in [GitLab -Enterprise Edition](https://about.gitlab.com/gitlab-ee/), your workflow gets -empowered with the ability to create multiple boards per project. - ## Use-cases GitLab Workflow allows you to discuss proposals in issues, categorize them @@ -44,15 +40,6 @@ beginning of the dev lifecycle until deployed to production - Prioritize the issues in a list by moving them vertically - Move issues between lists to organize them according to the labels you've set -To enhance the workflow exemplified above, with [Multiple Issue Boards](#multiple-issue-boards), -available only in [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/), -each team (frontend and backend) can have their own boards to organize their flow among the -members of their teams. For that, we could have, therefore, three Issue Boards for this case: - - - **Backend**, for the backend team and their own labels and workflow - - **Frontend**, same as above, for the frontend team - - **Deployment**, for the entire process (backend > frontend > staging > production) - For a broader use-case, please check the blog post [GitLab Workflow, an Overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/#gitlab-workflow-use-case-scenario). -- cgit v1.2.1 From 4a5eef99018579ba0b306ab52c72a3583297c769 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Wed, 28 Jun 2017 20:56:48 -0300 Subject: copyedit --- doc/user/project/issue_board.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index ebd7b72d404..7b2755a049a 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -25,7 +25,7 @@ issue tracker. ## Use-cases GitLab Workflow allows you to discuss proposals in issues, categorize them -with labels, and and from there organize and prioritize them in Issue Boards. +with labels, and and from there organize and prioritize them with Issue Boards. - For example, let's consider this simplified development workflow: you have a repository hosting your app's codebase -- cgit v1.2.1 From 025aca03d23b3f6c6aca65b2c923adc022d6e942 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Wed, 28 Jun 2017 21:58:17 -0300 Subject: explain that use-cases are just examples --- doc/user/project/issue_board.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 7b2755a049a..6ae9fd57ad4 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -24,6 +24,9 @@ issue tracker. ## Use-cases +There are numerous use-cases for the use of Issue Boards, we will just +exemplify with a couple situations, but the possibilities go where our creativity goes. + GitLab Workflow allows you to discuss proposals in issues, categorize them with labels, and and from there organize and prioritize them with Issue Boards. -- cgit v1.2.1 From 93bf4263b99b9c6ccb1d3a75b052f16939ed91db Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Thu, 29 Jun 2017 11:16:03 -0300 Subject: Axil's review --- doc/user/project/issue_board.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 6ae9fd57ad4..439b9a9fcc6 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -24,11 +24,11 @@ issue tracker. ## Use-cases -There are numerous use-cases for the use of Issue Boards, we will just -exemplify with a couple situations, but the possibilities go where our creativity goes. +There are numerous use-cases for Issue Boards, we will just +exemplify with a couple situations. GitLab Workflow allows you to discuss proposals in issues, categorize them -with labels, and and from there organize and prioritize them with Issue Boards. +with labels, and from there organize and prioritize them with Issue Boards. - For example, let's consider this simplified development workflow: you have a repository hosting your app's codebase -- cgit v1.2.1 From ed503c988a44244603c3a4f3251e401b095e468c Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Thu, 29 Jun 2017 14:22:19 -0300 Subject: fix spelling --- doc/user/project/issue_board.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 439b9a9fcc6..74e10dfb07c 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -22,9 +22,9 @@ With the Issue Board you can have a different view of your issues while also maintaining the same filtering and sorting abilities you see across the issue tracker. -## Use-cases +## Use cases -There are numerous use-cases for Issue Boards, we will just +There are numerous use cases for Issue Boards, we will just exemplify with a couple situations. GitLab Workflow allows you to discuss proposals in issues, categorize them -- cgit v1.2.1 From 326c1b5afa549a550fec5d177743892cc514bbf9 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 3 Jul 2017 14:26:56 -0300 Subject: copyedit == ee !2296 --- doc/user/project/issue_board.md | 72 ++++++++++++++++++++++++++++------------- 1 file changed, 49 insertions(+), 23 deletions(-) (limited to 'doc') diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 74e10dfb07c..e2cc67726e0 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -1,8 +1,7 @@ # Issue Board ->**Notes:** -- [Introduced][ce-5554] in GitLab 8.11. -- The Backlog column was replaced by the **Add issues** button in GitLab 8.17. +>**Note:** +[Introduced][ce-5554] in [GitLab 8.11](https://about.gitlab.com/2016/08/22/gitlab-8-11-released/#issue-board). The GitLab Issue Board is a software project management tool used to plan, organize, and visualize a workflow for a feature or product release. @@ -15,36 +14,63 @@ Other interesting links: ## Overview -The Issue Board builds on GitLab's existing issue tracking functionality and +The Issue Board builds on GitLab's existing +[issue tracking functionality](issues/index.md#issue-tracker) and leverages the power of [labels] by utilizing them as lists of the scrum board. -With the Issue Board you can have a different view of your issues while also +With the Issue Board you can have a different view of your issues while maintaining the same filtering and sorting abilities you see across the -issue tracker. +issue tracker. An Issue Board is based on its project's label structure, therefore, it +applies the same descriptive labels to indicate placement on the board, keeping +consistency throughout the entire development lifecycle. -## Use cases +An Issue Board shows you what issues your team is working on, who is assigned to each, +and where in the workflow those issues are. + +You create issues, host code, perform reviews, build, test, +and deploy from one single platform. Issue Boards help you to visualize +and manage the entire process _in_ GitLab. -There are numerous use cases for Issue Boards, we will just -exemplify with a couple situations. +With [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards), available +only in [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee/), +you go even further, as you can not only keep yourself and your project +organized from a broader perspective with one Issue Board per project, +but also allow your team members to organize their own workflow by creating +multiple Issue Boards within the same project. + +## Use cases GitLab Workflow allows you to discuss proposals in issues, categorize them with labels, and from there organize and prioritize them with Issue Boards. -- For example, let's consider this simplified development workflow: -you have a repository hosting your app's codebase -and your team actively contributing to code. Your backend team starts working a new -implementation, gathers feedback and approval, and pass it to frontend. -From there, when frontend is complete, the new feature -is deployed to staging to be tested. When successful, it goes to production. If we have -the labels "backend", "frontend", "staging", and "production", and an Issue Board with -a list for each, we can: - - Visualize the entire flow of implementations since the -beginning of the dev lifecycle until deployed to production - - Prioritize the issues in a list by moving them vertically - - Move issues between lists to organize them according to the labels you've set - -For a broader use-case, please check the blog post +For example, let's consider this simplified development workflow: + +1. You have a repository hosting your app's codebase +and your team actively contributing to code +1. Your **backend** team starts working a new +implementation, gathers feedback and approval, and pass it over to **frontend** +1. When frontend is complete, the new feature is deployed to **staging** to be tested +1. When successful, it is deployed to **production** + +If we have the labels "**backend**", "**frontend**", "**staging**", and +"**production**", and an Issue Board with a list for each, we can: + +- Visualize the entire flow of implementations since the +beginning of the development lifecycle until deployed to production +- Prioritize the issues in a list by moving them vertically +- Move issues between lists to organize them according to the labels you've set +- Add multiple issues to lists in the board by selecting one or more existing issues + +![issue card moving](img/issue_board_move_issue_card_list.png) + +> **Notes:** +> +>- For a broader use case, please check the blog post [GitLab Workflow, an Overview](https://about.gitlab.com/2016/10/25/gitlab-workflow-an-overview/#gitlab-workflow-use-case-scenario). +> +>- For a real use case, please check why +[Codepen decided to adopt Issue Boards](https://about.gitlab.com/2017/01/27/codepen-welcome-to-gitlab/#project-management-everything-in-one-place) +to improve their workflow with [multiple boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards). ## Issue Board terminology -- cgit v1.2.1 From f75ee481cf27bbdf74b0274b5d1d042138c6036e Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 3 Jul 2017 14:27:16 -0300 Subject: add image - issue boards - moving card --- .../project/img/issue_board_move_issue_card_list.png | Bin 0 -> 74826 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/user/project/img/issue_board_move_issue_card_list.png (limited to 'doc') diff --git a/doc/user/project/img/issue_board_move_issue_card_list.png b/doc/user/project/img/issue_board_move_issue_card_list.png new file mode 100644 index 00000000000..c6b17ada40e Binary files /dev/null and b/doc/user/project/img/issue_board_move_issue_card_list.png differ -- cgit v1.2.1