From ef82022740c2466783c31dc613a3270e50ec120c Mon Sep 17 00:00:00 2001 From: Thomas Fossati Date: Sun, 10 Sep 2023 21:31:15 +0200 Subject: [PATCH] Add a ref to the API token creation docs Point to the relevant documentation on the Atlassian website where they explain how to create API tokens. Fix #76 Signed-off-by: Thomas Fossati --- docs/config.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index f9c45d3..aad965a 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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. @@ -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