diff --git a/website/docs/integrations/jira.mdx b/website/docs/integrations/jira.mdx index 3826b500..3f6f0051 100644 --- a/website/docs/integrations/jira.mdx +++ b/website/docs/integrations/jira.mdx @@ -4,74 +4,90 @@ 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. --- -Turn features On / Off right from a linked Issue on your Jira board with ConfigCat Feature Flags Jira Cloud Plugin. Also you can add Targeting or Percentage Rules just as easily. +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. -## Installation +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. -Installation of the ConfigCat Feature Flags Jira Cloud Plugin +This guide will help you with the plugin installation and familiarise you with the plugin usage. + +:::info +This integration is for Jira Cloud. It does not work on Jira Data Center or Jira Server instances. +::: + +## Installation 1. Add ConfigCat Feature Flags to your Jira Cloud instance. 2. Select `Configure`. -3. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +3. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 4. Click authorize. -> Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin. +:::info +Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin. +::: + +Installation of the ConfigCat Feature Flags Jira Cloud Plugin ## Usage ### Linking existing feature flags -Linking existing feature flags in Jira Cloud Plugin +1. Navigate to any Issue on your Jira board. +2. Open the `ConfigCat Feature Flag` issue context. +3. On the `Link existing` tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue. +4. When linked, you can manage the selected feature flag from this Issue. -1. Open any Issue on your Jira board. -2. Push `Link/Create ConfigCat Feature Flag` -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 turn your features On / Off right from this Issue. +Linking existing feature flags in Jira Cloud Plugin ### Creating new feature flags -Create feature flags in Jira Cloud Plugin +1. Navigate to any Issue on your Jira board. +2. Open the `ConfigCat Feature Flag` issue context. +3. On the `Create and Link` tab, select a ConfigCat Product and Config where you want to create the feature flag. +4. Set up your feature flag. +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. -1. Open any Issue on your Jira board. -2. Push `Link/Create ConfigCat Feature Flag` -3. On the `Create and Link` tab select a ConfigCat Product, Config where you want to create the feature flag. -4. Setup your feature flag. -5. Select which environment would you like to link to this item. -6. When linked, you can turn your features On / Off right from this Issue. +Create feature flags in Jira Cloud Plugin ### View and Edit linked feature flags -View and Edit linked feature flags in Jira Cloud Plugin +1. Open an Issue on your Jira board with a linked feature flag. +2. See the linked feature flags in the `Feature Flag (ConfigCat)` issue section. +3. You can manage the selected feature flag from this Issue. +4. You can add new Percentage Options to Feature Flags or Targeting Rules. +5. 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) +6. You can remove Targeting Rules as well. -1. Open an Issue on your Jira board with linked feature flag. -2. You can see the linked feature flags in the `Feature Flag (ConfigCat)` issue section. -3. You can turn your features On / Off right from this Issue. -4. You can add new Targeting Rules, target a new segment or target a percentage of users. -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 ### Remove linked feature flags +1. Open an Issue on your Jira board with a linked feature flag. +2. Remove the linked feature flag by opening the "More menu" and selecting the "Remove from Issue" option. + Remove linked feature flags in Jira Cloud Plugin -1. Open an Issue on your Jira board with linked feature flag. -2. Remove the linked feature flag by clicking the red X in the top right corner. ### View flag status in Releases +1. Open an Issue on your Jira board with a linked feature flag. +2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue. +3. Click it for a more detailed dialog. + View feature flags in releases field -1. Open an Issue on your Jira board with linked feature flag. -2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue. -3. Click it for more detailed dialog. +1. Open a version in the Jira project's Release Hub page to see the related issues feature flag status. +2. Click it for a more detailed dialog. View feature flags in Release hub -1. Open a version in the project Release Hub to see the related issues feature flag status. -2. Click it for more detailed dialog. +:::info +This plugin 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. +::: ### View linked issues in ConfigCat -Link in Dashboard - 1. View linked issues next to your Feature Flags in ConfigCat and jump to the Jira Issue directly. + +Link in Dashboard \ No newline at end of file diff --git a/website/docs/integrations/monday.mdx b/website/docs/integrations/monday.mdx index a7821315..89bda692 100644 --- a/website/docs/integrations/monday.mdx +++ b/website/docs/integrations/monday.mdx @@ -4,39 +4,69 @@ title: monday.com - Manage feature flags from monday description: ConfigCat monday app. This is a step-by-step guide on how to connect and manage feature flags from monday.com boards and items. --- -Turn features On / Off right from a linked item on your monday.com board with the ConfigCat Feature Flags monday.com app. Also you can add targeting or percentage rules just as easily. +The ConfigCat Feature Flags monday app allows you to connect your Monday items and feature flags. Create or link existing flags to your items without leaving your monday instance. -## Installation +Turn features On/Off right from a linked item on your Monday 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. -Installation of the ConfigCat Feature Flags monday app +## Installation 1. Install ConfigCat Feature Flags monday.com app to your monday account. -2. Open one of your boards in monday and click on an item. -3. Add the ConfigCat Feature Flags monday app to your item. -4. In order to use ConfigCat Feature Flags you have to authorize first with your ConfigCat Public API credentials. -5. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +2. Open one of your boards on monday.com and click on an Item. +3. Add the ConfigCat Feature Flags monday app to your Item. +4. To use ConfigCat Feature Flags, you must first authorize it with your ConfigCat Public API credentials. +5. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 6. Click authorize. +:::info +Every monday.com user must authorize ConfigCat in monday.com who wants to use the ConfigCat Feature Flags app. +::: + +Installation of the ConfigCat Feature Flags monday app + ## Usage ### Linking existing feature flags -Linking feature flags with the ConfigCat Feature Flags monday.com app - 1. Open any item on your monday.com board. -2. Push `Link existing feature flag` -3. Select a Product, Config, Environment and a Feature Flag to be linked to your monday.com item. -4. When linked, you can turn your features On / Off right from this monday.com item. -5. View linked monday.com items next to your Feature Flags in ConfigCat and jump to the monday.com item directly. +2. Push the `Link existing feature flag`. +3. Select a Product, Config, Environment, and Feature Flag to be linked to your monday.com Item. +4. When linked, you can manage the selected feature flag from this monday.com Item. + +Linking feature flags with the ConfigCat Feature Flags monday.com app ### Creating new feature flags -Create feature flags with the ConfigCat Feature Flags monday app +1. Open any item on your monday.com board. +2. Push the `Create and link feature flag`. +3. Select a Product and Config where you want to create the feature flag. +4. Set up your feature flag. +5. Select which environment you would like to link to this Item. +6. When linked, you can manage the selected feature flag from this monday.com Item. + +Create feature flags with the ConfigCat Feature Flags monday app + +### View and Edit linked feature flags 1. Open any item on your monday.com board. -2. Push `Create and link feature flag` -3. Select a Product, Config where you want to create the feature flag. -4. Setup your feature flag. -5. Select which environment would you like to link to this item. -6. When linked, you can turn your features On / Off right from this monday.com item. -7. View linked monday.com items next to your Feature Flags in ConfigCat and jump to the monday.com item directly. +2. See the linked feature flags in the `Feature Flag (ConfigCat)` view. +3. You can manage the selected feature flag from this Item. +4. You can add new Percentage Options to Feature Flags or Targeting Rules. +5. 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) +6. You can remove Targeting Rules as well. + +View and Edit linked feature flags in monday.com app + +### Remove linked feature flags + +1. Open any item on your monday.com board with a linked feature flag. +2. Remove the linked feature flag by opening the "More menu" and selecting the "Unlink" option. + +Remove linked feature flags in monday.com app + +### View linked Items in ConfigCat + +1. View the linked Item next to your Feature Flags in ConfigCat and jump to the monday.com Item directly. + +Link in Dashboard diff --git a/website/docs/integrations/trello.mdx b/website/docs/integrations/trello.mdx index 63b5e68f..b8f30101 100644 --- a/website/docs/integrations/trello.mdx +++ b/website/docs/integrations/trello.mdx @@ -4,23 +4,67 @@ title: Trello Power-Up - Manage feature flags from Trello description: ConfigCat Trello Power-Up. This is a step-by-step guide on how to connect and manage feature flags from Trello boards and cards. --- -Turn features On / Off right from a linked Card on your Trello board with ConfigCat's Trello Power-Up. Also you can add Targeting or Percentage Rules just as easily. +The ConfigCat's Trello Power-Up allows you to connect your Trello Cards and feature flags. Create or link existing flags to your Trello cards without leaving your Trello board. -## Installation +Turn features On/Off right from a linked card on your Trello 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 power-up installation and familiarise you with the plugin usage. -Installation of the ConfigCat Feature Flags Trello Power-Up +## Installation 1. Add ConfigCat Power-Up to your board. 2. Select `Settings -> Authorize Account`. -3. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +3. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 4. Click authorize. +:::info +Every Trello user must authorize ConfigCat in Trello who wants to use the ConfigCat Feature Flags power-up. +::: + +Installation of the ConfigCat Feature Flags Trello Power-Up + ## Usage -Usage of the ConfigCat Feature Flags Trello Power-Up +### Linking existing feature flags 1. Open any Card on your Trello board. -2. Push `Link Feature Flag` -3. Select a Product, Config, Environment and a Feature Flag to be linked to your card. -4. When linked, you can turn your features On / Off right from this Card. -5. View linked Cards next to your Feature Flags in ConfigCat and jump to the Trello Card directly. +2. Push the `Link Feature Flag` button. +3. Select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Card. +4. When linked, you can manage the selected feature flag from this Card. + +Link feature flag in ConfigCat Feature Flags Trello Power-Up + +### Creating new feature flags + +1. Open any Card on your Trello board. +2. Push the `Create and Link Feature Flag` button. +3. Select a ConfigCat Product and Config where you want to create the feature flag. +4. Set up your feature flag. +5. Select which environment you would like to link to this item. +6. When linked, you can manage the selected feature flag from this Card. + +Create feature flag in ConfigCat Feature Flags Trello Power-Up + +### View and Edit linked feature flags + +1. Open a Card on your Trello board with a linked feature flag. +2. See the linked feature flags in the `Feature Flag (ConfigCat)` section. +3. You can manage the selected feature flag from this Card. +4. Add new Percentage Options to Feature Flags or Targeting Rules. +5. 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) +6. You can remove Targeting Rules as well. + +Edit feature flag in ConfigCat Feature Flags Trello Power-Up + +### Remove linked feature flags + +1. Open a Card on your Trello board with a linked feature flag. +2. Remove the linked feature flag by opening the "More menu" and selecting the "Remove from card" option. + +Remove feature flag in ConfigCat Feature Flags Trello Power-Up + +### View linked Cards in ConfigCat + +1. View linked cards next to your Feature Flags in ConfigCat and jump to the Trello card directly. + +Link in Dashboard \ No newline at end of file diff --git a/website/docs/integrations/vscode.mdx b/website/docs/integrations/vscode.mdx index 5a2d31b0..dbb3ecc7 100644 --- a/website/docs/integrations/vscode.mdx +++ b/website/docs/integrations/vscode.mdx @@ -6,11 +6,12 @@ description: ConfigCat Visual Studio Code extension. This is a step-by-step guid ConfigCat's Visual Studio Code extension to manage feature flags from Visual Studio Code. -## Feature overview +Connect your ConfigCat Product and Config to your Visual Studio Code Workspace. Find your Feature Flag's usages in your code easily. +Turn features On/Off right from VSCode. You can also easily modify the linked flags to edit or add new Targeting or Percentage Rules. -Usage of ConfigCat Feature Flags Visual Studio Code Extension +This guide will help you with the Visual Studio Code Extensions installation and familiarize you with the Extensions usage. -### List of Features +## Feature overview - Turn features On / Off right from Visual Studio Code. - Add Targeting or Percentage Rules from Visual Studio Code. @@ -22,72 +23,125 @@ description: ConfigCat Visual Studio Code extension. This is a step-by-step guid - Connect a Config to your Workspace. - Open a Config on ConfigCat Dashboard. +Usage of ConfigCat Feature Flags Visual Studio Code Extension + ## Install extension -### Visual Studio Code Marketplace +### Install from Visual Studio Code Marketplace -1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace. +1. In the Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags). 1. Click on the Install button. -1. Configure extension (see below) +1. [Configure extension](#configure-extension). -### or within Visual Studio Code +### Install within Visual Studio Code -1. Search for ConfigCat Feature Flags at the Extensions page. +1. In Visual Studio Code, open the Extensions page, and search for ConfigCat Feature Flags. 1. Click on the Install button. -1. Configure extension (see below). +1. [Configure extension](#configure-extension). -### or install from VSIX file +### Install from VSIX file -1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace. +1. In Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags). 1. Click on the Download Extension link. 1. Click on the More Actions icon on the Extensions page in Visual Studio Code and select Install from VSIX... -1. Configure extension (see below). +1. [Configure extension](#configure-extension). ## Configure extension ### Authentication -Installation of ConfigCat Feature Flags Visual Studio Code Extension - 1. Get your ConfigCat Public API credentials from [ConfigCat Dashboard/Public Management API credentials](https://app.configcat.com/my-account/public-api-credentials). 1. Authenticate ConfigCat in Visual Studio Code by - clicking on the ConfigCat Feature Flags icon on the Activity Bar and clicking on any of the Authenticate buttons. - or running the `ConfigCat - Log In` command from the Command Palette. + Installation of ConfigCat Feature Flags Visual Studio Code Extension + ### Advanced -If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance, you can specify your custom urls by executing the `Preferences: Open Workspace Settings` command from the Command Palette and search for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings: +This section is for you if you use a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom ConfigCat URLs in Visual Studio Code. You can do that by executing the `Preferences: Open Workspace Settings` command from the Command Palette and searching for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings: + +- `Public Api Base URL`: the base URL for the ConfigCat Public Management API. Defaults to: https://api.configcat.com. +- `Dashboard Base URL`: the base URL for ConfigCat Dashboard. Defaults to: https://app.configcat.com. + +## Usage of ConfigCat Feature Flags Views + +The ConfigCat Feature Flags Views can be opened by clicking the ConfigCat Feature Flags icon on the Visual Studio Code's Activity Bar. There are three different views. + +### Feature Flags & Settings View + +After you successfully connect your ConfigCat Config to your Visual Studio Code Workspace, open the Feature Flags & Settings View and: + +- View the connected Config's Feature Flags. +- View or Update your Feature Flag's value. +- Create new Feature Flags. +- Copy a Feature Flag's key to the clipboard. +- Find your Feature Flag's usages in your code. + + Usage of ConfigCat Feature Flags & Settings View in Visual Studio Code Extension + +#### View or Update your Feature Flag's value + +1. Open the Feature Flags & Settings View. +1. Find the Flag and click the 'View or Update Feature Flag values' icon next to the Flag name. +1. Select the environment. +1. See the Feature Flag in the opened tab. +1. You can turn your features On / Off right from this Issue. +1. 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) +1. You can add new Percentage Options to Feature Flags or Targeting Rules -- `Public Api Base URL`: the base url for the ConfigCat Public Management Api. Defaults to: https://api.configcat.com. -- `Dashboard Base URL`: the base url for ConfigCat Dashboard. Defaults to: https://app.configcat.com. +#### Create a new Feature Flag -## Usage +1. Open the Feature Flags & Settings View. +1. Click the '+' in the View header. +1. Select the setting type. +1. Enter the new Feature Flag name. +1. Enter the new Feature Flag key. +1. Add a hint to your Feature Flag (optional). +1. Select 'Yes' to confirm the Flag creation. -### ConfigCat Feature Flags Views +#### Copy a Feature Flag's key to the clipboard -The ConfigCat Feature Flags Views can be opened by clicking on the ConfigCat Feature Flags icon on the Activity Bar. It consists of 3 different view: +1. Open the Feature Flags & Settings View. +1. Find the Flag and click the 'Copy Key to clipboard' icon next to the Flag name. -#### Products & Configs View +#### Find your Feature Flag's usages in your code -On the Products & Configs View you can: +1. Open the Feature Flags & Settings View. +1. Find the Flag and click the 'Find usage' icon next to the Flag name. +1. See the search results in the opened tab. + +### Products & Configs View + +Manage your products and configs on the Products & Configs View by performing the following actions: - View all of your Products & Configs. - Create Configs under a Product. - Connect a Config to your current Workspace. - Open your Configs on the ConfigCat Dashboard. -#### Feature Flags & Settings View + Usage of ConfigCat Products & Configs View in Visual Studio Code Extension -After you successfully connected a Config to your Workspace, from the Feature Flags & Settings View you can: +#### Create a new Config under a product -- Turn features On / Off right from Visual Studio Code. -- Add Targeting or Percentage Rules from Visual Studio Code. -- View or Update your Feature Flag's value. -- View the connected Config's Feature Flags. -- Create new Feature Flags. -- Copy a Feature Flag's key to clipboard. -- Find your Feature Flag's usages in your code. +1. Open the Products & Configs View. +1. In the products list, click the '+' icon next to the product where you want to create the new config. +1. Enter a name for the new Config. +1. Add a description to your Config (optional). +1. Connect the new config to your current Workspace (optional) + +#### Connect a Config to your current Workspace + +1. Open the Products & Configs View. +1. Find the Config you want to connect to your current Workspace under your product list. +1. Click the 'Connector' icon next to the Config in the list. +1. You can see the Config's Feature Flags in the "Feature Flags & Setting View" + +#### Open your Configs on the ConfigCat Dashboard +1. Open the Products & Configs View. +1. Find the Config you want to connect to your current Workspace under your product list. +1. Click the 'Open Config in ConfigCat Dashboard' icon next to the Config in the list. -#### Help & Feedback View +### Help & Feedback View -The Help & Feedback view provides you some quick links to open ConfigCat's Documentation, ConfigCat's Dashboard and gives you the opportunity to report any issues. +The Help & Feedback view provides quick links to open ConfigCat's Documentation and Dashboard and allows you to report issues. \ No newline at end of file diff --git a/website/static/assets/jira/create-link.gif b/website/static/assets/jira/create-link.gif index b9747323..5f81986a 100644 Binary files a/website/static/assets/jira/create-link.gif and b/website/static/assets/jira/create-link.gif differ diff --git a/website/static/assets/jira/edit-ff.gif b/website/static/assets/jira/edit-ff.gif index 5b27cb0b..8ec1645d 100644 Binary files a/website/static/assets/jira/edit-ff.gif and b/website/static/assets/jira/edit-ff.gif differ diff --git a/website/static/assets/jira/link-existing.gif b/website/static/assets/jira/link-existing.gif index f93220b7..9bf5d775 100644 Binary files a/website/static/assets/jira/link-existing.gif and b/website/static/assets/jira/link-existing.gif differ diff --git a/website/static/assets/jira/open-from-dashboard.gif b/website/static/assets/jira/open-from-dashboard.gif index a7518899..fed26688 100644 Binary files a/website/static/assets/jira/open-from-dashboard.gif and b/website/static/assets/jira/open-from-dashboard.gif differ diff --git a/website/static/assets/jira/release-field.gif b/website/static/assets/jira/release-field.gif index 86968dae..5f56e63c 100644 Binary files a/website/static/assets/jira/release-field.gif and b/website/static/assets/jira/release-field.gif differ diff --git a/website/static/assets/jira/release-hub.gif b/website/static/assets/jira/release-hub.gif index 1f6e4263..afe36114 100644 Binary files a/website/static/assets/jira/release-hub.gif and b/website/static/assets/jira/release-hub.gif differ diff --git a/website/static/assets/jira/remove-ff.gif b/website/static/assets/jira/remove-ff.gif index 7fa1295a..5ea81eaf 100644 Binary files a/website/static/assets/jira/remove-ff.gif and b/website/static/assets/jira/remove-ff.gif differ diff --git a/website/static/assets/jira/v1/auth.gif b/website/static/assets/jira/v1/auth.gif new file mode 100644 index 00000000..cc90bd1d Binary files /dev/null and b/website/static/assets/jira/v1/auth.gif differ diff --git a/website/static/assets/jira/v1/create-link.gif b/website/static/assets/jira/v1/create-link.gif new file mode 100644 index 00000000..1889b0ed Binary files /dev/null and b/website/static/assets/jira/v1/create-link.gif differ diff --git a/website/static/assets/jira/v1/edit-ff.gif b/website/static/assets/jira/v1/edit-ff.gif new file mode 100644 index 00000000..de64fafc Binary files /dev/null and b/website/static/assets/jira/v1/edit-ff.gif differ diff --git a/website/static/assets/jira/v1/link-existing.gif b/website/static/assets/jira/v1/link-existing.gif new file mode 100644 index 00000000..b50c2e62 Binary files /dev/null and b/website/static/assets/jira/v1/link-existing.gif differ diff --git a/website/static/assets/jira/v1/open-from-dashboard.gif b/website/static/assets/jira/v1/open-from-dashboard.gif new file mode 100644 index 00000000..1ae0f167 Binary files /dev/null and b/website/static/assets/jira/v1/open-from-dashboard.gif differ diff --git a/website/static/assets/jira/v1/release-field.gif b/website/static/assets/jira/v1/release-field.gif new file mode 100644 index 00000000..e9556bc8 Binary files /dev/null and b/website/static/assets/jira/v1/release-field.gif differ diff --git a/website/static/assets/jira/v1/release-hub.gif b/website/static/assets/jira/v1/release-hub.gif new file mode 100644 index 00000000..aceb5aae Binary files /dev/null and b/website/static/assets/jira/v1/release-hub.gif differ diff --git a/website/static/assets/jira/v1/remove-ff.gif b/website/static/assets/jira/v1/remove-ff.gif new file mode 100644 index 00000000..6dd904b2 Binary files /dev/null and b/website/static/assets/jira/v1/remove-ff.gif differ diff --git a/website/static/assets/monday/create_ff.gif b/website/static/assets/monday/create_ff.gif new file mode 100644 index 00000000..a7ac68ed Binary files /dev/null and b/website/static/assets/monday/create_ff.gif differ diff --git a/website/static/assets/monday/edit_ff.gif b/website/static/assets/monday/edit_ff.gif new file mode 100644 index 00000000..15a65b90 Binary files /dev/null and b/website/static/assets/monday/edit_ff.gif differ diff --git a/website/static/assets/monday/link_existing_ff.gif b/website/static/assets/monday/link_existing_ff.gif new file mode 100644 index 00000000..7094c597 Binary files /dev/null and b/website/static/assets/monday/link_existing_ff.gif differ diff --git a/website/static/assets/monday/open_from_dashboard.gif b/website/static/assets/monday/open_from_dashboard.gif new file mode 100644 index 00000000..774f83ff Binary files /dev/null and b/website/static/assets/monday/open_from_dashboard.gif differ diff --git a/website/static/assets/monday/remove_ff.gif b/website/static/assets/monday/remove_ff.gif new file mode 100644 index 00000000..e6ec5788 Binary files /dev/null and b/website/static/assets/monday/remove_ff.gif differ diff --git a/website/static/assets/monday/v1/monday_auth.gif b/website/static/assets/monday/v1/monday_auth.gif new file mode 100644 index 00000000..1b080c74 Binary files /dev/null and b/website/static/assets/monday/v1/monday_auth.gif differ diff --git a/website/static/assets/monday/monday_create.gif b/website/static/assets/monday/v1/monday_create.gif similarity index 100% rename from website/static/assets/monday/monday_create.gif rename to website/static/assets/monday/v1/monday_create.gif diff --git a/website/static/assets/monday/monday_link.gif b/website/static/assets/monday/v1/monday_link.gif similarity index 100% rename from website/static/assets/monday/monday_link.gif rename to website/static/assets/monday/v1/monday_link.gif diff --git a/website/static/assets/trello/create-link.gif b/website/static/assets/trello/create-link.gif new file mode 100644 index 00000000..d4ca84df Binary files /dev/null and b/website/static/assets/trello/create-link.gif differ diff --git a/website/static/assets/trello/edit-ff.gif b/website/static/assets/trello/edit-ff.gif new file mode 100644 index 00000000..17e2d01b Binary files /dev/null and b/website/static/assets/trello/edit-ff.gif differ diff --git a/website/static/assets/trello/install.gif b/website/static/assets/trello/install.gif new file mode 100644 index 00000000..b18acdd1 Binary files /dev/null and b/website/static/assets/trello/install.gif differ diff --git a/website/static/assets/trello/link-existing.gif b/website/static/assets/trello/link-existing.gif new file mode 100644 index 00000000..4aec2588 Binary files /dev/null and b/website/static/assets/trello/link-existing.gif differ diff --git a/website/static/assets/trello/open-from-dashboard.gif b/website/static/assets/trello/open-from-dashboard.gif new file mode 100644 index 00000000..f45bfdf7 Binary files /dev/null and b/website/static/assets/trello/open-from-dashboard.gif differ diff --git a/website/static/assets/trello/remove-ff.gif b/website/static/assets/trello/remove-ff.gif new file mode 100644 index 00000000..15ea760d Binary files /dev/null and b/website/static/assets/trello/remove-ff.gif differ diff --git a/website/static/assets/trello/v1/create-link.gif b/website/static/assets/trello/v1/create-link.gif new file mode 100644 index 00000000..8f542818 Binary files /dev/null and b/website/static/assets/trello/v1/create-link.gif differ diff --git a/website/static/assets/trello/v1/edit-ff.gif b/website/static/assets/trello/v1/edit-ff.gif new file mode 100644 index 00000000..36aac7e5 Binary files /dev/null and b/website/static/assets/trello/v1/edit-ff.gif differ diff --git a/website/static/assets/trello/v1/install.gif b/website/static/assets/trello/v1/install.gif new file mode 100644 index 00000000..e914d8f8 Binary files /dev/null and b/website/static/assets/trello/v1/install.gif differ diff --git a/website/static/assets/trello/v1/link-existing.gif b/website/static/assets/trello/v1/link-existing.gif new file mode 100644 index 00000000..d5f99b5f Binary files /dev/null and b/website/static/assets/trello/v1/link-existing.gif differ diff --git a/website/static/assets/trello/v1/open-from-dashboard.gif b/website/static/assets/trello/v1/open-from-dashboard.gif new file mode 100644 index 00000000..09f5ed77 Binary files /dev/null and b/website/static/assets/trello/v1/open-from-dashboard.gif differ diff --git a/website/static/assets/trello/v1/remove-ff.gif b/website/static/assets/trello/v1/remove-ff.gif new file mode 100644 index 00000000..712086cb Binary files /dev/null and b/website/static/assets/trello/v1/remove-ff.gif differ diff --git a/website/static/assets/trello_enable.gif b/website/static/assets/trello_enable.gif deleted file mode 100644 index 3aef146c..00000000 Binary files a/website/static/assets/trello_enable.gif and /dev/null differ diff --git a/website/static/assets/trello_use.gif b/website/static/assets/trello_use.gif deleted file mode 100644 index 9a9e54be..00000000 Binary files a/website/static/assets/trello_use.gif and /dev/null differ diff --git a/website/static/assets/vscode/ff_setting_view.gif b/website/static/assets/vscode/ff_setting_view.gif new file mode 100644 index 00000000..2cd0dac4 Binary files /dev/null and b/website/static/assets/vscode/ff_setting_view.gif differ diff --git a/website/static/assets/vscode/prod_config_view.gif b/website/static/assets/vscode/prod_config_view.gif new file mode 100644 index 00000000..6101a4f7 Binary files /dev/null and b/website/static/assets/vscode/prod_config_view.gif differ diff --git a/website/static/assets/vscode/v1/auth.gif b/website/static/assets/vscode/v1/auth.gif new file mode 100644 index 00000000..54acee1b Binary files /dev/null and b/website/static/assets/vscode/v1/auth.gif differ diff --git a/website/static/assets/vscode/usage.gif b/website/static/assets/vscode/v1/usage.gif similarity index 100% rename from website/static/assets/vscode/usage.gif rename to website/static/assets/vscode/v1/usage.gif diff --git a/website/versioned_docs/version-V1/integrations/jira.mdx b/website/versioned_docs/version-V1/integrations/jira.mdx index 3826b500..366f8864 100644 --- a/website/versioned_docs/version-V1/integrations/jira.mdx +++ b/website/versioned_docs/version-V1/integrations/jira.mdx @@ -4,74 +4,91 @@ 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. --- -Turn features On / Off right from a linked Issue on your Jira board with ConfigCat Feature Flags Jira Cloud Plugin. Also you can add Targeting or Percentage Rules just as easily. +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. -## Installation +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. -Installation of the ConfigCat Feature Flags Jira Cloud Plugin +:::info +This integration is for Jira Cloud. It does not work on Jira Data Center or Jira Server instances. +::: + +## Installation 1. Add ConfigCat Feature Flags to your Jira Cloud instance. 2. Select `Configure`. -3. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +3. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 4. Click authorize. -> Every Jira user should authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Jira Cloud Plugin. +:::info +Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin. +::: + +Installation of the ConfigCat Feature Flags Jira Cloud Plugin ## Usage ### Linking existing feature flags -Linking existing feature flags in Jira Cloud Plugin - 1. Open any Issue on your Jira board. -2. Push `Link/Create ConfigCat Feature Flag` -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 turn your features On / Off right from this Issue. +2. Open the `ConfigCat Feature Flag` issue context. +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. -### Creating new feature flags +Linking existing feature flags in Jira Cloud Plugin -Create feature flags in Jira Cloud Plugin + +### Creating new feature flags 1. Open any Issue on your Jira board. -2. Push `Link/Create ConfigCat Feature Flag` -3. On the `Create and Link` tab select a ConfigCat Product, Config where you want to create the feature flag. -4. Setup your feature flag. -5. Select which environment would you like to link to this item. -6. When linked, you can turn your features On / Off right from this Issue. +2. Open the `ConfigCat Feature Flag` issue context. +3. On the `Create and Link` tab, select a ConfigCat Product and Config where you want to create the feature flag. +4. Set up your feature flag. +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. -### View and Edit linked feature flags +Create feature flags in Jira Cloud Plugin -View and Edit linked feature flags in Jira Cloud Plugin +### View and Edit linked feature flags -1. Open an Issue on your Jira board with linked feature flag. +1. Open an Issue on your Jira board with a linked feature flag. 2. You can see the linked feature flags in the `Feature Flag (ConfigCat)` issue section. 3. You can turn your features On / Off right from this Issue. 4. You can add new Targeting Rules, target a new segment or target a percentage of users. 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. -### Remove linked feature flags +View and Edit linked feature flags in Jira Cloud Plugin -Remove linked feature flags in Jira Cloud Plugin +### Remove linked feature flags -1. Open an Issue on your Jira board with linked feature flag. +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. -### View flag status in Releases +Remove linked feature flags in Jira Cloud Plugin -View feature flags in releases field +### View flag status in Releases -1. Open an Issue on your Jira board with linked feature flag. +1. Open an Issue on your Jira board with a linked feature flag. 2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue. -3. Click it for more detailed dialog. +3. Click it for a more detailed dialog. -View feature flags in Release hub +View feature flags in releases field -1. Open a version in the project Release Hub to see the related issues feature flag status. -2. Click it for more detailed dialog. +1. Open a version in the Jira project's Release Hub page to see the related issues feature flag status. +2. Click it for a more detailed dialog. + +View feature flags in Release hub -### View linked issues in ConfigCat -Link in Dashboard +:::info +This plugin 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. +::: + +### View linked issues in ConfigCat 1. View linked issues next to your Feature Flags in ConfigCat and jump to the Jira Issue directly. + +Link in Dashboard diff --git a/website/versioned_docs/version-V1/integrations/monday.mdx b/website/versioned_docs/version-V1/integrations/monday.mdx index a7821315..7807bd3b 100644 --- a/website/versioned_docs/version-V1/integrations/monday.mdx +++ b/website/versioned_docs/version-V1/integrations/monday.mdx @@ -4,39 +4,49 @@ title: monday.com - Manage feature flags from monday description: ConfigCat monday app. This is a step-by-step guide on how to connect and manage feature flags from monday.com boards and items. --- -Turn features On / Off right from a linked item on your monday.com board with the ConfigCat Feature Flags monday.com app. Also you can add targeting or percentage rules just as easily. +The ConfigCat Feature Flags monday app allows you to connect your Monday items and feature flags. Create or link existing flags to your items without leaving your monday instance. + +Turn features On/Off right from a linked item on your Monday 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. ## Installation -Installation of the ConfigCat Feature Flags monday app +Installation of the ConfigCat Feature Flags monday app 1. Install ConfigCat Feature Flags monday.com app to your monday account. -2. Open one of your boards in monday and click on an item. +2. Open one of your boards on monday.com and click on an item. 3. Add the ConfigCat Feature Flags monday app to your item. -4. In order to use ConfigCat Feature Flags you have to authorize first with your ConfigCat Public API credentials. -5. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +4. In order to use ConfigCat Feature Flags, you have to authorize first with your ConfigCat Public API credentials. +5. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 6. Click authorize. +:::info +Every monday.com user must authorize ConfigCat in monday.com who wants to use the ConfigCat Feature Flags app. +::: + ## Usage ### Linking existing feature flags -Linking feature flags with the ConfigCat Feature Flags monday.com app - 1. Open any item on your monday.com board. -2. Push `Link existing feature flag` -3. Select a Product, Config, Environment and a Feature Flag to be linked to your monday.com item. -4. When linked, you can turn your features On / Off right from this monday.com item. +2. Push the `Link existing feature flag`. +3. Select a Product, Config, Environment, and Feature Flag to be linked to your monday.com item. +4. When linked, you can manage the selected feature flag from this monday.com item. 5. View linked monday.com items next to your Feature Flags in ConfigCat and jump to the monday.com item directly. +Linking feature flags with the ConfigCat Feature Flags monday.com app + + ### Creating new feature flags -Create feature flags with the ConfigCat Feature Flags monday app 1. Open any item on your monday.com board. -2. Push `Create and link feature flag` -3. Select a Product, Config where you want to create the feature flag. -4. Setup your feature flag. -5. Select which environment would you like to link to this item. -6. When linked, you can turn your features On / Off right from this monday.com item. +2. Push the `Create and link feature flag`. +3. Select a Product and config where you want to create the feature flag. +4. Set up your feature flag. +5. Select which environment you would like to link to this item. +6. When linked, you can manage the selected feature flag from this monday.com item. 7. View linked monday.com items next to your Feature Flags in ConfigCat and jump to the monday.com item directly. + +Create feature flags with the ConfigCat Feature Flags monday app diff --git a/website/versioned_docs/version-V1/integrations/trello.mdx b/website/versioned_docs/version-V1/integrations/trello.mdx index 63b5e68f..861ca886 100644 --- a/website/versioned_docs/version-V1/integrations/trello.mdx +++ b/website/versioned_docs/version-V1/integrations/trello.mdx @@ -4,23 +4,67 @@ title: Trello Power-Up - Manage feature flags from Trello description: ConfigCat Trello Power-Up. This is a step-by-step guide on how to connect and manage feature flags from Trello boards and cards. --- -Turn features On / Off right from a linked Card on your Trello board with ConfigCat's Trello Power-Up. Also you can add Targeting or Percentage Rules just as easily. +The ConfigCat's Trello Power-Up allows you to connect your Trello Cards and feature flags. Create or link existing flags to your Trello cards without leaving your Trello board. -## Installation +Turn features On/Off right from a linked card on your Trello 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 power-up installation and familiarise you with the plugin usage. -Installation of the ConfigCat Feature Flags Trello Power-Up +## Installation 1. Add ConfigCat Power-Up to your board. 2. Select `Settings -> Authorize Account`. -3. Get your ConfigCat Public API credentials: https://app.configcat.com/my-account/public-api-credentials +3. Copy your ConfigCat Public API credentials to the inputs. Read more about ConfigCat Public API credentials here. 4. Click authorize. +Installation of the ConfigCat Feature Flags Trello Power-Up + + +:::info +Every Trello user must authorize ConfigCat in Trello who wants to use the ConfigCat Feature Flags power-up. +::: + ## Usage -Usage of the ConfigCat Feature Flags Trello Power-Up +### Linking existing feature flags + +1. Open any Card on your Trello board. +2. Push the `Link Feature Flag` button. +3. Select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Card. +4. When linked, you can manage the selected feature flag from this Card. + +Link feature flag in ConfigCat Feature Flags Trello Power-Up + +### Creating new feature flags 1. Open any Card on your Trello board. -2. Push `Link Feature Flag` -3. Select a Product, Config, Environment and a Feature Flag to be linked to your card. -4. When linked, you can turn your features On / Off right from this Card. -5. View linked Cards next to your Feature Flags in ConfigCat and jump to the Trello Card directly. +2. Push the `Create and Link Feature Flag` button. +3. Select a ConfigCat Product and Config where you want to create the feature flag. +4. Set up your feature flag. +5. Select which environment you would like to link to this item. +6. When linked, you can manage the selected feature flag from this Card. + +Create feature flag in ConfigCat Feature Flags Trello Power-Up + +### View and Edit linked feature flags + +1. Open a Card on your Trello board with a linked feature flag. +2. See the linked feature flags in the `Feature Flag (ConfigCat)` section. +3. You can manage the selected feature flag from this Card. +4. Add new Percentage Options to Feature Flags or Targeting Rules. +5. You can remove Targeting Rules as well. + +Edit feature flag in ConfigCat Feature Flags Trello Power-Up + +### Remove linked feature flags + +1. Open a Card on your Trello board with a linked feature flag. +2. Remove the linked feature flag by opening the "More menu" and selecting the "Remove from card" option. + +Remove feature flag in ConfigCat Feature Flags Trello Power-Up + +### View linked Cards in ConfigCat + +1. View linked cards next to your Feature Flags in ConfigCat and jump to the Trello card directly. + +Link in Dashboard \ No newline at end of file diff --git a/website/versioned_docs/version-V1/integrations/vscode.mdx b/website/versioned_docs/version-V1/integrations/vscode.mdx index 5a2d31b0..0b16d1ba 100644 --- a/website/versioned_docs/version-V1/integrations/vscode.mdx +++ b/website/versioned_docs/version-V1/integrations/vscode.mdx @@ -8,7 +8,7 @@ description: ConfigCat Visual Studio Code extension. This is a step-by-step guid ## Feature overview -Usage of ConfigCat Feature Flags Visual Studio Code Extension +Usage of ConfigCat Feature Flags Visual Studio Code Extension ### List of Features @@ -26,19 +26,19 @@ description: ConfigCat Visual Studio Code extension. This is a step-by-step guid ### Visual Studio Code Marketplace -1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace. +1. In the Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags). 1. Click on the Install button. 1. Configure extension (see below) -### or within Visual Studio Code +### Install within Visual Studio Code -1. Search for ConfigCat Feature Flags at the Extensions page. +1. In Visual Studio Code, open the Extensions page, and search for ConfigCat Feature Flags. 1. Click on the Install button. 1. Configure extension (see below). -### or install from VSIX file +### Install from VSIX file -1. Open [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags) at Visual Studio Marketplace. +1. In Visual Studio Marketplace, open the [ConfigCat Feature Flags Extension](https://marketplace.visualstudio.com/items?itemName=ConfigCat.configcat-feature-flags). 1. Click on the Download Extension link. 1. Click on the More Actions icon on the Extensions page in Visual Studio Code and select Install from VSIX... 1. Configure extension (see below). @@ -47,16 +47,16 @@ description: ConfigCat Visual Studio Code extension. This is a step-by-step guid ### Authentication -Installation of ConfigCat Feature Flags Visual Studio Code Extension - 1. Get your ConfigCat Public API credentials from [ConfigCat Dashboard/Public Management API credentials](https://app.configcat.com/my-account/public-api-credentials). 1. Authenticate ConfigCat in Visual Studio Code by - clicking on the ConfigCat Feature Flags icon on the Activity Bar and clicking on any of the Authenticate buttons. - or running the `ConfigCat - Log In` command from the Command Palette. +Installation of ConfigCat Feature Flags Visual Studio Code Extension + ### Advanced -If you are trying to use the ConfigCat Feature Flags extension for Visual Studio Code with a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance, you can specify your custom urls by executing the `Preferences: Open Workspace Settings` command from the Command Palette and search for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings: +This section is for you if you use a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom ConfigCat URLs in Visual Studio Code. You can do that by executing the `Preferences: Open Workspace Settings` command from the Command Palette and searching for `Extensions/ConfigCat` or clicking the manage button on the ConfigCat Feature Flags extension's page. Important settings: - `Public Api Base URL`: the base url for the ConfigCat Public Management Api. Defaults to: https://api.configcat.com. - `Dashboard Base URL`: the base url for ConfigCat Dashboard. Defaults to: https://app.configcat.com. @@ -65,11 +65,11 @@ If you are trying to use the ConfigCat Feature Flags extension for Visual Studio ### ConfigCat Feature Flags Views -The ConfigCat Feature Flags Views can be opened by clicking on the ConfigCat Feature Flags icon on the Activity Bar. It consists of 3 different view: +The ConfigCat Feature Flags Views can be opened by clicking on the ConfigCat Feature Flags icon on the Visual Studio Code's Activity Bar. It consists of 3 different view: #### Products & Configs View -On the Products & Configs View you can: +Manage your products and configs on the Products & Configs View by performing the following actions: - View all of your Products & Configs. - Create Configs under a Product. @@ -78,7 +78,7 @@ On the Products & Configs View you can: #### Feature Flags & Settings View -After you successfully connected a Config to your Workspace, from the Feature Flags & Settings View you can: +After you successfully connect your ConfigCat Config to your Visual Studio Code Workspace, open the Feature Flags & Settings View and: - Turn features On / Off right from Visual Studio Code. - Add Targeting or Percentage Rules from Visual Studio Code.