From 61474f4c16a09928ccb009973756fc0608ed3107 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sat, 12 Sep 2020 19:59:16 +0300 Subject: Improved wording and format of projects page in how to use jira tutorial --- src/tutorials/how-to-use-jira/projects.md | 113 +++++++++++++++--------------- 1 file changed, 57 insertions(+), 56 deletions(-) (limited to 'src/tutorials') diff --git a/src/tutorials/how-to-use-jira/projects.md b/src/tutorials/how-to-use-jira/projects.md index ff430bc..715b10a 100644 --- a/src/tutorials/how-to-use-jira/projects.md +++ b/src/tutorials/how-to-use-jira/projects.md @@ -1,6 +1,6 @@ # How to use Jira - Projects -**Article Created: 23 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 23 July 2020** || **Last Edited: 12 September 2020** [`<<`](./introduction.html) || [`< Cards`](./cards.html) || [`Kanban template >`](./kanban.html) @@ -8,29 +8,57 @@ ![](./img/projects.png) -In short, **projects are a collection of issues with added functionality** for organising them, getting statistics, etc. +In short, **projects are a collection of issues** with added functionality for **organising them, getting statistics, etc**. -## Boards +## Creating a project -**Boards are a way to better organise results from [filters](./filters.html)**. By default every project gets a board with a filter for all of the project's issues. +To create a project, either **click on `Create project` from the menu `Projects` in the top bar**, -A board gets all of the issues from it's given filter and offers a way to organise them. +![](./img/create-project-top.png) -### Columns +or **click on the `Create project` button in the `View all projects` page**. -![](./img/SOD.png) +![](./img/view-all-projects-top.png) + +![](./img/create-project.png) + +**Note**: when you **have created your account** the first thing you'll see is the `Create project` page. + +You'll be met by the `Choose project type` screen. From here choose `Classic project`, in this tutorial the `Next-gen project` types **won't be covered**. + +![](./img/choose-project-type.png) + +After that you'll need to put a **name** for your project, set a **key** (used as an ID for issues ; it is automatically generated, but you can change it if you want) and select a **template**. + +![](./img/create-project-new.png) + +This tutorial covers **only** the three classic software templates: [**Kanban**](./kanban.html), [**Scrum**](./scrum.html) and [**Bug tracking**](./bug.html). + +![](./img/choose-classic-template.png) + +In a nutshell, **templates** govern how **boards and issues should work together**. Later in the tutorial we cover the differences between these templates. + +Projects also have [Releases](./releases.html), [Pages](./pages.html) and [Components](./components.html), that are also explored. + +## Boards + +Each project contains, amongst many other things, boards. **Boards are a way to better organise results from [filters](./filters.html)**. By default every project gets a board with a filter for all of the project's issues. + +### Columns **Boards are divided into columns** that contain the cards (issues). A card can move **freely** from one column to another. -To illustrate why this is useful, let's say we have three columns: `TO DO`, `DOING` and `DONE`. +![](./img/SOD.png) + +To illustrate how this could be useful, let's say we have three columns: `TO DO`, `DOING` and `DONE`. ![](./img/todo-doing-done.png) When you create an issue you initially put it in the `TO DO` column. After someone has started working on it, they put the issue in the `DOING` column. Finally, when the issue is resolved, it is put in the `DONE` column. -Of course, the name, the quantity and the usage of different columns **depend on the project**. +Of course, the name, quantity and purpose of different columns **depend on the project's organisation**. -Adding and/or removing columns can be done from the `Columns` tab in the `Board settings` menu (three dots on the top right of a board). +Adding and removing columns can be done from the `Columns` tab in the `Board settings` menu (three dots on the top right of a board). ![](./img/board-settings.png) @@ -38,11 +66,9 @@ Adding and/or removing columns can be done from the `Columns` tab in the `Board ### Adding more boards to a project -You can also add more boards, though **you should first read the [Scrum template](./scrum.html) and the [Kanban template](./kanban.html) articles**. - -In short, these **templates govern how a board should work**. Also read the `Creating a project` section down below. +You can also add to a project as many [**Scrum**](./scrum.html) and [**Kanban**](./kanban.html) templated boards as you want. -You can do that either in a board, from **clicking the three dots and choosing `Create board`** +This can be done, either while in a board, from **clicking the three dots and choosing `Create board`** ![](./img/create-board.png) @@ -50,15 +76,15 @@ or **in the sidebar, from the `Board` menu**. ![](./img/sidebar-create-board.png) -After that, you are met with the option of creating a **Scrum** or a **Kanban** board (**that's why you should read the template articles** before adding boards). +After that, you are met with the `Create a board` window, where you can choose your template. ![](./img/scrum-kanban-board.png) -When you've made a choice, you will be met with three options: +Once you've made your choice, you will be met with three options: ![](./img/board-from.png) -- **Board created with new Software project** - creates a new project (from the given name in the next menu) with a new board (has the name of the project). +- **Board created with new Software project** - creates a new project with a new board (has the name of the project). ![](./img/npb.png) @@ -66,7 +92,7 @@ When you've made a choice, you will be met with three options: ![](./img/ntb.png) -- **Board from an existing Saved Filter** - as it says, you add to the location project a board based on a filter +- **Board from an existing Saved Filter** - as it says, you add to the project (indicated in the `Location` field) a board based on a saved filter ![](./img/ntb-filter.png) @@ -74,66 +100,41 @@ When you've made a choice, you will be met with three options: **The backlog is a place for issues that outline a general task/feature**. -Depending on your project template, the backlog will **either be a separate window ([Scrum](./scrum.html))** +Depending on your project template, the backlog will either be a **separate window ([Scrum](./scrum.html))**, ![](./img/scrum-backlog.png) -or **just a column in a board ([Kanban](./kanban.html))**. +**just a column in a board ([Kanban](./kanban.html))**, -![](./img/backlog-kanban) +![](./img/backlog-kanban.png) -Using a backlog is **explained in more detail in the different template pages**. +or **nonexistent ([bug tracking](./bug.md))**. + +The purpose of the backlog depends on the template and it is described in the page of each template. ## Add item -**You can also add some resources to the sidebar of your project for everyone to use**. That is done through the `Add Item` menu. +**You can also add some resources to the sidebar of your project** for everyone to use. That is done through the `Add Item` menu. ![](./img/add-item-kanban.png) -From here you can **add shortcuts to any website**. Put the web address, give it a name and you are done +From here you can **add a website shortcut**, simply by putting the web address and giving it a name. ![](./img/add-item-to-project.png) ![](./img/add-shortcut.png) +The name is used for showing the shortcut on the sidebar. + ![](./img/added-site.png) -You can also add a `Bitbucket` or `GitHub` repository which you **can leave only as a shortcut**, or you **can integrate it so that issues are transferred to Jira**. +You can also add a `Bitbucket` or `GitHub` repository which you can **leave** only as a **shortcut**, or you can **integrate** it so that **issues are transferred to Jira**. ![](./img/test-repo.png) ![](./img/test-repo-sidebar.png) -**Integration won't be covered in this tutorial**, but I can recommend [this](https://www.idalko.com/jira-github-integration/) article for `GitHub` integration, and [this](https://www.idalko.com/jira-bitbucket-integration/) one for `Bitbucket` integration, both of which are made by [idalko](https://www.idalko.com/). - -From the 'Add Item' menu you **can also toggle [Pages](./pages.html)**. - -## Creating a project - -To create a project, either **click on `Create project` from the menu `Projects` in the top bar**, - -![](./img/create-project-top.png) - -or **click on the `Create project` button in the `View all projects` page**. - -![](./img/view-all-projects-top.png) - -![](./img/create-project.png) - -**Note**: when you **have created your account** the first thing you'll see is the `Create project` page. - -You'll be met by the `Choose project type` screen. From here choose `Classic project`, in this tutorial the `Next-gen project` **won't be covered**. - -![](./img/choose-project-type.png) - -After that you'll need to **put a name for your project**, **a key** (used for issues) and **a template**. - -![](./img/create-project-new.png) - -In this tutorial we will **cover only the three classic software templates: [Kanban](./kanban.html), [Scrum](./scrum.html) and [Bug tracking](./bug.html)**. - -![](./img/choose-classic-template.png) +**Integration won't be covered in this tutorial**, but I can recommend [this](https://www.idalko.com/jira-github-integration/) article for `GitHub` integration and [this](https://www.idalko.com/jira-bitbucket-integration/) one for `Bitbucket` integration. -In short, **templates govern how boards and issues should work together**. Read the respective pages for more information. +From the `Add Item` menu you can also **toggle the shortcut to [Pages](./pages.html)**. -**Projects also have [Releases](./releases.html), [Pages](./pages.html) and [Components](./components.html) that are covered in their respective pages in this tutorial**. -- cgit v1.3.1-23-gd82d