diff --git a/website/docs/integrations/jira.mdx b/website/docs/integrations/jira.mdx index 77b52fc57..a09396111 100644 --- a/website/docs/integrations/jira.mdx +++ b/website/docs/integrations/jira.mdx @@ -1,16 +1,16 @@ --- id: jira -title: Jira Cloud Plugin - Manage feature flags from Jira -description: ConfigCat Jira Cloud Plugin. This is a step-by-step guide on how to connect and manage feature flags from Jira Cloud boards. +title: Jira Cloud App - Manage feature flags from Jira +description: ConfigCat Jira Cloud App. This is a step-by-step guide on how to connect and manage feature flags from Jira Cloud boards. --- -import { Steps, Step, Title } from '@site/src/components/Steps'; +import { Steps, Step} from '@site/src/components/Steps'; -The ConfigCat Feature Flags Jira Cloud Plugin allows you to connect your Jira Issues and feature flags. Create or link existing flags to your Jira issues without leaving your Jira instance. +The ConfigCat Feature Flags Jira Cloud App allows you to connect your Jira Issues and feature flags. Create or link existing flags to your Jira issues without leaving your Jira instance. Turn features On/Off right from a linked Issue on your Jira board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules. -This guide will help you with the plugin installation and familiarise you with the plugin usage. +This guide will help you with the app installation and familiarise you with the app usage. :::info This integration is for Jira Cloud. It does not work on Jira Data Center or Jira Server instances. @@ -29,186 +29,224 @@ The new version of the app will be available before the Connect Framework's EOS. ### Migration steps To complete the migration, you may have to do the following steps. - -Update the app to the latest version in Jira. - - -Re-authorize in ConfigCat if required. - + + Update the app to the latest version in Jira. + + + Re-authorize in ConfigCat if required. + ### Update the app in Jira If the app is not updated automatically. - -Navigate to your Jira instance's app management page. - - -Search for "ConfigCat Feature Flags". - - -Update the app to the latest version by hand. - + + Navigate to your Jira instance's app management page. + + + Search for "ConfigCat Feature Flags". + + + Update the app to the latest version by hand. + ## Installation - -Add ConfigCat Feature Flags to your Jira Cloud instance. - - -Select **Configure**. - - -Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. - - -Click **Authorize**. + + Add ConfigCat Feature Flags to your Jira Cloud instance. + + + +## Configuration +### Authorization + + + Navigate to any Issue on your Jira board. + + + Open the **ConfigCat Feature Flags** Issue Panel or the **ConfigCat Feature Flags** Issue Context section. + + + Click **Authorize**. + + + Follow the Atlassian authorization steps to authorize ConfigCat in Jira. Click **Configure access**. + + + In the opened window, inspect the required access by ConfigCat and click **Continue**. + + + In the ConfigCat authorization window, click the **Allow Access** button to complete the authorization. + + + After successful authorization, you will be redirected back to the Issue. + + :::info -Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin. +Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags App. ::: +### Revoke Authorization + + + Navigate to **Account Settings** in Jira. + + + Select the **Connected Apps** tab. + + + In the **Atlassian third party account access** section, click **Revoke** next to ConfigCat. + + + +### Enable ConfigCat Feature Flags Issue Panel + + + Navigate to any Issue on your Jira board. + + + If the **ConfigCat Feature Flags** Issue Panel is not visible, click the **View app actions** button under the Issue summary, and select **ConfigCat Feature Flags** in the dropdown. + + + Admins can enable the **ConfigCat Feature Flags** Issue Panel for all users in the project. To do this, select the **Show for all work items** option in the panel **Actions** menu. + + + - - ## Usage ### Linking existing feature flags - -Navigate to any Issue on your Jira board. - - -Open the **ConfigCat Feature Flag** issue context. - - -On the **Link existing** tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue. - - -When linked, you can manage the selected feature flag from this Issue. - - - - + + Navigate to any Issue on your Jira board. + + + Open the **ConfigCat Feature Flags** issue context. + + + On the **Link existing** tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue. + + + When linked, you can manage the selected feature flag from this Issue. + + + + ### Creating new feature flags - -Navigate to any Issue on your Jira board. - - -Open the **ConfigCat Feature Flag** issue context. - - -On the **Create and Link** tab, select a ConfigCat Product and Config where you want to create the feature flag. - - -Set up your feature flag. - - -Select which environment you would like to link to this item. - - -When linked, you can manage the selected feature flag from this Issue. - - - + + Navigate to any Issue on your Jira board. + + + Open the **ConfigCat Feature Flags** issue context. + + + On the **Create and Link** tab, select a ConfigCat Product and Config where you want to create the feature flag. + + + Set up your feature flag. + + + Select which environment you would like to link to this item. + + + When linked, you can manage the selected feature flag from this Issue. + + + ### View and Edit linked feature flags - -Open an Issue on your Jira board with a linked feature flag. - - -See the linked feature flags in the **Feature Flag (ConfigCat)** issue section. - - -You can manage the selected feature flag from this Issue. - - -You can add new Targeting Rules or Percentage Options to Feature Flags. - - -You can add new Targeting Rules with User, Segment or Prerequisite Conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx) - - -You can remove Targeting Rules as well. - - - + + Open an Issue on your Jira board with a linked feature flag. + + + See the linked feature flags in the **ConfigCat Feature Flags** issue section. + + + You can manage the selected feature flag from this Issue. + + + You can add new Targeting Rules or Percentage Options to Feature Flags. + + + You can add new Targeting Rules with User, Segment or Prerequisite Conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx) + + + You can remove Targeting Rules as well. + + + ### Remove linked feature flags - -Open an Issue on your Jira board with a linked feature flag. - - -Remove the linked feature flag by opening the **More menu** and selecting the **Remove from Issue** option. - - - + + Open an Issue on your Jira board with a linked feature flag. + + + Remove the linked feature flag by opening the **More menu** and selecting the **Remove from Issue** option. + + + ### View flag status in Releases - -Open an Issue on your Jira board with a linked feature flag. - - -Check the **Releases** field values in the issue **Details** section to see the linked feature flags status in the Issue. - - -Click it for a more detailed dialog. - - - + + Open an Issue on your Jira board with a linked feature flag. + + + Check the **Releases** field values in the issue **Development** section to see the linked feature flags status in the Issue. + + + Click it for a more detailed dialog. + + + - -Open a version in the Jira project's Release Hub page to see the related issues feature flag status. - - -Click it for a more detailed dialog. - - - + + Open a version in the Jira project's Release Hub page to see the related issues feature flag status. + + + Click it for a more detailed dialog. + :::info -This plugin doesn't implement the **Releases - Create/Connect feature flag** action. Instead, you can create or link +This app doesn't implement the **Releases - Create/Connect feature flag** action. Instead, you can create or link feature flags from the ConfigCat Feature Flags section below the Details section of the Issue. ::: diff --git a/website/docs/integrations/overview.mdx b/website/docs/integrations/overview.mdx index 113fca178..2bcb739c9 100644 --- a/website/docs/integrations/overview.mdx +++ b/website/docs/integrations/overview.mdx @@ -63,7 +63,7 @@ Streamline your workflows by integrating ConfigCat with your essential tools and
-
Jira Cloud Plugin
+
Jira Cloud App
Link ConfigCat feature flags to Jira issues, enabling you to turn features on or off, add targeting or percentage rules right from Jira. diff --git a/website/sidebars.ts b/website/sidebars.ts index 1a495db72..49524e817 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -427,7 +427,7 @@ const integrations: SidebarConfig = [ { type: 'doc', id: 'integrations/jira', - label: 'Jira Cloud Plugin', + label: 'Jira Cloud App', }, { type: 'doc', id: 'integrations/monday', label: 'monday.com' }, { diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 39ac42eaa..e55d73602 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -164,7 +164,7 @@ const features = [ { url: 'integrations/google-analytics', title: 'Google Analytics' }, { url: 'advanced/code-references/gitlab-ci/', title: 'GitLab (via CLI)' }, { url: 'integrations/intellij', title: 'JetBrains/IntelliJ IDE' }, - { url: 'integrations/jira', title: 'Jira Cloud Plugin' }, + { url: 'integrations/jira', title: 'Jira Cloud App' }, { url: 'advanced/notifications-webhooks#connecting-to-microsoft-teams', title: 'MS Teams (via webhook)', diff --git a/website/static/assets/jira/auth.mp4 b/website/static/assets/jira/auth.mp4 deleted file mode 100644 index 3e43805e4..000000000 Binary files a/website/static/assets/jira/auth.mp4 and /dev/null differ diff --git a/website/static/assets/jira/authorize-configcat.mp4 b/website/static/assets/jira/authorize-configcat.mp4 new file mode 100644 index 000000000..b26de5b14 Binary files /dev/null and b/website/static/assets/jira/authorize-configcat.mp4 differ diff --git a/website/static/assets/jira/create-and-link.mp4 b/website/static/assets/jira/create-and-link.mp4 new file mode 100644 index 000000000..834207524 Binary files /dev/null and b/website/static/assets/jira/create-and-link.mp4 differ diff --git a/website/static/assets/jira/create-link.mp4 b/website/static/assets/jira/create-link.mp4 deleted file mode 100644 index 2249df177..000000000 Binary files a/website/static/assets/jira/create-link.mp4 and /dev/null differ diff --git a/website/static/assets/jira/edit-ff.mp4 b/website/static/assets/jira/edit-ff.mp4 index 3c35a7a9a..da5df0bfa 100644 Binary files a/website/static/assets/jira/edit-ff.mp4 and b/website/static/assets/jira/edit-ff.mp4 differ diff --git a/website/static/assets/jira/jira-development-view.mp4 b/website/static/assets/jira/jira-development-view.mp4 new file mode 100644 index 000000000..c9b46f513 Binary files /dev/null and b/website/static/assets/jira/jira-development-view.mp4 differ diff --git a/website/static/assets/jira/link-existing.mp4 b/website/static/assets/jira/link-existing.mp4 index baf77d5c5..a4fa92fca 100644 Binary files a/website/static/assets/jira/link-existing.mp4 and b/website/static/assets/jira/link-existing.mp4 differ diff --git a/website/static/assets/jira/open-from-dashboard.mp4 b/website/static/assets/jira/open-from-dashboard.mp4 index 938aaf83f..e9846f556 100644 Binary files a/website/static/assets/jira/open-from-dashboard.mp4 and b/website/static/assets/jira/open-from-dashboard.mp4 differ diff --git a/website/static/assets/jira/release-field.mp4 b/website/static/assets/jira/release-field.mp4 deleted file mode 100644 index 7cc4f9d07..000000000 Binary files a/website/static/assets/jira/release-field.mp4 and /dev/null differ diff --git a/website/static/assets/jira/release-hub.mp4 b/website/static/assets/jira/release-hub.mp4 deleted file mode 100644 index c9c4e4082..000000000 Binary files a/website/static/assets/jira/release-hub.mp4 and /dev/null differ diff --git a/website/static/assets/jira/remove-ff.mp4 b/website/static/assets/jira/remove-ff.mp4 index 62c053b89..276a993ac 100644 Binary files a/website/static/assets/jira/remove-ff.mp4 and b/website/static/assets/jira/remove-ff.mp4 differ diff --git a/website/versioned_docs/version-V1/integrations/jira.mdx b/website/versioned_docs/version-V1/integrations/jira.mdx index 1b0a54960..8bcbad479 100644 --- a/website/versioned_docs/version-V1/integrations/jira.mdx +++ b/website/versioned_docs/version-V1/integrations/jira.mdx @@ -1,14 +1,14 @@ --- id: jira -title: Jira Cloud Plugin - Manage feature flags from Jira -description: ConfigCat Jira Cloud Plugin. This is a step-by-step guide on how to connect and manage feature flags from Jira Cloud boards. +title: Jira Cloud App - Manage feature flags from Jira +description: ConfigCat Jira Cloud App. This is a step-by-step guide on how to connect and manage feature flags from Jira Cloud boards. --- -The ConfigCat Feature Flags Jira Cloud Plugin allows you to connect your Jira Issues and feature flags. Create or link existing flags to your Jira issues without leaving your Jira instance. +The ConfigCat Feature Flags Jira Cloud App allows you to connect your Jira Issues and feature flags. Create or link existing flags to your Jira issues without leaving your Jira instance. Turn features On/Off right from a linked Issue on your Jira board. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules. -This guide will help you with the plugin installation and familiarise you with the plugin usage. +This guide will help you with the app installation and familiarise you with the app usage. :::info This integration is for Jira Cloud. It does not work on Jira Data Center or Jira Server instances. @@ -43,10 +43,10 @@ If the app is not updated automatically. 4. Click authorize. :::info -Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin. +Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags App. ::: -Installation of the ConfigCat Feature Flags Jira Cloud Plugin +Installation of the ConfigCat Feature Flags Jira Cloud App ## Usage @@ -57,7 +57,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat 3. On the `Link existing` tab select a ConfigCat Product, Config, Environment and a Feature Flag to be linked to your Issue. 4. When linked, you can manage the selected feature flag from this Issue. -Linking existing feature flags in Jira Cloud Plugin +Linking existing feature flags in Jira Cloud App ### Creating new feature flags @@ -69,7 +69,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat 5. Select which environment you would like to link to this item. 6. When linked, you can manage the selected feature flag from this Issue. -Create feature flags in Jira Cloud Plugin +Create feature flags in Jira Cloud App ### View and Edit linked feature flags @@ -80,14 +80,14 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat 5. You can remove Targeting Rules as well. 6. To see the feature flag on the ConfigCat Dashboard just use the `Open in ConfigCat` link. -View and Edit linked feature flags in Jira Cloud Plugin +View and Edit linked feature flags in Jira Cloud App ### Remove linked feature flags 1. Open an Issue on your Jira board with a linked feature flag. 2. Remove the linked feature flag by clicking the red X in the top right corner. -Remove linked feature flags in Jira Cloud Plugin +Remove linked feature flags in Jira Cloud App ### View flag status in Releases @@ -104,7 +104,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat :::info -This plugin doesn't implement the **Releases - Create/Connect feature flag** action. Instead, you can create or link +This app doesn't implement the **Releases - Create/Connect feature flag** action. Instead, you can create or link feature flags from the ConfigCat Feature Flags section below the Details section of the Issue. ::: diff --git a/website/versioned_docs/version-V1/integrations/overview.mdx b/website/versioned_docs/version-V1/integrations/overview.mdx index 218e3308d..3b4a32f99 100644 --- a/website/versioned_docs/version-V1/integrations/overview.mdx +++ b/website/versioned_docs/version-V1/integrations/overview.mdx @@ -62,7 +62,7 @@ Streamline your workflows by integrating ConfigCat with your essential tools and
-
Jira Cloud Plugin
+
Jira Cloud App
Link ConfigCat feature flags to Jira issues, enabling you to turn features on or off, add targeting or percentage rules right from Jira. diff --git a/website/versioned_sidebars/version-V1-sidebars.json b/website/versioned_sidebars/version-V1-sidebars.json index 9ad9cbf33..62ace4d46 100644 --- a/website/versioned_sidebars/version-V1-sidebars.json +++ b/website/versioned_sidebars/version-V1-sidebars.json @@ -521,7 +521,7 @@ { "type": "doc", "id": "integrations/jira", - "label": "Jira Cloud Plugin" + "label": "Jira Cloud App" }, { "type": "doc",