diff options
feat(tutorials/how-to-use-jira): Converted to dunbar
1 files changed, 158 insertions, 0 deletions
| -rw-r--r-- | src/tutorials/how-to-use-jira/projects.du | 158 |
diff --git a/src/tutorials/how-to-use-jira/projects.du b/src/tutorials/how-to-use-jira/projects.du new file mode 100644 index 0000000..277e108 --- /dev/null +++ b/src/tutorials/how-to-use-jira/projects.du @@ -0,0 +1,158 @@ +# Projects - How to use Jira + +'define expected-reading 4 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./cards.html Cards] +'define next_link [url ./kanban.html Kanban template] +[$pagination_middle] + +:contents +:numbered +1. [url #creating-a-project Creating a project] +2. [url #boards Boards] + .numbered + 1. [url #columns Columns] + 2. [url #adding-more-boards-to-a-project Adding more boards to a project] + +3. [url #backlog Backlog] +4. [url #add-item Add item] + + + +In short, =[projects are a collection of issues]= with added functionality for =[organising them, getting statistics, etc]=. + +[image ./img/projects.png] + +## Creating a project + +To create a project, either =[click on `[Create project]` from the menu `[Projects]` in the top bar]=, + +[image ./img/create-project-top.png] + +or =[click on the `[Create project]` button in the `[View all projects]` page]=. + +[image ./img/view-all-projects-top.png] + +[image ./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]=. + +[image ./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]=. + +[image ./img/create-project-new.png] + +This tutorial covers =[only]= the three classic software templates: =[[url ./kanban.html Kanban]]=, =[[url ./scrum.html Scrum]]= and =[[url ./bug.html Bug tracking]]=. + +[image ./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 [url ./releases.html Releases], [url ./pages.html Pages] and [url ./components.html Components], that are also explored. + +## Boards + +Each project contains, amongst many other things, boards. =[Boards are a way to better organise results from [url ./filters.html filters]]=. 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. + +[image ./img/SOD.png] + +To illustrate how this could be useful, let's say we have three columns: `[TO DO]`, `[DOING]` and `[DONE]`. + +[image ./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, quantity and purpose of different columns =[depend on the project's organisation]=. + +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). + +[image ./img/board-settings.png] + +[image ./img/columns-edit.png] + +### Adding more boards to a project + +You can also add to a project as many =[[url ./scrum.html Scrum]]= and =[[url ./kanban.html Kanban]]= templated boards as you want. + +This can be done, either while in a board, from =[clicking the three dots and choosing `[Create board]`]= + +[image ./img/create-board.png] + +or =[in the sidebar, from the `[Board]` menu]=. + +[image ./img/sidebar-create-board.png] + +After that, you are met with the `[Create a board]` window, where you can choose your template. + +[image ./img/scrum-kanban-board.png] + +Once you've made your choice, you will be met with three options: + +[image ./img/board-from.png] + +:bulleted +- =[Board created with new Software project]= - creates a new project with a new board (has the name of the project). + + .p [image ./img/npb.png] + +- =[Board from existing project]= - creates a board that gets the filter from another project + + .p [image ./img/ntb.png] + +- =[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 + + .p [image ./img/ntb-filter.png] + + +## Backlog + +=[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 ([url ./scrum.html Scrum])]=, + +[image ./img/scrum-backlog.png] + +=[just a column in a board ([url ./kanban.html Kanban])]=, + +[image ./img/backlog-kanban.png] + +or =[nonexistent ([url ./bug.md bug tracking])]=. + +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. + +[image ./img/add-item-kanban.png] + +From here you can =[add a website shortcut]=, simply by putting the web address and giving it a name. + +[image ./img/add-item-to-project.png] + +[image ./img/add-shortcut.png] + +The name is used for showing the shortcut on the sidebar. + +[image ./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]=. + +[image ./img/test-repo.png] + +[image ./img/test-repo-sidebar.png] + +=[Integration won't be covered in this tutorial]=, but I can recommend [url https://www.idalko.com/jira-github-integration/ this] article for `[GitHub]` integration and [url https://www.idalko.com/jira-bitbucket-integration/ this] one for `[Bitbucket]` integration. + +From the `[Add Item]` menu you can also =[toggle the shortcut to [url ./pages.html Pages]]=. |