From f5d6705e1a82e18c0abd66856fc05f719e652ac1 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sat, 12 Sep 2020 09:08:01 +0300 Subject: h3 tags are now underlined, imrpoved wording, formatting and images of first three pages of how to use jira tutorial --- src/tutorials/how-to-use-jira/cards.md | 38 +++++++++++++-------- src/tutorials/how-to-use-jira/filters.md | 20 ++++++----- .../how-to-use-jira/img/activiry-comments.png | Bin 23565 -> 0 bytes .../how-to-use-jira/img/activity-comments.png | Bin 0 -> 23565 bytes src/tutorials/how-to-use-jira/img/bug-type.png | Bin 852 -> 6043 bytes src/tutorials/how-to-use-jira/img/story-type.png | Bin 1063 -> 7195 bytes .../how-to-use-jira/img/sub-task-type.png | Bin 1479 -> 8743 bytes src/tutorials/how-to-use-jira/introduction.md | 6 ++-- 8 files changed, 38 insertions(+), 26 deletions(-) delete mode 100644 src/tutorials/how-to-use-jira/img/activiry-comments.png create mode 100644 src/tutorials/how-to-use-jira/img/activity-comments.png (limited to 'src/tutorials') diff --git a/src/tutorials/how-to-use-jira/cards.md b/src/tutorials/how-to-use-jira/cards.md index 72205c6..12dd7b8 100644 --- a/src/tutorials/how-to-use-jira/cards.md +++ b/src/tutorials/how-to-use-jira/cards.md @@ -1,22 +1,22 @@ # How to use Jira - Cards -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 12 September 2020** [`<<`](./introduction.html) || [`< Filters`](./filters.html) || [`Projects >`](./projects.html) --- -**Each issue is represented as a 'card' with a couple of different properties**. - -## Properties +**Each issue is represented as an object with properties**. More specifically, these objects are called 'cards'. ![](./img/kanban-cards.png) +## Properties + Each card has the following properties: ![](./img/fields-cards.png) -- **Project** - the [project](./projects.html) this card is stored in (defaults to currently open one) +- **Project** - the [project](./projects.html) this card is stored in ![](./img/project-create-card.png) @@ -24,7 +24,7 @@ Each card has the following properties: ![](./img/issue-types.png) - - ![Story](./img/story-type.png) - 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" + - ![Story](./img/story-type.png) - functionality or feature expressed as a goal, something like "As a user, I want to be able to pay for my order via PayPal" - ![Bug](./img/bug-type.png) - a problem/error @@ -34,7 +34,7 @@ Each card has the following properties: - ![Sub-task](./img/sub-task-type.png) - 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 +- **Summary** - a (required) brief explanation of the issue ![](./img/summary-create-card.png) @@ -46,11 +46,11 @@ Each card has the following properties: ![](./img/reporter-create-card.png) -- **Assignee** - person who works on the issue +- **Assignee** - person who will work on the issue ![](./img/assignee-create-card.png) -- **Labels** - tags with which you can organise even more different issues +- **Labels** - tags with which you can organise even more the issue ![](./img/label-create-card.png) @@ -78,7 +78,7 @@ By default, opening a card presents, at the top, it's **key** (think of it as an ![](./img/card-key.png) -it's **summary**, +it's **summary** below it, ![](./img/card-summary.png) @@ -86,15 +86,15 @@ options for adding **attachments**, **subtasks**, **linking issues** and **addin ![](./img/card-attach-subtask.png) -following are the **description**, **actual attachments**, **subtasks**, **linked issues**, ..., +following are the **description**, **actual attachments**, **subtasks**, **linked issues**, etc., ![](./img/desc-att-sub-link.png) -and at the bottom you have the **activity**, consisting of **comments**, +and at the bottom you have the **activity**, consisting of **comments** on the issue, ![](./img/activity-comments.png) -**history**, +**history** of things that have happened to that issue, ![](./img/activity-history.png) @@ -102,7 +102,9 @@ and **work logs** (a bit later we talk about them in more detail). ![](./img/activity-work-log.png) -To the right side, you have all of the different **properties** (some fields that have no value will be hidden). +### Right side + +To the right side, you have all of the different **properties** (some fields without a value will be hidden). ![](./img/card-right-side.png) @@ -116,7 +118,9 @@ On the top right you can change **watch options** ([watching an issue](https://w 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**. +### 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. @@ -124,10 +128,14 @@ In the `Log work` screen, you'll be met with a `Time spent` and `Time remaining` 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. ![](./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 [here](https://confluence.atlassian.com/adminjiracloud/changing-a-field-configuration-844500798.html). ![](./img/time-and-configure.png) diff --git a/src/tutorials/how-to-use-jira/filters.md b/src/tutorials/how-to-use-jira/filters.md index a179c88..4c2a839 100644 --- a/src/tutorials/how-to-use-jira/filters.md +++ b/src/tutorials/how-to-use-jira/filters.md @@ -1,33 +1,37 @@ # How to use Jira - Filters -**Article Created: 23 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 23 July 2020** || **Last Edited: 11 September 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. +**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. ![](./img/filters-advanced-issue-search.png) +## Criteria + From here you can see some criteria: `Project`, `Type`, `Status`, `Assignee`. ![](./img/criteria-advanced-issue-search.png) -You can choose different options and limit what issues are shown. There are also other criteria that you can access from the `+ More` menu. +Clicking on the criteria will reveal what options you can choose for it. Access to more criteria can be obtained via the `+ More` menu. ![](./img/plus-more-advanced-issue-search.png) -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. +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. -![](./img/save-as-filters-advanced-issue-search.png) +![](./img/save-as-advanced-issue-search.png) ![](./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. +You can view all of your filters from the conveniently named `View all filters` option in the `Filters` menu. ![](./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 [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/img/activiry-comments.png b/src/tutorials/how-to-use-jira/img/activiry-comments.png deleted file mode 100644 index 59bc420..0000000 Binary files a/src/tutorials/how-to-use-jira/img/activiry-comments.png and /dev/null differ diff --git a/src/tutorials/how-to-use-jira/img/activity-comments.png b/src/tutorials/how-to-use-jira/img/activity-comments.png new file mode 100644 index 0000000..59bc420 Binary files /dev/null and b/src/tutorials/how-to-use-jira/img/activity-comments.png differ diff --git a/src/tutorials/how-to-use-jira/img/bug-type.png b/src/tutorials/how-to-use-jira/img/bug-type.png index 8a60adc..49dbbf9 100644 Binary files a/src/tutorials/how-to-use-jira/img/bug-type.png and b/src/tutorials/how-to-use-jira/img/bug-type.png differ diff --git a/src/tutorials/how-to-use-jira/img/story-type.png b/src/tutorials/how-to-use-jira/img/story-type.png index b68f4aa..33b76fa 100644 Binary files a/src/tutorials/how-to-use-jira/img/story-type.png and b/src/tutorials/how-to-use-jira/img/story-type.png differ 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 index 606bd5c..65fb485 100644 Binary files a/src/tutorials/how-to-use-jira/img/sub-task-type.png and b/src/tutorials/how-to-use-jira/img/sub-task-type.png differ diff --git a/src/tutorials/how-to-use-jira/introduction.md b/src/tutorials/how-to-use-jira/introduction.md index 076c596..1b966b6 100644 --- a/src/tutorials/how-to-use-jira/introduction.md +++ b/src/tutorials/how-to-use-jira/introduction.md @@ -1,6 +1,6 @@ # How to use Jira - Introduction -**Article Created: 23 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 23 July 2020** || **Last Edited: 11 September 2020** [`Filters >`](./filters.html) @@ -8,9 +8,9 @@ [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. +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**: some stuff might only be doable from a project administrator, meaning you might not have persmission to do some things +**Note**: certain actions can be done only from a project administrator ## Contents -- cgit v1.3.1-23-gd82d