Skip to content

Commit

Permalink
Add a ref to the API token creation docs
Browse files Browse the repository at this point in the history
Point to the relevant documentation on the Atlassian website where they explain
how to create API tokens.

Fix #76

Signed-off-by: Thomas Fossati <thomas.fossati@linaro.org>
  • Loading branch information
thomas-fossati authored and roxell committed Sep 14, 2023
1 parent 7b85250 commit eb3fd7d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ Jira server, and jipdate supports password based authentication, as well as
token based. Using token authentication is considered more secure than
password. The `server` configuration must include at least an `url` attribute. A
`token` attribute can be added optionally.
To create an API token, follow the procedure described in the `Atlassian
documentation`_.

When the `token` attribute is present, Jipdate will use token based
authentication. Otherwise, it will use password based authentication.
Expand Down Expand Up @@ -294,3 +296,4 @@ stored here, then jipdate won't ask for it when running the script.


.. _YAML format: https://yaml.org/spec/1.2/spec.html
.. _Atlassian documentation: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token

0 comments on commit eb3fd7d

Please sign in to comment.