diff options
Added a tutorial for using Jira
98 files changed, 578 insertions, 0 deletions
diff --git a/src/tutorials/how-to-use-jira/.kanban.md.swp b/src/tutorials/how-to-use-jira/.kanban.md.swp Binary files differnew file mode 100644 index 0000000..dddebc6 --- /dev/null +++ b/src/tutorials/how-to-use-jira/.kanban.md.swp diff --git a/src/tutorials/how-to-use-jira/bug.md b/src/tutorials/how-to-use-jira/bug.md new file mode 100644 index 0000000..79c9d87 --- /dev/null +++ b/src/tutorials/how-to-use-jira/bug.md @@ -0,0 +1,17 @@ +# How to use Jira - Bug tracking template + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Scrum template](./scrum.html) || [Releases >](./releases.html) + +--- + +The Bug Tracking template is completely different from the [Scrum template](./scrum.html) or the [Kanban template](./kanban.html), because **it only offers issues**. + +**There are no boards, no cards, no backlog**. All issues are accessed from the 'Issues' page from the sidebar. + + + +That's why this template is **available only when creating a project**. + +Of course, **you can add any board at any time**, but this project template doesn't add any by itself. diff --git a/src/tutorials/how-to-use-jira/cards.md b/src/tutorials/how-to-use-jira/cards.md new file mode 100644 index 0000000..c6cff32 --- /dev/null +++ b/src/tutorials/how-to-use-jira/cards.md @@ -0,0 +1,134 @@ +# How to use Jira - Cards + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Filters](./filters.html) || [Projects >](./projects.html) + +--- + +**Each issue is represented as a 'card' with a couple of different properties**. + +## Properties + + + +Each card has the following properties: + + + +- **Project** - the [project](./projects.html) this card is stored in (defaults to currently open one) + +  + +- **Issue type** - the basic purpose of an issue (Improvement, Bug, ...) + +  + + -  - functionality or feature expressed as a user goal, something like "As a user, I want to be able to pay for my order via PayPal" + + -  - a problem/error + + -  - a collection of issues, issues are linked through 'Epic link' (see below) + + -  - a small piece of work + + -  - an issue that is directly connected to another issue. This is used for when a given issue needs to be broken down into separate even smaller issues. + +- **Summary** - a required brief explanation of the issue + +  + +- **Description** - detailed explanation of the issue + +  + +- **Reporter** - person who created the issue + +  + +- **Assignee** - person who works on the issue + +  + +- **Labels** - tags with which you can organise even more different issues + +  + +- **Epic link** - link of issue with type Epic + +  + +## Creating + +To create a card yourself, you need to **press the `Create` button on the top bar**. + + + +## Viewing + +**All** cards (issues) can be viewed from a [project](./projects.html)'s side menu, under 'Issues'. + + + +Of course, they can also be viewed through **[filters](./filters.html)** and a **[project](./projects.html)'s board**. + +## How to use + +By default, opening a card presents, at the top, it's **key** (think of it as an ID), + + + +it's **summary**, + + + +options for adding **attachments**, **subtasks**, **linking issues** and **adding more apps** (think of apps like extensions), + + + +following are the **description**, **actual attachments**, **subtasks**, **linked issues**, ..., + + + +and at the bottom you have the **activity**, consisting of **comments**, + + + +**history**, + + + +and **work logs** (a bit later we talk about them in more detail). + + + +To the right side, you have all of the different **properties** (some fields that have no value will be hidden). + + + +On the top right you can change **watch options** ([watching an issue](https://www.idalko.com/jira-watch-issues/) means you get notified by all changes done to it), you can **share** the card and do **actions** (the three dots). + + + +**Actions** are things you can do to the whole card, like moving or deleting it. + + + +The most notable options are [`Log work`](https://confluence.atlassian.com/jirasoftwarecloud/logging-work-on-issues-902499028.html) and `Add flag`. + +In Jira, you can **estimate how long an issue will take** for it to be resolved. This is done through **logging work**. + +In the `Log work` screen, you'll be met with a `Time spent` and `Time remaining` fields, that you'll need to fill with the appropriate information. + + + +The time remaining takes a **default** value from the **previous time log**, so you don't need to specify it every time. + +A **flagged issue** is an issue that is very important. Flagged issues are displayed in yellow to signify their needed attention. + + + +On the bottom right you can see **when the issue was created** and **when it was last updated**. You can also access the field configuration menu from the `Configure` button. It won't be covered in this tutorial, you can read about it [here](https://confluence.atlassian.com/adminjiracloud/changing-a-field-configuration-844500798.html). + + + diff --git a/src/tutorials/how-to-use-jira/components.md b/src/tutorials/how-to-use-jira/components.md new file mode 100644 index 0000000..6cc7a74 --- /dev/null +++ b/src/tutorials/how-to-use-jira/components.md @@ -0,0 +1,42 @@ +# How to use Jira - Components + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Pages](./pages.html) || [Dashboards >](./dashboards.html) + +--- + +**Components are yet another way to group issues together**. They don't have any specific meaning like versions, their usage depends on the project. + +## Creating and editing + +Creating and editing components is done from the **`Components` menu in the sidebar**. + + + +Creating one is done through the button on the top left (in the center if you don't have any components) by the name of `Create component`. + + + + + +Clicking on it presents you with a screen where you type the block's information. + + + +**A name is the only requirement**. You can also add a **description**, **a lead(er) for the component** and **person who gets assigned to an issue by default in this component**. + +## Adding issues + +Adding an issue to a component can be done either **when creating an issue** or **when viewing it**. + +**Right under the summary**, there is a place for indicating a component, named `Components`. + + + +When viewing an issue, you can add a component from the fields to the right, in the `Components` field (you might need to first click on `Show more fields`). + + + + + diff --git a/src/tutorials/how-to-use-jira/dashboards.md b/src/tutorials/how-to-use-jira/dashboards.md new file mode 100644 index 0000000..622ef67 --- /dev/null +++ b/src/tutorials/how-to-use-jira/dashboards.md @@ -0,0 +1,58 @@ +# How to use Jira - Dashboards + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Components](./components.html) + +--- + +**Dashboards are a place where you can view a lot of information**. + + + +**Dashboards are composed of gadgets**. + + + +Gadgets have functionality for **displaying certain information**, like, 'Average Age Chart', or 'Issues in progress'. Each gadget can be setup to **take information from one or more projects and/or saved filters**. + +## Adding a dashboard + +Dashboard can be added from the top bar, from `Create dashboard` in `Dashboards` menu, + + + +or, if you are already in a dashboard, from `Create dashboard` in the three dots menu. + + + +## Adding gadgets + +**Note**: you cannot add gadgets to the default dashboard. + +You can add gadgets either **through the `Add gadget` button in the top right**, + + + +or, **if you don't have any gadets**, **from the `add a new gadget` message(s)**. + + + +After that, you are greeted by a window that **shows all avalable gadgets** (you might need to **press `Load all gadgets` after waiting** a bit). + + + + + +Adding a gadget is as simple as clicking the button `Add gadget` next to the name of the gadget you want to add. + + + +After it is added, you'll **need to configure it**, usually a gadget **requires a filter/project**. Other settings are different gadget to gadget. + + + +Options for different gadgets can be found on **their top right corner, in the three dots menu**. + + + diff --git a/src/tutorials/how-to-use-jira/filters.md b/src/tutorials/how-to-use-jira/filters.md new file mode 100644 index 0000000..9fe0ac5 --- /dev/null +++ b/src/tutorials/how-to-use-jira/filters.md @@ -0,0 +1,33 @@ +# How to use Jira - Filters + +**Article Created: 23 July 2020** || **Last Edited: 24 July 2020** + +[\< Introduction](./introduction.html) || [Cards >](./cards.html) + +--- + +**Filters work like a category search that you can save**. With filters you choose which project(s) to take issues from, what status must the issues have, etc. + +Making filters is done through the `Advanced issue search` page, from the `Filters` menu. + + + +From here you can see some criteria: `Project`, `Type`, `Status`, `Assignee`. + + + +You can choose different options and limit what issues are shown. There are also other criteria that you can access from the `+ More` menu. + + + +You can do even **more advanced search** through `JQL` (Jira Query Language), but we won't be covering this topic. I can recommend [this article](https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14) on the subject. + +After creating your desired search results, you can **save the query** (filter) and use it later. To do so, simply click on `Save as` and enter a name for your desired filter. + + + + +You can view all of your filters from the conveniently named 'View all filters' option in the 'Filters' menu. + + + diff --git a/src/tutorials/how-to-use-jira/img/SOD.png b/src/tutorials/how-to-use-jira/img/SOD.png Binary files differnew file mode 100644 index 0000000..0f6ee3c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/SOD.png diff --git a/src/tutorials/how-to-use-jira/img/active-sprints.png b/src/tutorials/how-to-use-jira/img/active-sprints.png Binary files differnew file mode 100644 index 0000000..90e8711 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/active-sprints.png diff --git a/src/tutorials/how-to-use-jira/img/activiry-comments.png b/src/tutorials/how-to-use-jira/img/activiry-comments.png Binary files differnew file mode 100644 index 0000000..59bc420 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/activiry-comments.png diff --git a/src/tutorials/how-to-use-jira/img/activity-history.png b/src/tutorials/how-to-use-jira/img/activity-history.png Binary files differnew file mode 100644 index 0000000..5f5f7fc --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/activity-history.png diff --git a/src/tutorials/how-to-use-jira/img/activity-work-log.png b/src/tutorials/how-to-use-jira/img/activity-work-log.png Binary files differnew file mode 100644 index 0000000..4340e6e --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/activity-work-log.png diff --git a/src/tutorials/how-to-use-jira/img/add-a-gadget.png b/src/tutorials/how-to-use-jira/img/add-a-gadget.png Binary files differnew file mode 100644 index 0000000..21de4ec --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-a-gadget.png diff --git a/src/tutorials/how-to-use-jira/img/add-gadet-top.png b/src/tutorials/how-to-use-jira/img/add-gadet-top.png Binary files differnew file mode 100644 index 0000000..5fdd5c2 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-gadet-top.png diff --git a/src/tutorials/how-to-use-jira/img/add-gadget.png b/src/tutorials/how-to-use-jira/img/add-gadget.png Binary files differnew file mode 100644 index 0000000..365b62a --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-gadget.png diff --git a/src/tutorials/how-to-use-jira/img/add-item-kanban.png b/src/tutorials/how-to-use-jira/img/add-item-kanban.png Binary files differnew file mode 100644 index 0000000..ebb667c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-item-kanban.png diff --git a/src/tutorials/how-to-use-jira/img/add-item-to-project.png b/src/tutorials/how-to-use-jira/img/add-item-to-project.png Binary files differnew file mode 100644 index 0000000..fda2714 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-item-to-project.png diff --git a/src/tutorials/how-to-use-jira/img/add-shortcut.png b/src/tutorials/how-to-use-jira/img/add-shortcut.png Binary files differnew file mode 100644 index 0000000..1e401c8 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/add-shortcut.png diff --git a/src/tutorials/how-to-use-jira/img/added-site.png b/src/tutorials/how-to-use-jira/img/added-site.png Binary files differnew file mode 100644 index 0000000..48fea3d --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/added-site.png diff --git a/src/tutorials/how-to-use-jira/img/assignee-create-card.png b/src/tutorials/how-to-use-jira/img/assignee-create-card.png Binary files differnew file mode 100644 index 0000000..fe17cf2 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/assignee-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/backlog-kanban.png b/src/tutorials/how-to-use-jira/img/backlog-kanban.png Binary files differnew file mode 100644 index 0000000..cc2b3b5 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/backlog-kanban.png diff --git a/src/tutorials/how-to-use-jira/img/board-from.png b/src/tutorials/how-to-use-jira/img/board-from.png Binary files differnew file mode 100644 index 0000000..c918953 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/board-from.png diff --git a/src/tutorials/how-to-use-jira/img/board-settings.png b/src/tutorials/how-to-use-jira/img/board-settings.png Binary files differnew file mode 100644 index 0000000..0e516b6 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/board-settings.png diff --git a/src/tutorials/how-to-use-jira/img/bubble-dots.png b/src/tutorials/how-to-use-jira/img/bubble-dots.png Binary files differnew file mode 100644 index 0000000..ead1ad5 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/bubble-dots.png diff --git a/src/tutorials/how-to-use-jira/img/bubble.png b/src/tutorials/how-to-use-jira/img/bubble.png Binary files differnew file mode 100644 index 0000000..4e4d671 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/bubble.png diff --git a/src/tutorials/how-to-use-jira/img/bug-type.png b/src/tutorials/how-to-use-jira/img/bug-type.png Binary files differnew file mode 100644 index 0000000..8a60adc --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/bug-type.png diff --git a/src/tutorials/how-to-use-jira/img/card-actions.png b/src/tutorials/how-to-use-jira/img/card-actions.png Binary files differnew file mode 100644 index 0000000..6d418f3 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-actions.png diff --git a/src/tutorials/how-to-use-jira/img/card-attach-subtask.png b/src/tutorials/how-to-use-jira/img/card-attach-subtask.png Binary files differnew file mode 100644 index 0000000..732b643 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-attach-subtask.png diff --git a/src/tutorials/how-to-use-jira/img/card-key.png b/src/tutorials/how-to-use-jira/img/card-key.png Binary files differnew file mode 100644 index 0000000..2159950 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-key.png diff --git a/src/tutorials/how-to-use-jira/img/card-right-side.png b/src/tutorials/how-to-use-jira/img/card-right-side.png Binary files differnew file mode 100644 index 0000000..589a995 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-right-side.png diff --git a/src/tutorials/how-to-use-jira/img/card-summary.png b/src/tutorials/how-to-use-jira/img/card-summary.png Binary files differnew file mode 100644 index 0000000..1a37887 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-summary.png diff --git a/src/tutorials/how-to-use-jira/img/card-top-right.png b/src/tutorials/how-to-use-jira/img/card-top-right.png Binary files differnew file mode 100644 index 0000000..bb04eb7 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/card-top-right.png diff --git a/src/tutorials/how-to-use-jira/img/choose-classic-template.png b/src/tutorials/how-to-use-jira/img/choose-classic-template.png Binary files differnew file mode 100644 index 0000000..bdefb2c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/choose-classic-template.png diff --git a/src/tutorials/how-to-use-jira/img/choose-project-type.png b/src/tutorials/how-to-use-jira/img/choose-project-type.png Binary files differnew file mode 100644 index 0000000..d85ff3a --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/choose-project-type.png diff --git a/src/tutorials/how-to-use-jira/img/columns-edit.png b/src/tutorials/how-to-use-jira/img/columns-edit.png Binary files differnew file mode 100644 index 0000000..5aeb62c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/columns-edit.png diff --git a/src/tutorials/how-to-use-jira/img/components-create-card.png b/src/tutorials/how-to-use-jira/img/components-create-card.png Binary files differnew file mode 100644 index 0000000..cc6aefb --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/components-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/components-field.png b/src/tutorials/how-to-use-jira/img/components-field.png Binary files differnew file mode 100644 index 0000000..e60c0c2 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/components-field.png diff --git a/src/tutorials/how-to-use-jira/img/components-sidebar.png b/src/tutorials/how-to-use-jira/img/components-sidebar.png Binary files differnew file mode 100644 index 0000000..49f2912 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/components-sidebar.png diff --git a/src/tutorials/how-to-use-jira/img/create-board.png b/src/tutorials/how-to-use-jira/img/create-board.png Binary files differnew file mode 100644 index 0000000..bb09056 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-board.png diff --git a/src/tutorials/how-to-use-jira/img/create-component-empty.png b/src/tutorials/how-to-use-jira/img/create-component-empty.png Binary files differnew file mode 100644 index 0000000..90ba465 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-component-empty.png diff --git a/src/tutorials/how-to-use-jira/img/create-component-full.png b/src/tutorials/how-to-use-jira/img/create-component-full.png Binary files differnew file mode 100644 index 0000000..6f74c42 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-component-full.png diff --git a/src/tutorials/how-to-use-jira/img/create-component-page.png b/src/tutorials/how-to-use-jira/img/create-component-page.png Binary files differnew file mode 100644 index 0000000..b7542e0 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-component-page.png diff --git a/src/tutorials/how-to-use-jira/img/create-dashboard-dots.png b/src/tutorials/how-to-use-jira/img/create-dashboard-dots.png Binary files differnew file mode 100644 index 0000000..a2bd4fc --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-dashboard-dots.png diff --git a/src/tutorials/how-to-use-jira/img/create-dashboard-top.png b/src/tutorials/how-to-use-jira/img/create-dashboard-top.png Binary files differnew file mode 100644 index 0000000..867c4a9 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-dashboard-top.png diff --git a/src/tutorials/how-to-use-jira/img/create-header.png b/src/tutorials/how-to-use-jira/img/create-header.png Binary files differnew file mode 100644 index 0000000..6bb3b63 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-header.png diff --git a/src/tutorials/how-to-use-jira/img/create-project-new.png b/src/tutorials/how-to-use-jira/img/create-project-new.png Binary files differnew file mode 100644 index 0000000..f319105 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-project-new.png diff --git a/src/tutorials/how-to-use-jira/img/create-project-top.png b/src/tutorials/how-to-use-jira/img/create-project-top.png Binary files differnew file mode 100644 index 0000000..e832e66 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-project-top.png diff --git a/src/tutorials/how-to-use-jira/img/create-project.png b/src/tutorials/how-to-use-jira/img/create-project.png Binary files differnew file mode 100644 index 0000000..d7e7893 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/create-project.png diff --git a/src/tutorials/how-to-use-jira/img/criteria-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/criteria-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..f224446 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/criteria-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/default-dashboard.png b/src/tutorials/how-to-use-jira/img/default-dashboard.png Binary files differnew file mode 100644 index 0000000..e9e4a09 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/default-dashboard.png diff --git a/src/tutorials/how-to-use-jira/img/desc-att-sub-link.png b/src/tutorials/how-to-use-jira/img/desc-att-sub-link.png Binary files differnew file mode 100644 index 0000000..90eb3c6 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/desc-att-sub-link.png diff --git a/src/tutorials/how-to-use-jira/img/description-create-card.png b/src/tutorials/how-to-use-jira/img/description-create-card.png Binary files differnew file mode 100644 index 0000000..f321a6f --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/description-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/epic-link-create-card.png b/src/tutorials/how-to-use-jira/img/epic-link-create-card.png Binary files differnew file mode 100644 index 0000000..9e1e708 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/epic-link-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/epic-type.png b/src/tutorials/how-to-use-jira/img/epic-type.png Binary files differnew file mode 100644 index 0000000..feb24d5 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/epic-type.png diff --git a/src/tutorials/how-to-use-jira/img/fields-cards.png b/src/tutorials/how-to-use-jira/img/fields-cards.png Binary files differnew file mode 100644 index 0000000..fbb63ba --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/fields-cards.png diff --git a/src/tutorials/how-to-use-jira/img/filters-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/filters-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..19c6d30 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/filters-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/fix-versions.png b/src/tutorials/how-to-use-jira/img/fix-versions.png Binary files differnew file mode 100644 index 0000000..a71eb9e --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/fix-versions.png diff --git a/src/tutorials/how-to-use-jira/img/flagged-card.png b/src/tutorials/how-to-use-jira/img/flagged-card.png Binary files differnew file mode 100644 index 0000000..873e6a9 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/flagged-card.png diff --git a/src/tutorials/how-to-use-jira/img/gadgets.png b/src/tutorials/how-to-use-jira/img/gadgets.png Binary files differnew file mode 100644 index 0000000..77b1597 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/gadgets.png diff --git a/src/tutorials/how-to-use-jira/img/introduction-add.png b/src/tutorials/how-to-use-jira/img/introduction-add.png Binary files differnew file mode 100644 index 0000000..f259bde --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/introduction-add.png diff --git a/src/tutorials/how-to-use-jira/img/issue-types.png b/src/tutorials/how-to-use-jira/img/issue-types.png Binary files differnew file mode 100644 index 0000000..ec1ec55 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/issue-types.png diff --git a/src/tutorials/how-to-use-jira/img/issues-sidebar.png b/src/tutorials/how-to-use-jira/img/issues-sidebar.png Binary files differnew file mode 100644 index 0000000..53e21cb --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/issues-sidebar.png diff --git a/src/tutorials/how-to-use-jira/img/kanban-cards.png b/src/tutorials/how-to-use-jira/img/kanban-cards.png Binary files differnew file mode 100644 index 0000000..84c435f --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/kanban-cards.png diff --git a/src/tutorials/how-to-use-jira/img/label-create-card.png b/src/tutorials/how-to-use-jira/img/label-create-card.png Binary files differnew file mode 100644 index 0000000..f99a447 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/label-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/load-all.png b/src/tutorials/how-to-use-jira/img/load-all.png Binary files differnew file mode 100644 index 0000000..cd15350 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/load-all.png diff --git a/src/tutorials/how-to-use-jira/img/npb.png b/src/tutorials/how-to-use-jira/img/npb.png Binary files differnew file mode 100644 index 0000000..8d8c4e0 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/npb.png diff --git a/src/tutorials/how-to-use-jira/img/ntb-filter.png b/src/tutorials/how-to-use-jira/img/ntb-filter.png Binary files differnew file mode 100644 index 0000000..f894855 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/ntb-filter.png diff --git a/src/tutorials/how-to-use-jira/img/ntb.png b/src/tutorials/how-to-use-jira/img/ntb.png Binary files differnew file mode 100644 index 0000000..f69e4f9 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/ntb.png diff --git a/src/tutorials/how-to-use-jira/img/plus-more-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/plus-more-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..64234c3 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/plus-more-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/project-create-card.png b/src/tutorials/how-to-use-jira/img/project-create-card.png Binary files differnew file mode 100644 index 0000000..d0ffe8d --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/project-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/projects.png b/src/tutorials/how-to-use-jira/img/projects.png Binary files differnew file mode 100644 index 0000000..45e47c3 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/projects.png diff --git a/src/tutorials/how-to-use-jira/img/reporter-create-card.png b/src/tutorials/how-to-use-jira/img/reporter-create-card.png Binary files differnew file mode 100644 index 0000000..5d4b397 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/reporter-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/sample-scrum-backlog.png b/src/tutorials/how-to-use-jira/img/sample-scrum-backlog.png Binary files differnew file mode 100644 index 0000000..b32ce33 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/sample-scrum-backlog.png diff --git a/src/tutorials/how-to-use-jira/img/sample-sprint.png b/src/tutorials/how-to-use-jira/img/sample-sprint.png Binary files differnew file mode 100644 index 0000000..21fccff --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/sample-sprint.png diff --git a/src/tutorials/how-to-use-jira/img/save-as-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/save-as-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..b39a173 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/save-as-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/save-filter-filters-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/save-filter-filters-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..0108430 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/save-filter-filters-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/scrum-backlog.png b/src/tutorials/how-to-use-jira/img/scrum-backlog.png Binary files differnew file mode 100644 index 0000000..6ea23f6 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/scrum-backlog.png diff --git a/src/tutorials/how-to-use-jira/img/scrum-kanban-board.png b/src/tutorials/how-to-use-jira/img/scrum-kanban-board.png Binary files differnew file mode 100644 index 0000000..87513b0 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/scrum-kanban-board.png diff --git a/src/tutorials/how-to-use-jira/img/show-fields.png b/src/tutorials/how-to-use-jira/img/show-fields.png Binary files differnew file mode 100644 index 0000000..a274791 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/show-fields.png diff --git a/src/tutorials/how-to-use-jira/img/sidebar-create-board.png b/src/tutorials/how-to-use-jira/img/sidebar-create-board.png Binary files differnew file mode 100644 index 0000000..9e5918d --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/sidebar-create-board.png diff --git a/src/tutorials/how-to-use-jira/img/story-type.png b/src/tutorials/how-to-use-jira/img/story-type.png Binary files differnew file mode 100644 index 0000000..b68f4aa --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/story-type.png diff --git a/src/tutorials/how-to-use-jira/img/sub-task-type.png b/src/tutorials/how-to-use-jira/img/sub-task-type.png Binary files differnew file mode 100644 index 0000000..606bd5c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/sub-task-type.png diff --git a/src/tutorials/how-to-use-jira/img/summary-create-card.png b/src/tutorials/how-to-use-jira/img/summary-create-card.png Binary files differnew file mode 100644 index 0000000..cfdedbc --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/summary-create-card.png diff --git a/src/tutorials/how-to-use-jira/img/task-type.png b/src/tutorials/how-to-use-jira/img/task-type.png Binary files differnew file mode 100644 index 0000000..b7c8b02 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/task-type.png diff --git a/src/tutorials/how-to-use-jira/img/test-page.png b/src/tutorials/how-to-use-jira/img/test-page.png Binary files differnew file mode 100644 index 0000000..0aa804c --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/test-page.png diff --git a/src/tutorials/how-to-use-jira/img/test-repo-sidebar.png b/src/tutorials/how-to-use-jira/img/test-repo-sidebar.png Binary files differnew file mode 100644 index 0000000..67cea89 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/test-repo-sidebar.png diff --git a/src/tutorials/how-to-use-jira/img/test-repo.png b/src/tutorials/how-to-use-jira/img/test-repo.png Binary files differnew file mode 100644 index 0000000..3f98520 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/test-repo.png diff --git a/src/tutorials/how-to-use-jira/img/time-and-configure.png b/src/tutorials/how-to-use-jira/img/time-and-configure.png Binary files differnew file mode 100644 index 0000000..ef587df --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/time-and-configure.png diff --git a/src/tutorials/how-to-use-jira/img/time-tracking.png b/src/tutorials/how-to-use-jira/img/time-tracking.png Binary files differnew file mode 100644 index 0000000..69b2252 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/time-tracking.png diff --git a/src/tutorials/how-to-use-jira/img/todo-doing-done.png b/src/tutorials/how-to-use-jira/img/todo-doing-done.png Binary files differnew file mode 100644 index 0000000..8eab797 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/todo-doing-done.png diff --git a/src/tutorials/how-to-use-jira/img/versions-and-epics.png b/src/tutorials/how-to-use-jira/img/versions-and-epics.png Binary files differnew file mode 100644 index 0000000..def629a --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/versions-and-epics.png diff --git a/src/tutorials/how-to-use-jira/img/view-all-filters-advanced-issue-search.png b/src/tutorials/how-to-use-jira/img/view-all-filters-advanced-issue-search.png Binary files differnew file mode 100644 index 0000000..130b1e5 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/view-all-filters-advanced-issue-search.png diff --git a/src/tutorials/how-to-use-jira/img/view-all-projects-top.png b/src/tutorials/how-to-use-jira/img/view-all-projects-top.png Binary files differnew file mode 100644 index 0000000..77dd9f0 --- /dev/null +++ b/src/tutorials/how-to-use-jira/img/view-all-projects-top.png diff --git a/src/tutorials/how-to-use-jira/introduction.md b/src/tutorials/how-to-use-jira/introduction.md new file mode 100644 index 0000000..bff260f --- /dev/null +++ b/src/tutorials/how-to-use-jira/introduction.md @@ -0,0 +1,25 @@ +# How to use Jira - Introduction + +**Article Created: 23 July 2020** || **Last Edited: 23 July 2020** + +[Filters >](./filters.html) + +--- + +[Jira](https://www.atlassian.com/software/jira) is one of the most used project management and issue tracking products out there. + +It has a lot of features that can be quite overwhelming for new comers, especially these who are new to project management software. That's why this tutorial is here. + +**Note**: some stuff might only be doable from a project administrator, meaning you might not have persmission to do some things + +## Contents + +1. [Filters](./filters.html) +2. [Projects](./projects.html) +3. [Kanban template](./kanban.html) +4. [Scrum template](./scrum.html) +5. [Bug tracking template](./bug.html) +6. [Releases](./releases.html) +7. [Pages](./pages.html) +8. [Components](./components.html) +9. [Dashboards](./dashboards.html) diff --git a/src/tutorials/how-to-use-jira/kanban.md b/src/tutorials/how-to-use-jira/kanban.md new file mode 100644 index 0000000..3b583fd --- /dev/null +++ b/src/tutorials/how-to-use-jira/kanban.md @@ -0,0 +1,38 @@ +# How to use Jira - Kanban template + +**Article Created: 23 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Projects](./projects.html) || [Scrum template >](./scrum.html) + +--- + +**In the software industry, kanban is a [framework](https://stackoverflow.com/a/12733126/12036073) for [agile software development](https://www.atlassian.com/agile) where each work item is visually represented and can be moved to different places**. + +It's purpose is to **organise** and **visualise your work** with the goal of **maximising efficiency**, amongst other things. The focus is on **reducing time on a project from start to finish**. + +In brief, the main workflow is **just cards and boards**. That's it. + +Usually kanban doesn't even require for a project to be a programming one, you can **easily use the framework for any project that requires any level of task distribution**. Atlassian, the company behind Jira, has made (technically acquired) a separate web application, [Trello](https://trello.com/), that is dedicated only to kanban. + +## Backlog + +In kanban, **the backlog is just another column in your board(s)**. If you want you can remove it entirely from your board(s). + + + +For a **lot more detailed** information, you can read [these sets of articles](https://www.atlassian.com/agile/kanban) from Atlassian. \ +This tutorial covers the more important topics in shorter text form. + +## Create board + +**This template can be either chosen when creating a project**, + + + +or **from the `Create board` screen**. + + + +At it's core, the kanban template **controls how board, issues and cards work together**. **Each template is tied to it's given board**. + +**Note**: when you create a project, you can choose this template. This just means that the project will automatically create a new board with the template. diff --git a/src/tutorials/how-to-use-jira/pages.md b/src/tutorials/how-to-use-jira/pages.md new file mode 100644 index 0000000..46acdf2 --- /dev/null +++ b/src/tutorials/how-to-use-jira/pages.md @@ -0,0 +1,17 @@ +# How to use Jira - Pages + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Releases](./releases.html) || [Components >](./components.html) + +--- + +**Pages are a place for documents for your team**. The goal is to have a centralised place where everyone in your teams can share knowledge. + + + +Pages are power by another Atlassian product names `Confluence`. It is a **subscription-based software**, but it does also offer a free 30-day trial. + +**All documents (pages)** that you write are **organised into `Spaces`**. When creating a page you can choose one of many templates or just start off with a blank one. + +**Confluence won't be covered in this tutorial**. You can read more about it from [here](<https://www.atlassian.com/software/confluence/guides/get-started/set-up>). diff --git a/src/tutorials/how-to-use-jira/projects.md b/src/tutorials/how-to-use-jira/projects.md new file mode 100644 index 0000000..b77c204 --- /dev/null +++ b/src/tutorials/how-to-use-jira/projects.md @@ -0,0 +1,147 @@ +# How to use Jira - Projects + +**Article Created: 23 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Cards](./cards.html) || [Kanban template >](./kanban.html) + +--- + + + +In short, **projects are a collection of issues with added functionality** for organising them, getting statistics, etc. + +## 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. + +A board gets all of the issues from it's given filter and offers a way to organise them. + +### 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`. + + + +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**. + +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 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 do that either in a board, from **clicking the three dots and choosing `Create board`** + + + +or **in the sidebar, from the `Board` menu**. + + + +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). + + + +When you've made a choice, you will be met with three options: + + + +- **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 from existing project** - creates a board that gets the filter from another project + +  + +- **Board from an existing Saved Filter** - as it says, you add to the location project a board based on a filter + +  + +## 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 ([Scrum](./scrum.html))** + + + +or **just a column in a board ([Kanban](./kanban.html))**. + + + +Using a backlog is **explained in more detail in the different template pages**. + +## 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. + + + +From here you can **add shortcuts to any website**. Put the web address, give it a name and you are done + + + + + + + +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**. + + + + + +**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**, + + + +or **click on the `Create project` button in the `View all projects` page**. + + + + + +**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**. + + + +After that you'll need to **put a name for your project**, **a key** (used for issues) and **a template**. + + + +In this tutorial we will **cover only the three classic software templates: [Kanban](./kanban.html), [Scrum](./scrum.html) and [Bug tracking](./bug.html)**. + + + +In short, **templates govern how boards and issues should work together**. Read the respective pages for more information. + +--- + +**Projects also have [Releases](./releases.html), [Pages](./pages.html) and [Components](./components.html) that are covered in their respective pages in this tutorial**. diff --git a/src/tutorials/how-to-use-jira/releases.md b/src/tutorials/how-to-use-jira/releases.md new file mode 100644 index 0000000..c68cc26 --- /dev/null +++ b/src/tutorials/how-to-use-jira/releases.md @@ -0,0 +1,18 @@ +# How to use Jira - Releases + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Bug tracking template](./bug.html) || [Pages >](./pages.html) + +--- + +**The Releases page in a project shows all versions, the ones in development and the ones that are done**. + +**Versions are just a big collection of issues** and the **goal of a released version** is for **all of it's issues to be completed**. **It serves as a point in time for the development of a project**. + +## Adding issues to a version + +When creating an issue, you **can specify a version in the `Fix versions` property**. + + + diff --git a/src/tutorials/how-to-use-jira/scrum.md b/src/tutorials/how-to-use-jira/scrum.md new file mode 100644 index 0000000..0e7780d --- /dev/null +++ b/src/tutorials/how-to-use-jira/scrum.md @@ -0,0 +1,49 @@ +# How to use Jira - Scrum template + +**Article Created: 24 July 2020** || **Last Edited: 24 July 2020** + +[\<\<](./introduction.html) || [\< Kanban template](./kanban.html) || [Bug tracking template >](./bug.html) + +--- + +**Scrum is a [framework](https://stackoverflow.com/a/12733126/12036073) for [agile software development](https://www.atlassian.com/agile) where teams develop software in intervals, called sprints**. + +During a sprint, a **Scrum Master** organises and makes sure everyone follows the methodology. A Daily Scrum is held each day where **everyone shares what they have done the previous day and what they will do to the current day**. A retrospective happens at **the end of each sprint, where the team evaluates results and plans the next sprint**. + +## Backlog + +Contrary to the [Kanban template](./kanban.html), the backlog has a very important role. **The backlog is used to plan issues for any future sprints (see Boards and Issues below)**. + + + +From here you can also organise **Versions** (explained in more detail in [Releases](./releases.html)) and **Epics** (explained in more detail in [Cards](./cards.html)). An important note is that Epics in this context don't need to have their linked issues fixed in one sprint. + + + +Creating a sprint is done from the conveniently named `Create sprint` button. It shows a box on top where you can either move issues from the backlog to the sprint or create entirely new issues. + + + +## Boards and Issues + +Boards and issues (cards) **work mostly the same as explained in the [Project](./project.html) page**. + +However there is one big difference, **issues are put into the backlog**. So, **boards are used to organise a sprint's issues**, not all issues. + +This is also reflected in the user interface. After selecting a board from the sidebar, you view it from the `Active sprints` page. + + + +## Create board + +**This template can be either chosen when creating a project**, + + + +or **from the `Create board` screen**. + + + +At it's core, the **scrum template controls how board, issues and cards work together**. **Each template is tied to it's given board**. + +**Note**: when you create a project, you can choose this template. This just means that the project will automatically create a new board with the template. |
