Skip to content

Commit ca756a7

Browse files
authored
chore(docs): Minor formatting upates
1 parent 6a6611c commit ca756a7

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ features like issue creation, cloning, linking, ticket transition, and much more
6060
> This tool is heavily inspired by the [GitHub CLI](https://github.com/cli/cli)
6161
6262
## Supported platforms
63-
Note that some features might work slightly differently in cloud installation versus on-premise installation due to the
63+
> [!NOTE]
64+
> Some features might work slightly differently in cloud installation versus on-premise installation due to the
6465
nature of the data. Yet, we've attempted to make the experience as similar as possible.
6566

6667
| Platform | <a href="#"><img alt="Linux" src="https://img.shields.io/badge/Linux-%E2%9C%93-dark--green?logo=linux&logoColor=white&style=flat-square" /></a><a href="#"><img alt="macOS" src="https://img.shields.io/badge/macOS-%E2%9C%93-dark--green?logo=apple&style=flat-square" /></a><a href="#"><img alt="FreeBSD" src="https://img.shields.io/badge/FreeBSD-%E2%9C%93-dark--green?logo=freebsd&style=flat-square" /></a><a href="#"><img alt="NetBSD" src="https://img.shields.io/badge/NetBSD-%E2%9C%93-dark--green?logo=netbsd&logoColor=white&style=flat-square" /></a><a href="#"><img alt="Windows" src="https://img.shields.io/badge/Windows-partial-yellow?logo=windows&style=flat-square" /></a> |
@@ -104,7 +105,8 @@ Follow the [installation guide](https://github.com/ankitpokhrel/jira-cli/wiki/In
104105
(username and password), select the `basic` auth type.
105106
- If you want to use `mtls` (client certificates), select auth type `mtls` and provide the CA Cert, client Key, and client cert.
106107

107-
**Note:** If your on-premise Jira installation is using a language other than `English`, then the issue/epic creation
108+
> [!IMPORTANT]
109+
> If your on-premise Jira installation is using a language other than `English`, then the issue/epic creation
108110
may not work because the older version of Jira API doesn't return the untranslated name for `issuetypes`. In that case,
109111
you will have to fill in `epic.name`, `epic.link` and `issue.types.*.handle` fields manually in the generated config
110112
to get the expected behavior.
@@ -152,7 +154,8 @@ The lists are displayed in an interactive UI by default.
152154
- [Introduction and Motivation](https://medium.com/@ankitpokhrel/introducing-jira-cli-the-missing-command-line-tool-for-atlassian-jira-fe44982cc1de)
153155
- [Getting Started with JiraCLI](https://www.mslinn.com/blog/2022/08/12/jiracli.html)
154156

155-
> Like the tool? Checkout [similar tool but for Shopify!](https://github.com/ankitpokhrel/shopctl)
157+
> [!TIP]
158+
> Like this tool? Checkout [similar tool for Shopify!](https://github.com/ankitpokhrel/shopctl)
156159
157160
## Commands
158161
### Issue
@@ -506,7 +509,8 @@ $ jira issue comment add ISSUE-1 --template -
506509
$ echo "Comment from stdin" | jira issue comment add ISSUE-1
507510
```
508511

509-
Note: For the comment body, the positional argument always takes precedence over the `--template` flag if both of them are passed. In the
512+
> [!NOTE]
513+
> For the comment body, the positional argument always takes precedence over the `--template` flag if both of them are passed. In the
510514
example below, the body will be picked from positional argument instead of the template.
511515
```sh
512516
jira issue comment add ISSUE-42 "comment body positional" --template - <<'EOF'

0 commit comments

Comments
 (0)