Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrations v2 update #439

Merged
merged 24 commits into from
Dec 10, 2024
Merged

Integrations v2 update #439

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d9bf671
Jira and Trello docs update
novalisdenahi Apr 30, 2024
2245b19
Jira and Trello docs update with new gifs
novalisdenahi May 3, 2024
3aab1b5
Fix typos
novalisdenahi May 7, 2024
f180017
monday and vscode docs update
novalisdenahi May 10, 2024
c0fdc23
monday abd vsCode updates. fix Jira missing info box
novalisdenahi May 17, 2024
db8a9ab
Grammarly update
novalisdenahi May 28, 2024
b0d6e74
Merge branch 'integrations-v2-update' of https://github.com/configcat…
novalisdenahi May 28, 2024
c27b1a2
Fix monday info panel
novalisdenahi May 28, 2024
3329437
Replace black theme gifs and updates based on code review.
novalisdenahi Jun 10, 2024
23fc713
releases action
sigewuzhere Jun 10, 2024
ed99d34
read more
sigewuzhere Jun 10, 2024
2acacbb
Fix read more about in the other integrations as well.
novalisdenahi Jun 11, 2024
ed6128c
Fix V1 and V2 pictures
novalisdenahi Jun 14, 2024
4d662da
Update V1 descriptions
novalisdenahi Jun 14, 2024
aee1bb9
Update Jira V1 gifs to latest
novalisdenahi Jun 14, 2024
c06a9a7
Update Trello V1 gifs to latest
novalisdenahi Jun 14, 2024
9fcd09c
Updates based on Zoli review.
novalisdenahi Aug 1, 2024
3097186
Small fixes
novalisdenahi Aug 14, 2024
568edf8
Update VSCode gifs and description
novalisdenahi Nov 5, 2024
d4a10e2
Update Trello gifs
novalisdenahi Nov 5, 2024
a4e09e9
Update Monday gifs
novalisdenahi Nov 6, 2024
7a2bf7e
Update Jira gifs
novalisdenahi Nov 8, 2024
83b987b
Merge branch 'master' into integrations-v2-update
novalisdenahi Nov 14, 2024
9f89274
Update image border css
novalisdenahi Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 51 additions & 35 deletions website/docs/integrations/jira.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://marketplace.atlassian.com/1222421" target="_blank">ConfigCat Feature Flags Jira Cloud Plugin</a>. Also you can add Targeting or Percentage Rules just as easily.
The <a href="https://marketplace.atlassian.com/1222421" target="_blank">ConfigCat Feature Flags Jira Cloud Plugin</a> 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ez a mondat az értékeajánlat. Az a szerepe, hogy megértse a user, hogy mire tudná használni ezt az integrációt. Ezért ennek a mondatnak a leírás legelején van értelme. Az Installation szekcióban szerintem nincsen sok haszna már.

Azt jvaslom, hogy mozgassuk vissza a doksi elejére. Akár az új kezdőmondat elé vagy mögé.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A doksi elején van. Pont az installation szekció került hátrább.


<img src="/docs/assets/jira/auth.gif" className="zoomable" alt="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 <a href="https://marketplace.atlassian.com/1222421" target="_blank">ConfigCat Feature Flags</a> 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 <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Public API credentials here</a>.
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.
:::

<img src="/docs/assets/jira/auth.gif" className="zoomable" alt="Installation of the ConfigCat Feature Flags Jira Cloud Plugin" />

## Usage

### Linking existing feature flags
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Általában véve azért lenne jobb ha a “Link existing” use case előbb szerepelne, mint a “Create new”, mert a “Link existing” sokkal gyakoribb.

Ugyanakkor itt a ConfigCat doksiban megértem ezt a sorrendet is, de más helyeken pl. a JIRA oldalán mindenképpen a "Link existing" legyen előbb.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Szerintem kiegyezhetünk midnenütt a link existing és create sorrendben. Egységesen appokban és doksiban is. Módsoítom ennek megfelően.

### Creating new feature flags

<img src="/docs/assets/jira/link-existing.gif" className="zoomable" alt="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 `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 `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.
<img src="/docs/assets/jira/create-link.gif" className="zoomable" alt="Create feature flags in Jira Cloud Plugin" />

### Creating new feature flags
### Linking existing feature flags

<img src="/docs/assets/jira/create-link.gif" className="zoomable" alt="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 `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 `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.
<img src="/docs/assets/jira/link-existing.gif" className="zoomable" alt="Linking existing feature flags in Jira Cloud Plugin" />

### View and Edit linked feature flags

<img src="/docs/assets/jira/edit-ff.gif" className="zoomable" alt="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 Targeting Rules with User, Segment or Prerequisite Conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx)
5. You can add new Percentage Options to Feature Flags or Targeting Rules
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.
<img src="/docs/assets/jira/edit-ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/jira/remove-ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/jira/release-field.gif" className="zoomable" alt="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 project Release Hub to see the related issues feature flag status.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Itt a Release Hub-ot hívjuk Jira Release Hub-nak légyszi.
Az az alapelv, hogy sok userünk nem ismeri mélyen sem a Jirat, sem a ConfigCatet.
Nekik segítünk azzal, hogy megnevezzük melyik toolban kezdjen el keresgélni.
Szóval a contextust (ConfigCat vagy Jira) áltlában megnevezzük legalább egyszer, legalább a felsorolások első pontjaiban.

