From 310a9bca6eaac920c0a96d20f4f0d604a9afd0d9 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Wed, 16 Sep 2020 08:40:39 +0300 Subject: Improved wording, format and errors in the rest of how to use jira tutorial pages --- src/tutorials/how-to-use-jira/bug.md | 9 ++++--- src/tutorials/how-to-use-jira/components.md | 16 +++++------ src/tutorials/how-to-use-jira/dashboards.md | 16 +++++------ .../how-to-use-jira/img/add-gadet-top.png | Bin 19358 -> 0 bytes .../how-to-use-jira/img/add-gadget-top.png | Bin 0 -> 19358 bytes src/tutorials/how-to-use-jira/kanban.md | 30 ++++++++------------- src/tutorials/how-to-use-jira/pages.md | 11 ++++---- src/tutorials/how-to-use-jira/releases.md | 8 +++--- src/tutorials/how-to-use-jira/scrum.md | 27 +++++++++---------- 9 files changed, 54 insertions(+), 63 deletions(-) delete mode 100644 src/tutorials/how-to-use-jira/img/add-gadet-top.png create mode 100644 src/tutorials/how-to-use-jira/img/add-gadget-top.png (limited to 'src/tutorials') diff --git a/src/tutorials/how-to-use-jira/bug.md b/src/tutorials/how-to-use-jira/bug.md index 7c3eeea..5038e04 100644 --- a/src/tutorials/how-to-use-jira/bug.md +++ b/src/tutorials/how-to-use-jira/bug.md @@ -1,17 +1,18 @@ # How to use Jira - Bug tracking template -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 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**. +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. +**There are no boards, no cards, no backlog**. All issues are accessed from the `Issues` page from the sidebar. ![](./img/issues-sidebar.png) 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. +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/components.md b/src/tutorials/how-to-use-jira/components.md index fd582c6..e4ed20e 100644 --- a/src/tutorials/how-to-use-jira/components.md +++ b/src/tutorials/how-to-use-jira/components.md @@ -1,40 +1,40 @@ # How to use Jira - Components -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 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. +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 components is done from the **`Components` menu in the sidebar**. +Creating and editing them is done from the **`Components` menu in the sidebar**. ![](./img/components-sidebar.png) -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`. +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`. ![](./img/create-component-empty.png) ![](./img/create-component-full.png) -Clicking on it presents you with a screen where you type the block's information. +Clicking on it presents you with a screen where you input it's information. ![](./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 in this component**. +**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 an issue** or **when viewing it**. +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`. ![](./img/components-create-card.png) -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`). +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`). ![](./img/show-fields.png) diff --git a/src/tutorials/how-to-use-jira/dashboards.md b/src/tutorials/how-to-use-jira/dashboards.md index 9b37f13..d46f45c 100644 --- a/src/tutorials/how-to-use-jira/dashboards.md +++ b/src/tutorials/how-to-use-jira/dashboards.md @@ -1,24 +1,24 @@ # How to use Jira - Dashboards -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 2020** [`<<`](./introduction.html) || [`< Components`](./components.html) --- -**Dashboards are a place where you can view a lot of information**. +Dashboards are a **place where you can view a lot of information**. ![](./img/default-dashboard.png) -**Dashboards are composed of gadgets**. +Dashboards are composed of **gadgets**. ![](./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**. +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, +Dashboard can be added from the top bar, under `Create dashboard` in the `Dashboards` menu ![](./img/create-dashboard-top.png) @@ -30,7 +30,7 @@ or, if you are already in a dashboard, from `Create dashboard` in the three dots **Note**: you cannot add gadgets to the default dashboard. -You can add gadgets either **through the `Add gadget` button in the top right**, +You can add gadgets either **through the `Add gadget` button in the top right** ![](./img/add-gadget-top.png) @@ -38,7 +38,7 @@ or, **if you don't have any gadets**, **from the `add a new gadget` message(s)** ![](./img/add-a-gadget.png) -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). +After that, you are greeted by a window that **shows all of the avalable ones** (you might need to **press `Load all gadgets`**). ![](./img/load-all.png) @@ -48,7 +48,7 @@ Adding a gadget is as simple as clicking the button `Add gadget` next to the nam ![](./img/introduction-add.png) -After it is added, you'll **need to configure it**, usually a gadget **requires a filter/project**. Other settings are different gadget to gadget. +After it is added, you'll **need to configure it**, usually a gadget **requires atleast a filter/project**. ![](./img/bubble.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 deleted file mode 100644 index 5fdd5c2..0000000 Binary files a/src/tutorials/how-to-use-jira/img/add-gadet-top.png and /dev/null differ diff --git a/src/tutorials/how-to-use-jira/img/add-gadget-top.png b/src/tutorials/how-to-use-jira/img/add-gadget-top.png new file mode 100644 index 0000000..5fdd5c2 Binary files /dev/null and b/src/tutorials/how-to-use-jira/img/add-gadget-top.png differ diff --git a/src/tutorials/how-to-use-jira/kanban.md b/src/tutorials/how-to-use-jira/kanban.md index cabf743..e043d2c 100644 --- a/src/tutorials/how-to-use-jira/kanban.md +++ b/src/tutorials/how-to-use-jira/kanban.md @@ -1,38 +1,30 @@ # How to use Jira - Kanban template -**Article Created: 23 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 23 July 2020** || **Last Edited: 16 September 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**. +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. -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 a projects that uses the kanban template, boards can access directly all of the available issues. -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). - -![](./img/backlog-kanban.png) - -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. +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 either chosen when creating a project**, +This template can be chosen when **creating a project** ![](./img/choose-classic-template.png) -or **from the `Create board` screen**. +and **from the `Create board` screen**. ![](./img/scrum-kanban-board.png) -At it's core, the kanban template **controls how board, issues and cards work together**. **Each template is tied to it's given board**. +## Backlog + +In kanban, **the backlog is just another column in your board(s)**. It can be removed entirely. + +![](./img/backlog-kanban.png) -**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 index 90fb320..b86ec56 100644 --- a/src/tutorials/how-to-use-jira/pages.md +++ b/src/tutorials/how-to-use-jira/pages.md @@ -1,17 +1,18 @@ # How to use Jira - Pages -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 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 a place for documents for your team**. The goal is to have a centralised location where everyone in your team can share knowledge. ![](./img/test-page.png) -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. +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. +**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). -**Confluence won't be covered in this tutorial**. You can read more about it from [here](). diff --git a/src/tutorials/how-to-use-jira/releases.md b/src/tutorials/how-to-use-jira/releases.md index 1720448..3c37d12 100644 --- a/src/tutorials/how-to-use-jira/releases.md +++ b/src/tutorials/how-to-use-jira/releases.md @@ -1,18 +1,18 @@ # How to use Jira - Releases -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 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**. +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 completed**. **It serves as a point in time for the development of a project**. +**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**. +When creating an issue, you can specify a version in the `Fix versions` property. ![](./img/fix-versions.png) diff --git a/src/tutorials/how-to-use-jira/scrum.md b/src/tutorials/how-to-use-jira/scrum.md index 948466a..2a5a10e 100644 --- a/src/tutorials/how-to-use-jira/scrum.md +++ b/src/tutorials/how-to-use-jira/scrum.md @@ -1,22 +1,26 @@ # How to use Jira - Scrum template -**Article Created: 24 July 2020** || **Last Edited: 10 September 2020** +**Article Created: 24 July 2020** || **Last Edited: 16 September 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**. +The scrum template is very similar to the kanban template, with one big difference: **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**. +**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 -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)**. +As we've discussed, the **backlog** is used for organising **all issues** into **sprints**. ![](./img/sample-scrum-backlog.png) -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. +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. ![](./img/versions-and-epics.png) @@ -26,24 +30,17 @@ Creating a sprint is done from the conveniently named `Create sprint` button. It ## 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. +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. ![](./img/active-sprints.png) ## Create board -**This template can be either chosen when creating a project**, +This template can be chosen when **creating a project** ![](./img/choose-classic-template.png) -or **from the `Create board` screen**. +and **from the `Create board` screen**. ![](./img/scrum-kanban-board.png) -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. -- cgit v1.3.1-23-gd82d