diff options
| Commit | a8269cc3de8ed385ebb9b667a709a2991185161d (patch) | |
|---|---|---|
| Author | 2025-07-24 21:24:54 +0300 | |
| Committer | 2025-07-24 21:24:54 +0300 | |
| Files | e9d500557b9a6691357ee85f61b5a003f32cfa4e /src/tutorials | |
| syndamia.com-a8269cc3de8ed385ebb9b667a709a2991185161d.tar syndamia.com-a8269cc3de8ed385ebb9b667a709a2991185161d.tar.gz syndamia.com-a8269cc3de8ed385ebb9b667a709a2991185161d.zip | ||
| Parent | 6a84efc70706da6a8a15394dcbbf90eaa7198cb1 (diff) | |
feat(tutorials/how-to-use-jira): Converted to dunbar
23 files changed, 712 insertions, 674 deletions
diff --git a/src/tutorials/how-to-use-jira/bug.du b/src/tutorials/how-to-use-jira/bug.du new file mode 100644 index 0000000..49a9d2f --- /dev/null +++ b/src/tutorials/how-to-use-jira/bug.du @@ -0,0 +1,21 @@ +# Bug tracking template - How to use Jira + +'define expected-reading 1 min +'define created 24 July 2020 +'define edited 16 September 2020 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./scrum.html Scrum template] +'define next_link [url ./releases.html Releases] +[$pagination_middle] + +The Bug Tracking template is completely different from the [url ./scrum.html Scrum] and [url ./kanban.html Kanban] templates, because it =[offers only issue tracking]=. + +=[There are no boards, no cards, no backlog]=. All issues are accessed from the `[Issues]` page from the sidebar. + +[image ./img/issues-sidebar.png] + +That's why this template is =[available only when creating a project]=. + +Of course, =[you can add boards at any time]=, but this project template doesn't add any by itself. diff --git a/src/tutorials/how-to-use-jira/bug.md b/src/tutorials/how-to-use-jira/bug.md deleted file mode 100644 index fefd8e8..0000000 --- a/src/tutorials/how-to-use-jira/bug.md +++ /dev/null @@ -1,16 +0,0 @@ -# Bug tracking template - How to use Jira - -[`<<`](./) || [`< Scrum template`](./scrum.html) || [`Releases >`](./releases.html) - -<br> - -The Bug Tracking template is completely different from the [Scrum](./scrum.html) and [Kanban](./kanban.html) templates, because it **offers only issue tracking**. - -**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 boards at any time**, but this project template doesn't add any by itself. - diff --git a/src/tutorials/how-to-use-jira/cards.du b/src/tutorials/how-to-use-jira/cards.du new file mode 100644 index 0000000..a73a152 --- /dev/null +++ b/src/tutorials/how-to-use-jira/cards.du @@ -0,0 +1,163 @@ +# Cards - 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 ./filters.html Filters] +'define next_link [url ./projects.html Projects] +[$pagination_middle] + +.contents +.numbered +1. [url #properties Properties] +2. [url #creating Creating] +3. [url #viewing Viewing] +4. [url #how-to-use How to use] + .numbered + 1. [url #right-side Right side] + 2. [url #work-log Work log] + 3. [url #issue-flagging Issue flagging] + 4. [url #basic-issue-information Basic issue information] + +=[Each issue is represented as an object with properties]=. More specifically, these objects are called 'cards'. + +[image ./img/kanban-cards.png] + +## Properties + +Each card has the following properties: + +[image ./img/fields-cards.png] + +:bulleted +- =[Project]= - the [url ./projects.html project] this card is stored in + + .p [image ./img/project-create-card.png] + +- =[Issue type]= - the basic purpose of an issue (Improvement, Bug, ...) + + .p [image ./img/issue-types.png] + + :p + :bulleted + - [image ./img/story-type.png Story] - functionality or feature expressed as a goal, something like "As a user, I want to be able to pay for my order via PayPal" + + - [image ./img/bug-type.png Bug] - a problem/error + + - [image ./img/epic-type.png Epic] - a collection of issues, issues are linked through 'Epic link' (see below) + + - [image ./img/task-type.png Task] - a small piece of work + + - [image ./img/sub-task-type.png Sub-task] - 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 + + .p [image ./img/summary-create-card.png] + +- =[Description]= - detailed explanation of the issue + + .p [image ./img/description-create-card.png] + +- =[Reporter]= - person who created the issue + + .p [image ./img/reporter-create-card.png] + +- =[Assignee]= - person who will work on the issue + + .p [image ./img/assignee-create-card.png] + +- =[Labels]= - tags with which you can organise even more the issue + + .p [image ./img/label-create-card.png] + +- =[Epic link]= - link of issue with type Epic + + .p [image ./img/epic-link-create-card.png] + + +## Creating + +To create a card yourself, you need to =[press the `[Create]` button on the top bar]=. + +[image ./img/create-header.png] + +## Viewing + +=[All]= cards (issues) can be viewed from a [url ./projects.html project]'s side menu, under 'Issues'. + +[image ./img/issues-sidebar.png] + +Of course, they can also be viewed through =[[url ./filters.html filters]]= and a =[[url ./projects.html project]'s board]=. + +## How to use + +By default, opening a card presents, at the top, it's =[key]= (think of it as an ID), + +[image ./img/card-key.png] + +it's =[summary]= below it, + +[image ./img/card-summary.png] + +options for adding =[attachments]=, =[subtasks]=, =[linking issues]= and =[adding more apps]= (think of apps like extensions), + +[image ./img/card-attach-subtask.png] + +following are the =[description]=, =[actual attachments]=, =[subtasks]=, =[linked issues]=, etc., + +[image ./img/desc-att-sub-link.png] + +and at the bottom you have the =[activity]=, consisting of =[comments]= on the issue, + +[image ./img/activity-comments.png] + +=[history]= of things that have happened to that issue, + +[image ./img/activity-history.png] + +and =[work logs]= (a bit later we talk about them in more detail). + +[image ./img/activity-work-log.png] + +### Right side + +To the right side, you have all of the different =[properties]= (some fields without a value will be hidden). + +[image ./img/card-right-side.png] + +On the top right you can change =[watch options]= ([url https://www.idalko.com/jira-watch-issues/ watching an issue] means you get notified by all changes done to it), you can =[share]= the card and do =[actions]= (the three dots). + +[image ./img/card-top-right.png] + +=[Actions]= are things you can do to the whole card, like moving or deleting it. + +[image ./img/card-actions.png] + +The most notable options are `[[url https://confluence.atlassian.com/jirasoftwarecloud/logging-work-on-issues-902499028.html Log work]]` and `[Add flag]`. + +### Work log + +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. + +[image ./img/time-tracking.png] + +The time remaining takes a =[default]= value from the =[previous time log]=, so you don't need to specify it every time. + +### Issue flagging + +A =[flagged issue]= is an issue that is very important. Flagged issues are displayed in yellow to signify their needed attention. + +[image ./img/flagged-card.png] + +### Basic issue information + +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 [url https://confluence.atlassian.com/adminjiracloud/changing-a-field-configuration-844500798.html here]. + +[image ./img/time-and-configure.png] diff --git a/src/tutorials/how-to-use-jira/cards.md b/src/tutorials/how-to-use-jira/cards.md deleted file mode 100644 index 77d27a9..0000000 --- a/src/tutorials/how-to-use-jira/cards.md +++ /dev/null @@ -1,151 +0,0 @@ -# Cards - How to use Jira - -[`<<`](./) || [`< Filters`](./filters.html) || [`Projects >`](./projects.html) - -<br> - -## Contents - -1. [Properties](#properties) -2. [Creating](#creating) -3. [Viewing](#viewing) -4. [How to use](#how-to-use) - 1. [Right side](#right-side) - 2. [Work log](#work-log) - 3. [Issue flagging](#issue-flagging) - 4. [Basic issue information](#basic-issue-information) - -**Each issue is represented as an object with properties**. More specifically, these objects are called 'cards'. - - - -## Properties - -Each card has the following properties: - - - -- **Project** - the [project](./projects.html) this card is stored in - -  - -- **Issue type** - the basic purpose of an issue (Improvement, Bug, ...) - -  - - -  - functionality or feature expressed as a 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 will work on the issue - -  - -- **Labels** - tags with which you can organise even more the issue - -  - -- **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** below it, - - - -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**, etc., - - - -and at the bottom you have the **activity**, consisting of **comments** on the issue, - - - -**history** of things that have happened to that issue, - - - -and **work logs** (a bit later we talk about them in more detail). - - - -### Right side - -To the right side, you have all of the different **properties** (some fields without a 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`. - -### Work log - -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. - -### Issue flagging - -A **flagged issue** is an issue that is very important. Flagged issues are displayed in yellow to signify their needed attention. - - - -### Basic issue information - -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.du b/src/tutorials/how-to-use-jira/components.du new file mode 100644 index 0000000..e5ac462 --- /dev/null +++ b/src/tutorials/how-to-use-jira/components.du @@ -0,0 +1,50 @@ +# Components - How to use Jira + +'define expected-reading 2 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./pages.html Pages] +'define next_link [url ./dashboards.html Dashboards] +[$pagination_middle] + +.contents +.numbered +1. [url #creating-and-editing Creating and editing] +2. [url #adding-issues Adding issues] + +Components are =[yet another way to group issues together]=. They don't have any specific meaning like versions, their usage depends on the project's organisation. + +## Creating and editing + +Creating and editing them is done from the =[`[Components]` menu in the sidebar]=. + +[image ./img/components-sidebar.png] + +Creating one is done through the button on the top right (in the center if you don't have any components) by the name of `[Create component]`. + +[image ./img/create-component-empty.png] + +[image ./img/create-component-full.png] + +Clicking on it presents you with a screen where you input it's information. + +[image ./img/create-component-page.png] + +=[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]=. + +## Adding issues + +Adding an issue to a component can be done either =[when creating it]= or =[when viewing it]=. + +=[Right under the summary]=, there is a place for indicating a component, named `[Components]`. + +[image ./img/components-create-card.png] + +When viewing an issue, you can add one from the `[Components]` field to the right (you might need to first click on `[Show more fields]`). + +[image ./img/show-fields.png] + +[image ./img/components-field.png] diff --git a/src/tutorials/how-to-use-jira/components.md b/src/tutorials/how-to-use-jira/components.md deleted file mode 100644 index 4f22a31..0000000 --- a/src/tutorials/how-to-use-jira/components.md +++ /dev/null @@ -1,45 +0,0 @@ -# Components - How to use Jira - -[`<<`](./) || [`< Pages`](./pages.html) || [`Dashboards >`](./dashboards.html) - -<br> - -## Contents - -1. [Creating and editing](#creating-and-editing) -2. [Adding issues](#adding-issues) - -Components are **yet another way to group issues together**. They don't have any specific meaning like versions, their usage depends on the project's organisation. - -## Creating and editing - -Creating and editing them is done from the **`Components` menu in the sidebar**. - - - -Creating one is done through the button on the top right (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 input it'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**. - -## Adding issues - -Adding an issue to a component can be done either **when creating it** 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 one from the `Components` field to the right (you might need to first click on `Show more fields`). - - - - - diff --git a/src/tutorials/how-to-use-jira/dashboards.du b/src/tutorials/how-to-use-jira/dashboards.du new file mode 100644 index 0000000..384ad43 --- /dev/null +++ b/src/tutorials/how-to-use-jira/dashboards.du @@ -0,0 +1,65 @@ +# Dashboards - How to use Jira + +'define expected-reading 2 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./components.html Components] +[$pagination_end] + +.contents +.numbered +1. [url #adding-a-dashboard Adding a dashboard] +2. [url #adding-gadgets Adding gadgets] + +Dashboards are a =[place where you can view a lot of information]=. + +[image ./img/default-dashboard.png] + +Dashboards are composed of =[gadgets]=. + +[image ./img/gadgets.png] + +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, under `[Create dashboard]` in the `[Dashboards]` menu + +[image ./img/create-dashboard-top.png] + +or, if you are already in a dashboard, from `[Create dashboard]` in the three dots menu. + +[image ./img/create-dashboard-dots.png] + +## 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]= + +[image ./img/add-gadget-top.png] + +or, =[if you don't have any gadets]=, =[from the `[add a new gadget]` message(s)]=. + +[image ./img/add-a-gadget.png] + +After that, you are greeted by a window that =[shows all of the avalable ones]= (you might need to =[press `[Load all gadgets]`]=). + +[image ./img/load-all.png] + +[image ./img/add-gadget.png] + +Adding a gadget is as simple as clicking the button `[Add gadget]` next to the name of the gadget you want to add. + +[image ./img/introduction-add.png] + +After it is added, you'll =[need to configure it]=, usually a gadget =[requires atleast a filter/project]=. + +[image ./img/bubble.png] + +Options for different gadgets can be found on =[their top right corner, in the three dots menu]=. + +[image ./img/bubble-dots.png] diff --git a/src/tutorials/how-to-use-jira/dashboards.md b/src/tutorials/how-to-use-jira/dashboards.md deleted file mode 100644 index 6b3185f..0000000 --- a/src/tutorials/how-to-use-jira/dashboards.md +++ /dev/null @@ -1,61 +0,0 @@ -# Dashboards - How to use Jira - -[`<<`](./) || [`< Components`](./components.html) - -<br> - -## Contents - -1. [Adding a dashboard](#adding-a-dashboard) -2. [Adding gadgets](#adding-gadgets) - -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, under `Create dashboard` in the `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 of the avalable ones** (you might need to **press `Load all gadgets`**). - - - - - -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 atleast a filter/project**. - - - -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.du b/src/tutorials/how-to-use-jira/filters.du new file mode 100644 index 0000000..84f3e03 --- /dev/null +++ b/src/tutorials/how-to-use-jira/filters.du @@ -0,0 +1,44 @@ +# Filters - How to use Jira + +'define expected-reading 1 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define prev_link [url ./ Introduction] +'define next_link [url ./cards.html Cards] +[$pagination_second] + +.contents +.numbered +1. [url #criteria Criteria] +2. [url #jql JQL] + +=[Filters work like an advanced issue search that you can save]=. With filters you filter issues from chosen project(s) by their properties (status, type, start date, etc.). + +Making filters is done through the `[Advanced issue search]` page, from the `[Filters]` menu. + +[image ./img/filters-advanced-issue-search.png] + +## Criteria + +From here you can see some criteria: `[Project]`, `[Type]`, `[Status]`, `[Assignee]`. + +[image ./img/criteria-advanced-issue-search.png] + +Clicking on the criteria will reveal what options you can choose for it. Access to more criteria can be obtained via the `[+ More]` menu. + +[image ./img/plus-more-advanced-issue-search.png] + +After configuring your desired options, you can =[save the filter]= and use it later. To do so, simply click on `[Save as]` and enter a name for it. + +[image ./img/save-as-advanced-issue-search.png] +[image ./img/save-filter-filters-advanced-issue-search.png] + +You can view all of your filters from the conveniently named `[View all filters]` option in the `[Filters]` menu. + +[image ./img/view-all-filters-advanced-issue-search.png] + +## JQL + +You can do =[more advanced search]= through `[JQL]` (Jira Query Language), but we won't be covering this topic. I can recommend [url https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14 this article] on the subject. diff --git a/src/tutorials/how-to-use-jira/filters.md b/src/tutorials/how-to-use-jira/filters.md deleted file mode 100644 index 97ec938..0000000 --- a/src/tutorials/how-to-use-jira/filters.md +++ /dev/null @@ -1,40 +0,0 @@ -# Filters - How to use Jira - -[`< Introduction`](./) || [`Cards >`](./cards.html) - -<br> - -## Contents - -1. [Criteria](#Criteria) -2. [JQL](#JQL) - -**Filters work like an advanced issue search that you can save**. With filters you filter issues from chosen project(s) by their properties (status, type, start date, etc.). - -Making filters is done through the `Advanced issue search` page, from the `Filters` menu. - - - -## Criteria - -From here you can see some criteria: `Project`, `Type`, `Status`, `Assignee`. - - - -Clicking on the criteria will reveal what options you can choose for it. Access to more criteria can be obtained via the `+ More` menu. - - - -After configuring your desired options, you can **save the filter** and use it later. To do so, simply click on `Save as` and enter a name for it. - - - - -You can view all of your filters from the conveniently named `View all filters` option in the `Filters` menu. - - - -## JQL - -You can do **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. - diff --git a/src/tutorials/how-to-use-jira/index.du b/src/tutorials/how-to-use-jira/index.du new file mode 100644 index 0000000..7bc9907 --- /dev/null +++ b/src/tutorials/how-to-use-jira/index.du @@ -0,0 +1,75 @@ +# Introduction - How to use Jira + +'define expected-reading 19 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define next_link [url ./filters.html Filters] +[$pagination_start] + +:contents +:numbered +1. [url ./filters.html Filters] + .numbered + 1. [url ./filters.html#criteria Criteria] + 2. [url ./filters.html#jql JQL] + +2. [url ./cards.html Cards] + .numbered + 1. [url ./cards.html#properties Properties] + 2. [url ./cards.html#creating Creating] + 3. [url ./cards.html#viewing Viewing] + 4. [url ./cards.html#how-to-use How to use] + .numbered + 1. [url ./cards.html#right-side Right side] + 2. [url ./cards.html#work-log Work log] + 3. [url ./cards.html#issue-flagging Issue flagging] + 4. [url ./cards.html#basic-issue-information Basic issue information] + +3. [url ./projects.html Projects] + :numbered + 1. [url ./projects.html#creating-a-project Creating a project] + 2. [url ./projects.html#boards Boards] + .numbered + 1. [url ./projects.html#columns Columns] + 2. [url ./projects.html#adding-more-boards-to-a-project Adding more boards to a project] + + 3. [url ./projects.html#backlog Backlog] + 4. [url ./projects.html#add-item Add item] + + +4. [url ./kanban.html Kanban template] + .numbered + 1. [url ./kanban.html#create-board Create board] + 2. [url ./kanban.html#backlog Backlog] + +5. [url ./scrum.html Scrum template] + .numbered + 1. [url ./scrum.html#backlog Backlog] + 2. [url ./scrum.html#boards-and-issues Boards and Issues] + 3. [url ./scrum.html#create-board Create board] + +6. [url ./bug.html Bug tracking template] + +7. [url ./releases.html Releases] + +8. [url ./pages.html Pages] + +9. [url ./components.html Components] + .numbered + 1. [url ./components.html#creating-and-editing Creating and editing] + 2. [url ./components.html#adding-issues Adding issues] + +10. [url ./dashboards.html Dashboards] + .numbered + 1. [url ./dashboards.html#adding-a-dashboard Adding a dashboard] + 2. [url ./dashboards.html#adding-gadgets Adding gadgets] + + + +[url https://www.atlassian.com/software/jira 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 I'm writing this tutorial. + +=[Note]=: certain actions can be done only from a project administrator diff --git a/src/tutorials/how-to-use-jira/index.md b/src/tutorials/how-to-use-jira/index.md deleted file mode 100644 index 42a3364..0000000 --- a/src/tutorials/how-to-use-jira/index.md +++ /dev/null @@ -1,50 +0,0 @@ -# Introduction - How to use Jira - -[`Filters >`](./filters.html) - -<br> - -## Contents - -1. [Filters](./filters.html) - 1. [Criteria](./filters.html#criteria) - 2. [JQL](./filters.html#jql) -2. [Cards](./cards.html) - 1. [Properties](./cards.html#properties) - 2. [Creating](./cards.html#creating) - 3. [Viewing](./cards.html#viewing) - 4. [How to use](./cards.html#how-to-use) - 1. [Right side](./cards.html#right-side) - 2. [Work log](./cards.html#work-log) - 3. [Issue flagging](./cards.html#issue-flagging) - 4. [Basic issue information](./cards.html#basic-issue-information) -3. [Projects](./projects.html) - 1. [Creating a project](./projects.html#creating-a-project) - 2. [Boards](./projects.html#boards) - 1. [Columns](./projects.html#columns) - 2. [Adding more boards to a project](./projects.html#adding-more-boards-to-a-project) - 3. [Backlog](./projects.html#backlog) - 4. [Add item](./projects.html#add-item) -4. [Kanban template](./kanban.html) - 1. [Create board](./kanban.html#create-board) - 2. [Backlog](./kanban.html#backlog) -5. [Scrum template](./scrum.html) - 1. [Backlog](./scrum.html#backlog) - 2. [Boards and Issues](./scrum.html#boards-and-issues) - 3. [Create board](./scrum.html#create-board) -6. [Bug tracking template](./bug.html) -7. [Releases](./releases.html) -8. [Pages](./pages.html) -9. [Components](./components.html) - 1. [Creating and editing](./components.html#creating-and-editing) - 2. [Adding issues](./components.html#adding-issues) -10. [Dashboards](./dashboards.html) - 1. [Adding a dashboard](./dashboards.html#adding-a-dashboard) - 2. [Adding gadgets](./dashboards.html#adding-gadgets) - -[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 I'm writing this tutorial. - -**Note**: certain actions can be done only from a project administrator - diff --git a/src/tutorials/how-to-use-jira/introduction.md b/src/tutorials/how-to-use-jira/introduction.md deleted file mode 100644 index 6ce830d..0000000 --- a/src/tutorials/how-to-use-jira/introduction.md +++ /dev/null @@ -1,49 +0,0 @@ -# Introduction - How to use Jira - -[`Filters >`](./filters.html) - -<br> - -[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 I'm writing this tutorial. - -**Note**: certain actions can be done only from a project administrator - -## Contents - -1. [Filters](./filters.html) - 1. [Criteria](./filters.html#criteria) - 2. [JQL](./filters.html#jql) -2. [Cards](./cards.html) - 1. [Properties](./cards.html#properties) - 2. [Creating](./cards.html#creating) - 3. [Viewing](./cards.html#viewing) - 4. [How to use](./cards.html#how-to-use) - 1. [Right side](./cards.html#right-side) - 2. [Work log](./cards.html#work-log) - 3. [Issue flagging](./cards.html#issue-flagging) - 4. [Basic issue information](./cards.html#basic-issue-information) -3. [Projects](./projects.html) - 1. [Creating a project](./projects.html#creating-a-project) - 2. [Boards](./projects.html#boards) - 1. [Columns](./projects.html#columns) - 2. [Adding more boards to a project](./projects.html#adding-more-boards-to-a-project) - 3. [Backlog](./projects.html#backlog) - 4. [Add item](./projects.html#add-item) -4. [Kanban template](./kanban.html) - 1. [Create board](./kanban.html#create-board) - 2. [Backlog](./kanban.html#backlog) -5. [Scrum template](./scrum.html) - 1. [Backlog](./scrum.html#backlog) - 2. [Boards and Issues](./scrum.html#boards-and-issues) - 3. [Create board](./scrum.html#create-board) -6. [Bug tracking template](./bug.html) -7. [Releases](./releases.html) -8. [Pages](./pages.html) -9. [Components](./components.html) - 1. [Creating and editing](./components.html#creating-and-editing) - 2. [Adding issues](./components.html#adding-issues) -10. [Dashboards](./dashboards.html) - 1. [Adding a dashboard](./dashboards.html#adding-a-dashboard) - 2. [Adding gadgets](./dashboards.html#adding-gadgets) diff --git a/src/tutorials/how-to-use-jira/kanban.du b/src/tutorials/how-to-use-jira/kanban.du new file mode 100644 index 0000000..a1788b3 --- /dev/null +++ b/src/tutorials/how-to-use-jira/kanban.du @@ -0,0 +1,38 @@ +# Kanban template - How to use Jira + +'define expected-reading 1 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./projects.html Projects] +'define next_link [url ./scrum.html Scrum template] +[$pagination_middle] + +.contents +.numbered +1. [url #create-board Create board] +2. [url #backlog Backlog] + +Kanban is a =[way for visually organising work items]= (issues in our case). Kanban consists of =[columns]= and =[cards]=, where cards are the work items and are =[moved from one column to another]= depending on the situation. This should sound =[familiar]=, because that is how [url ./projects.md Boards] work. + +In a projects that uses the kanban template, boards can access directly all of the available issues. + +This tutorial focuses on the basics, but you can find a lot of information in [url https://www.atlassian.com/agile/kanban these sets of articles] from Atlassian. + +## Create board + +This template can be chosen when =[creating a project]= + +[image ./img/choose-classic-template.png] + +and =[from the `[Create board]` screen]=. + +[image ./img/scrum-kanban-board.png] + +## Backlog + +In kanban, =[the backlog is just another column in your board(s)]=. It can be removed entirely. + +[image ./img/backlog-kanban.png] diff --git a/src/tutorials/how-to-use-jira/kanban.md b/src/tutorials/how-to-use-jira/kanban.md deleted file mode 100644 index 4818f5c..0000000 --- a/src/tutorials/how-to-use-jira/kanban.md +++ /dev/null @@ -1,33 +0,0 @@ -# Kanban template - How to use Jira - -[`<<`](./) || [`< Projects`](./projects.html) || [`Scrum template >`](./scrum.html) - -<br> - -## Contents - -1. [Create board](#create-board) -2. [Backlog](#backlog) - -Kanban is a **way for visually organising work items** (issues in our case). Kanban consists of **columns** and **cards**, where cards are the work items and are **moved from one column to another** depending on the situation. This should sound **familiar**, because that is how [Boards](./projects.md) work. - -In a projects that uses the kanban template, boards can access directly all of the available issues. - -This tutorial focuses on the basics, but you can find a lot of information in [these sets of articles](https://www.atlassian.com/agile/kanban) from Atlassian. - -## Create board - -This template can be chosen when **creating a project** - - - -and **from the `Create board` screen**. - - - -## Backlog - -In kanban, **the backlog is just another column in your board(s)**. It can be removed entirely. - - - diff --git a/src/tutorials/how-to-use-jira/pages.du b/src/tutorials/how-to-use-jira/pages.du new file mode 100644 index 0000000..db84eeb --- /dev/null +++ b/src/tutorials/how-to-use-jira/pages.du @@ -0,0 +1,22 @@ +# Pages - How to use Jira + +'define expected-reading 1 min +'define created 24 July 2020 +'define edited 16 September 2020 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./releases.html Releases] +'define next_link [url ./components.html Components] +[$pagination_middle] + +=[Pages are a place for documents for your team]=. The goal is to have a centralised location where everyone in your team can share knowledge. + +[image ./img/test-page.png] + +Pages are powered by another Atlasian product, named `[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 [url https://www.atlassian.com/software/confluence/guides/get-started/set-up here]. + diff --git a/src/tutorials/how-to-use-jira/pages.md b/src/tutorials/how-to-use-jira/pages.md deleted file mode 100644 index adf2c1a..0000000 --- a/src/tutorials/how-to-use-jira/pages.md +++ /dev/null @@ -1,16 +0,0 @@ -# Pages - How to use Jira - -[`<<`](./) || [`< Releases`](./releases.html) || [`Components >`](./components.html) - -<br> - -**Pages are a place for documents for your team**. The goal is to have a centralised location where everyone in your team can share knowledge. - - - -Pages are powered by another Atlasian product, named `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 [here](https://www.atlassian.com/software/confluence/guides/get-started/set-up). - 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]]=. diff --git a/src/tutorials/how-to-use-jira/projects.md b/src/tutorials/how-to-use-jira/projects.md deleted file mode 100644 index cfe2e0e..0000000 --- a/src/tutorials/how-to-use-jira/projects.md +++ /dev/null @@ -1,147 +0,0 @@ -# Projects - How to use Jira - -[`<<`](./) || [`< Cards`](./cards.html) || [`Kanban template >`](./kanban.html) - -<br> - -## Contents - -1. [Creating a project](#creating-a-project) -2. [Boards](#boards) - 1. [Columns](#columns) - 2. [Adding more boards to a project](#adding-more-boards-to-a-project) -3. [Backlog](#backlog) -4. [Add item](#add-item) - -In short, **projects are a collection of issues** with added functionality for **organising them, getting statistics, etc**. - - - -## 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` types **won't be covered**. - - - -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**. - - - -This tutorial covers **only** the three classic software templates: [**Kanban**](./kanban.html), [**Scrum**](./scrum.html) and [**Bug tracking**](./bug.html). - - - -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 how this could be 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, 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). - - - - - -### Adding more boards to a project - -You can also add to a project as many [**Scrum**](./scrum.html) and [**Kanban**](./kanban.html) templated boards as you want. - -This can be done, either while 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 `Create a board` window, where you can choose your template. - - - -Once you've made your choice, you will be met with three options: - - - -- **Board created with new Software project** - creates a new project 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 project (indicated in the `Location` field) a board based on a saved 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))**, - - - -**just a column in a board ([Kanban](./kanban.html))**, - - - -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. - - - -From here you can **add a website shortcut**, simply by putting the web address and giving it a name. - - - - - -The name is used for showing the shortcut on the sidebar. - - - -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. - -From the `Add Item` menu you can also **toggle the shortcut to [Pages](./pages.html)**. - diff --git a/src/tutorials/how-to-use-jira/releases.du b/src/tutorials/how-to-use-jira/releases.du new file mode 100644 index 0000000..5a2baa0 --- /dev/null +++ b/src/tutorials/how-to-use-jira/releases.du @@ -0,0 +1,21 @@ +# Releases - How to use Jira + +'define expected-reading 1 min +'define created 24 July 2020 +'define edited 16 September 2020 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./bug.html Bug tracking template] +'define next_link [url ./pages.html Pages] +[$pagination_middle] + +The `[Releases]` page in a project shows =[versions]=, the ones in development and the ones that are completed. + +=[Versions are just a big collection of issues]= and the =[goal of a released version]= is for =[all of it's issues to be resolved]=. 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. + +[image ./img/fix-versions.png] diff --git a/src/tutorials/how-to-use-jira/releases.md b/src/tutorials/how-to-use-jira/releases.md deleted file mode 100644 index d2849d6..0000000 --- a/src/tutorials/how-to-use-jira/releases.md +++ /dev/null @@ -1,16 +0,0 @@ -# Releases - How to use Jira - -[`<<`](./) || [`< Bug tracking template`](./bug.html) || [`Pages >`](./pages.html) - -<br> - -The `Releases` page in a project shows **versions**, the ones in development and the ones that are completed. - -**Versions are just a big collection of issues** and the **goal of a released version** is for **all of it's issues to be resolved**. 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.du b/src/tutorials/how-to-use-jira/scrum.du new file mode 100644 index 0000000..1224a7a --- /dev/null +++ b/src/tutorials/how-to-use-jira/scrum.du @@ -0,0 +1,55 @@ +# Scrum template - How to use Jira + +'define expected-reading 2 min +'define created 24 July 2020 +'define edited 03 June 2021 +[$pagenav] + +'define start_url ./ +'define prev_link [url ./kanban.html Kanban template] +'define next_link [url ./bug.html Bug tracking template] +[$pagination_middle] + +.contents +.numbered +1. [url #backlog Backlog] +2. [url #boards-and-issues Boards and Issues] +3. [url #create-board Create board] + +The scrum template is very similar to the kanban template, with one big difference: =[sprints]=. + +=[All issues]= are put into the =[backlog]= (which is now a =[separate page]=). From there, they are organised into =[sprints]=. + +In general [url https://www.atlassian.com/agile agile software development], a =[sprint is a small duration of time]= (one to four weeks) where the team focuses on a =[set of tasks]= and at the end everyone =[evaluates the results]= and plans the next sprint. + +Your =[boards only work on the issues of the currently active sprint]=. + +## Backlog + +As we've discussed, the =[backlog]= is used for organising =[all issues]= into =[sprints]=. + +[image ./img/sample-scrum-backlog.png] + +From here you can also organise =[Versions]= (refer to [url ./releases.html Releases]) and =[Epics]= (refer to [url ./cards.html Cards]). An important note is that Epics in this context don't need to have their linked issues in only one sprint. + +[image ./img/versions-and-epics.png] + +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. + +[image ./img/sample-sprint.png] + +## Boards and Issues + +As previously mentioned, boards have access only to the issues in the active sprint. This is also reflected in the user interface. After selecting a board from the sidebar, you view it from the `[Active sprints]` page. + +[image ./img/active-sprints.png] + +## Create board + +This template can be chosen when =[creating a project]= + +[image ./img/choose-classic-template.png] + +and =[from the `[Create board]` screen]=. + +[image ./img/scrum-kanban-board.png] diff --git a/src/tutorials/how-to-use-jira/scrum.md b/src/tutorials/how-to-use-jira/scrum.md deleted file mode 100644 index d4e9255..0000000 --- a/src/tutorials/how-to-use-jira/scrum.md +++ /dev/null @@ -1,50 +0,0 @@ -# Scrum template - How to use Jira - -[`<<`](./) || [`< Kanban template`](./kanban.html) || [`Bug tracking template >`](./bug.html) - -<br> - -## Contents - -1. [Backlog](#backlog) -2. [Boards and Issues](#boards-and-issues) -3. [Create board](#create-board) - -The scrum template is very similar to the kanban template, with one big difference: **sprints**. - -**All issues** are put into the **backlog** (which is now a **separate page**). From there, they are organised into **sprints**. - -In general [agile software development](https://www.atlassian.com/agile), a **sprint is a small duration of time** (one to four weeks) where the team focuses on a **set of tasks** and at the end everyone **evaluates the results** and plans the next sprint. - -Your **boards only work on the issues of the currently active sprint**. - -## Backlog - -As we've discussed, the **backlog** is used for organising **all issues** into **sprints**. - - - -From here you can also organise **Versions** (refer to [Releases](./releases.html)) and **Epics** (refer to [Cards](./cards.html)). An important note is that Epics in this context don't need to have their linked issues in only 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 - -As previously mentioned, boards have access only to the issues in the active sprint. 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 chosen when **creating a project** - - - -and **from the `Create board` screen**. - - - |