2. Click it for a more detailed dialog.

<img src="/docs/assets/jira/release-hub.gif" className="zoomable" alt="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 pf the Issue.
:::

### View linked issues in ConfigCat

<img src="/docs/assets/jira/open-from-dashboard.gif" className="zoomable" alt="Link in Dashboard" />

1. View linked issues next to your Feature Flags in ConfigCat and jump to the Jira Issue directly.

<img src="/docs/assets/jira/open-from-dashboard.gif" className="zoomable" alt="Link in Dashboard" />
68 changes: 49 additions & 19 deletions website/docs/integrations/monday.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://monday.com/marketplace/10000079" target="_blank">ConfigCat Feature Flags</a> monday.com app. Also you can add targeting or percentage rules just as easily.
The <a href="https://monday.com/marketplace/10000079" target="_blank">ConfigCat Feature Flags monday app</a> 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ez is egy értékajánlat, itt is azt javaslom, hogy ne az Installation szekcióban legyen, hanem a doksumentum elején az első egy-két mondatban.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A doksi elején van. Pont az installation szekció került hátrább.


<img src="/docs/assets/monday/monday_auth.gif" className="zoomable" alt="Installation of the ConfigCat Feature Flags monday app" />
This guide will help you with the plugin installation and familiarise you with the plugin usage.

## Installation

1. Install <a href="https://monday.com/marketplace/10000079" target="_blank">ConfigCat Feature Flags</a> 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 and click on an Item.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ez biztosan "on" monday, és nem "in" monday?
Mert szerintem in "in" Jira, és biztosan nem "on" Jira.

Az "on monday" az szerintem azt jelenti, hogy "hétfőn".

Ennek ellenére, ha a Monday-esek "on monday"-ként szoktak beszélni a saját tooljukról, akkor felőlem maradhat így. Különben szerintem érdemes "in"-re cserélni.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esetleg lehetne on monday.com

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. To learn more, read about <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Public API credentials</a>.
6. Click authorize.

:::info
Every monday.com user must authorize ConfigCat in monday.com who wants to use the ConfigCat Feature Flags app.
:::

<img src="/docs/assets/monday/monday_auth.gif" className="zoomable" alt="Installation of the ConfigCat Feature Flags monday app" />

## Usage

### Linking existing feature flags

<img src="/docs/assets/monday/monday_link.gif" className="zoomable" alt="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.

<img src="/docs/assets/monday/monday_link.gif" className="zoomable" alt="Linking feature flags with the ConfigCat Feature Flags monday.com app" />

### Creating new feature flags

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.

<img src="/docs/assets/monday/monday_create.gif" className="zoomable" alt="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 Targeting Rules with User, Segment or Prerequisite conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx)
5. You can add new Percentage Options to Feature Flags or Targeting Rules
6. You can remove Targeting Rules as well.

<img src="/docs/assets/monday/edit_ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/monday/remove_ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/monday/open_from_dashboard.gif" className="zoomable" alt="Link in Dashboard" />
62 changes: 53 additions & 9 deletions website/docs/integrations/trello.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://trello.com/power-ups/5e694b66d2511a3601ebd0fb" target="_blank">ConfigCat's Trello Power-Up</a>. Also you can add Targeting or Percentage Rules just as easily.
The <a href="https://trello.com/power-ups/5e694b66d2511a3601ebd0fb" target="_blank">ConfigCat's Trello Power-Up</a> 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ez is egy értékajánlat, itt is azt javaslom, hogy ne az Installation szekcióban legyen, hanem a doksumentum elején az első egy-két mondatban.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A doksi elején van. Pont az installation szekció került hátrább.


This guide will help you with the power-up installation and familiarise you with the plugin usage.

<img src="/docs/assets/trello_enable.gif" className="zoomable" alt="Installation of the ConfigCat Feature Flags Trello Power-Up" />
## Installation

1. Add <a href="https://trello.com/power-ups/5e694b66d2511a3601ebd0fb" target="_blank">ConfigCat Power-Up</a> 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. To learn more, read about <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Public API credentials</a>.
4. Click authorize.

:::info
Every Trello user must authorize ConfigCat in Trello who wants to use the ConfigCat Feature Flags power-up.
:::

<img src="/docs/assets/trello/install.gif" className="zoomable" alt="Installation of the ConfigCat Feature Flags Trello Power-Up" />

## Usage

<img src="/docs/assets/trello_use.gif" className="zoomable" alt="Usage of the ConfigCat Feature Flags Trello Power-Up" />
### Creating new feature flags

1. Open any Card on your Trello board.
2. Push `Link Feature Flag`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ebben az esetben is az igaz, hogy a userek sokkal gyakrabban linkelnek, mint creatolnak, ezért a legjobb az lenne, ha a doksiban és a plugin GUI-n is a Link előbb lenne, mint a Create

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 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.

<img src="/docs/assets/trello/create-link.gif" className="zoomable" alt="Create feature flag in 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.

<img src="/docs/assets/trello/link-existing.gif" className="zoomable" alt="Link 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. 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)
5. Add new Percentage Options to Feature Flags or Targeting Rules.
6. You can remove Targeting Rules as well.

<img src="/docs/assets/trello/edit-ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/trello/remove-ff.gif" className="zoomable" alt="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.

<img src="/docs/assets/trello/open-from-dashboard.gif" className="zoomable" alt="Link in Dashboard" />
Loading
Loading