From 3d47038154734eaf4be1ab07f0c38093d7306537 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Mon, 6 Mar 2023 11:50:01 +0800 Subject: [PATCH 01/13] Add documentation for atlassian confluence --- .../configuring-atlassian-confluence.md | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md new file mode 100644 index 000000000000..58fb64e717da --- /dev/null +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -0,0 +1,52 @@ +--- +description: Configuration page for Atlassian Confluence. +--- + +# Configuring Atlassian Confluence + +{% hint style="info" %} +Dispatch ships with Atlassian Confluence storage and document plugin. This page descirbes the available configurations for the plugins. +{% endhint %} + +## Dispatch Configuration Variables for storage plugin + +### `API URL` \[Required\] + +> URL of the confluence cloud instance. + +### `Username` \[Required\] + +> Username for accessing the confluence instance, this user should have permission to create pages in the space. + +### `Password` \[Required\] + +> API token to access the confluence instance, please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. + +### `Incident template ID` \[Required\] + +> This is the page id of the template that contains the post incident review document details. Plugin uses this template to create new page and then replace the supported variables with the incident details. + + +### `Default Space ID` \[Required\] + +> This is the default space [key](https://confluence.atlassian.com/doc/space-keys-829076188.html) where all the pages will be created in confluence. + +### `Parent ID of the pages` \[Required\] + +> This is the page id, where all the new pages and subpages will be created. + + +## Dispatch Configuration Variables for document plugin + + +### `API URL` \[Required\] + +> URL of the confluence cloud instance. + +### `Username` \[Required\] + +> Username for accessing the confluence instance, this user should have permission to create pages in the space. + +### `Password` \[Required\] + +> API token to access the confluence instance, please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. From 2e5972ea67619055a616b06b6f0a44052753aa04 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Mon, 6 Mar 2023 11:52:23 +0800 Subject: [PATCH 02/13] Fix typo --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 58fb64e717da..d9640b1178f7 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -5,7 +5,7 @@ description: Configuration page for Atlassian Confluence. # Configuring Atlassian Confluence {% hint style="info" %} -Dispatch ships with Atlassian Confluence storage and document plugin. This page descirbes the available configurations for the plugins. +Dispatch ships with Atlassian Confluence storage and document plugin. This page describes the available configurations for the plugins. {% endhint %} ## Dispatch Configuration Variables for storage plugin From 5664434649956a048688f3acd2ca172dc4794408 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:14:23 +0800 Subject: [PATCH 03/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index d9640b1178f7..5e2240513222 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -5,7 +5,7 @@ description: Configuration page for Atlassian Confluence. # Configuring Atlassian Confluence {% hint style="info" %} -Dispatch ships with Atlassian Confluence storage and document plugin. This page describes the available configurations for the plugins. +Dispatch ships with Atlassian Confluence storage and document plugins. This page describes the available configurations for the plugins. {% endhint %} ## Dispatch Configuration Variables for storage plugin From 222b28098e11a74f16511e780bbf1b33dad4c7d4 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:14:36 +0800 Subject: [PATCH 04/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 5e2240513222..af687d7ec9eb 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -8,7 +8,7 @@ description: Configuration page for Atlassian Confluence. Dispatch ships with Atlassian Confluence storage and document plugins. This page describes the available configurations for the plugins. {% endhint %} -## Dispatch Configuration Variables for storage plugin +## Dispatch configuration variables for storage plugin ### `API URL` \[Required\] From 3fc0c006899041cc13d122e501a93df23e53544e Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:14:53 +0800 Subject: [PATCH 05/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index af687d7ec9eb..0f7271f2a0bd 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -16,7 +16,7 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ### `Username` \[Required\] -> Username for accessing the confluence instance, this user should have permission to create pages in the space. +> Username for accessing the confluence instance. This user should have permission to create pages in the space. ### `Password` \[Required\] From d40642421b4d99f8b4b90a99779051ca7f5b79b8 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:15:41 +0800 Subject: [PATCH 06/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 0f7271f2a0bd..34c05c07d5fe 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -20,7 +20,7 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ### `Password` \[Required\] -> API token to access the confluence instance, please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. +> API token to access the confluence instance. Please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. ### `Incident template ID` \[Required\] From 1e94ffed659624f9ea6453886c16a63cb0451ba2 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:15:49 +0800 Subject: [PATCH 07/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 34c05c07d5fe..0f54975c06d2 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -26,7 +26,6 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page > This is the page id of the template that contains the post incident review document details. Plugin uses this template to create new page and then replace the supported variables with the incident details. - ### `Default Space ID` \[Required\] > This is the default space [key](https://confluence.atlassian.com/doc/space-keys-829076188.html) where all the pages will be created in confluence. From a0201842c4b89f97e6fe39c423250feb65062b31 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:15:58 +0800 Subject: [PATCH 08/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 0f54975c06d2..0be7cc402065 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -24,7 +24,7 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ### `Incident template ID` \[Required\] -> This is the page id of the template that contains the post incident review document details. Plugin uses this template to create new page and then replace the supported variables with the incident details. +> This is the page id of the template that contains the post incident review document details. The plugin uses this template to create a new page and then replace the supported variables with the incident details. ### `Default Space ID` \[Required\] From 14dbc6de8b65dc3e02addc3dedb86286a1a14ab5 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:16:06 +0800 Subject: [PATCH 09/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 0be7cc402065..dfbe5440a89b 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -34,7 +34,6 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page > This is the page id, where all the new pages and subpages will be created. - ## Dispatch Configuration Variables for document plugin From 2056fad0715afaee8c091be15c7546f923aeb222 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:16:14 +0800 Subject: [PATCH 10/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index dfbe5440a89b..efdb3dc0b8a1 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -36,7 +36,6 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ## Dispatch Configuration Variables for document plugin - ### `API URL` \[Required\] > URL of the confluence cloud instance. From f50696303a9608eebc56fbe4b1b7f10f61095e07 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:16:19 +0800 Subject: [PATCH 11/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index efdb3dc0b8a1..551e8669f399 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -42,7 +42,7 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ### `Username` \[Required\] -> Username for accessing the confluence instance, this user should have permission to create pages in the space. +> Username for accessing the confluence instance. This user should have permission to create pages in the space. ### `Password` \[Required\] From 0358e66505bf0d568760d735c14cc5506db0fa7a Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:16:27 +0800 Subject: [PATCH 12/13] Update docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md Co-authored-by: Marc Vilanova <39573146+mvilanova@users.noreply.github.com> --- .../administration/plugins/configuring-atlassian-confluence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md index 551e8669f399..a219c06e0201 100644 --- a/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md +++ b/docs/admin-guide/administration/plugins/configuring-atlassian-confluence.md @@ -46,4 +46,4 @@ Dispatch ships with Atlassian Confluence storage and document plugins. This page ### `Password` \[Required\] -> API token to access the confluence instance, please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. +> API token to access the confluence instance. Please refer to the [link](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) on creating a new API token. From 318e306b3aa63ee50ff1edd6ef2422a86683f1d2 Mon Sep 17 00:00:00 2001 From: Cino Jose Date: Tue, 7 Mar 2023 17:21:46 +0800 Subject: [PATCH 13/13] Add entry for Confluence in Summary Doc --- docs/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 56f6a4314bfb..cc463dd7421c 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -11,6 +11,7 @@ - [Configuring PagerDuty](admin-guide/administration/plugins/configuring-pagerduty.md) - [Configuring Slack](admin-guide/administration/plugins/configuring-slack.md) - [Configuring Zoom](admin-guide/administration/plugins/configuring-zoom.md) + - [Configuring Atlassian Confluence](admin-guide/administration/plugins/configuring-atlassian-confluence.md) - [Templates](admin-guide/administration/templates.md) - [Contacts](admin-guide/administration/contact/README.md) - [Services](admin-guide/administration/contact/service.md)