Skip to content

Commit 848c93a

Browse files
Docs review integrations (#577)
* IntelliJ docs update * Jira docs update * monday fix * vscode update * amplitude install/uninstall update * zapier text update * Zoho text update * datadog update * Delete not relevant zapier png * Update website/docs/integrations/amplitude.mdx Co-authored-by: adams85 <[email protected]> * Update website/docs/integrations/datadog.mdx Co-authored-by: adams85 <[email protected]> * Update website/docs/integrations/intellij.mdx Co-authored-by: adams85 <[email protected]> * Update website/docs/integrations/zapier.mdx Co-authored-by: adams85 <[email protected]> * Update website/docs/integrations/zapier.mdx Co-authored-by: adams85 <[email protected]> * Update website/versioned_docs/version-V1/integrations/intellij.mdx Co-authored-by: adams85 <[email protected]> * UX guidline update * Fixes based on code review * Fix based on code review --------- Co-authored-by: adams85 <[email protected]>
1 parent 1e062d3 commit 848c93a

File tree

12 files changed

+136
-143
lines changed

12 files changed

+136
-143
lines changed
-28.7 KB
Binary file not shown.

website/docs/integrations/amplitude.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ Every feature flag change in ConfigCat is annotated on the Amplitude charts as a
2626
2. Get an <a href="https://www.docs.developers.amplitude.com/analytics/find-api-credentials/" target="_blank">Amplitude API Key and Secret Key.</a>
2727
<img src="/docs/assets/amplitude_apikey_secretkey.png" alt="amplitude_apikey_secretkey" decoding="async" loading="lazy"/>
2828
3. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
29-
4. Click on Amplitude's CONNECT button and set your Amplitude API key and Secret key.
29+
4. Click on Amplitude's **Connect** button and set your Amplitude API key and Secret key.
3030
5. You're all set. Go ahead and make some changes on your feature flags, then check your charts in Amplitude.
3131

3232
### Un-installation
3333

3434
1. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
35-
2. Click on Amplitude's DISCONNECT button.
35+
2. Click on Amplitude's **Connected** button.
36+
2. Select the connection from the **Connected** dropdown.
37+
3. Click the **Disconnect** button in the edit dialog.
38+
4. Click **Yes** in the confirmation dialog.
3639

3740
### Chart Annotation
3841

website/docs/integrations/datadog.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: ConfigCat Datadog integration. This is a step-by-step guide on how
66

77
## Overview
88

9-
Ensures that every setting change in ConfigCat is sent to Datadog as an Event.
9+
Monitor feature flag events in real-time. Feature flag changes will appear as events in Datadog, tagged with relevant product, config, and environment details.
1010

1111
<img src="/docs/assets/datadog-event_192dpi.png" alt="Feature flag events logged to Datadog" width="1366" height="219" decoding="async" loading="lazy" />
1212

@@ -18,14 +18,17 @@ Ensures that every setting change in ConfigCat is sent to Datadog as an Event.
1818
<img src="/docs/assets/datadog-apikey_192dpi.png" alt="Datadog API Key" width="1366" height="430" decoding="async" loading="lazy" />
1919

2020
3. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
21-
4. Click on Datadog's CONNECT button and set your Datadog API key.
21+
4. Click on Datadog's **Connect** button and set your Datadog API key.
2222
5. OPTIONAL - Set the proper site of your Datadog account. [More about Datadog site](https://docs.datadoghq.com/getting_started/site/).
2323
6. You're all set. Go ahead and make some changes on your feature flags, then check your Events in Datadog.
2424

2525
## Un-installation
2626

2727
1. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
28-
2. Click on Datadog's DISCONNECT button.
28+
2. Click on Datadog's **Connected** button.
29+
3. Select the connection from the **Connected** dropdown.
30+
4. Click the **Disconnect** button in the edit dialog.
31+
5. Click **Yes** in the confirmation dialog.
2932

3033
## Event details
3134

website/docs/integrations/intellij.mdx

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ This guide will help you install the JetBrains/IntelliJ IDE Plugin and familiari
3030

3131
### Install within the IDE from Marketplace
3232

33-
1. In your IDE, open the `File` > `Settings/Preferences` menu.
34-
1. Go to the `Plugin` page and select the `Marketplace` tab.
35-
1. Search for `ConfigCat Feature Flags`.
36-
1. `Install` the plugin.
33+
1. In your IDE, open the **File** > **Settings/Preferences** menu.
34+
1. Go to the **Plugin** page and select the **Marketplace** tab.
35+
1. Search for **ConfigCat Feature Flags**.
36+
1. **Install** the plugin.
3737
1. Configure the plugin ([see below](#configure-extension)).
3838

3939
### Install manually within the IDE
4040

4141
1. Download the latest release from [GitHub](https://github.com/configcat/intellij-plugin/releases/latest) or from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26096-configcat-feature-flags).
42-
1. In your IDE, open the `File` > `Settings/Preferences` menu.
43-
1. Go to the `Plugin` page and open the `Gear Icon` menu.
44-
1. Select the `Install plugin from disk...` option.
42+
1. In your IDE, open the **File** > **Settings/Preferences** menu.
43+
1. Go to the **Plugin** page and open the **Gear Icon** menu.
44+
1. Select the **Install plugin from disk...** option.
4545
1. Configure the plugin ([see below](#configure-extension)).
4646

4747
### Compatible IDEs
@@ -67,10 +67,10 @@ The plugin is compatible with the following IDEs. Check the plugin [JetBrains Ma
6767

6868
### Authentication
6969

70-
1. Get your ConfigCat Public API credentials from [ConfigCat Dashboard/Public Management API credentials](https://app.configcat.com/my-account/public-api-credentials).
71-
1. In your IDE, open the `File` > `Settings/Preferences` menu.
72-
1. Search for `ConfigCat Feature Flags` page.
73-
1. Fill out the `Basic auth user name` and `Basic auth password` inputs.
70+
1. Get your API credentials for [ConfigCat Public Management API](https://app.configcat.com/my-account/public-api-credentials).
71+
1. In your IDE, open the **File** > **Settings/Preferences** menu.
72+
1. Search for **ConfigCat Feature Flags** page.
73+
1. Fill out the **Basic auth user name** and **Basic auth password** inputs.
7474

7575
<video className="video" controls muted>
7676
<source src="/docs/assets/intellij/auth.mp4" type="video/mp4"/>
@@ -79,11 +79,11 @@ The plugin is compatible with the following IDEs. Check the plugin [JetBrains Ma
7979

8080
### Advanced
8181

82-
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 the IDE.
82+
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 the IDE.
8383

84-
1. In your IDE, open the `File` > `Settings/Preferences` menu.
85-
1. Search for `ConfigCat Feature Flags` page.
86-
1. Fill out the `Public Api Base URL` and `Dashboard Base URL` inputs.
84+
1. In your IDE, open the **File** > **Settings/Preferences** menu.
85+
1. Search for **ConfigCat Feature Flags** page.
86+
1. Fill out the **Public Api Base URL** and **Dashboard Base URL** inputs.
8787

8888
- `Public Api Base URL`: the base URL for the ConfigCat Public Management API. Defaults to: https://api.configcat.com.
8989
- `Dashboard Base URL`: the base URL for ConfigCat Dashboard. Defaults to: https://app.configcat.com.
@@ -92,9 +92,9 @@ This section is for you if you use a `dedicated hosted`/[on-premise](https://con
9292

9393
The ConfigCat Feature Flags Tool Window can be opened by clicking the ConfigCat Feature Flags icon on the side of the IDE main window.
9494

95-
### Feature Flags & Settings Tab
95+
### Feature Flags & Settings tab
9696

97-
After you successfully configured your ConfigCat account in the `Settings`, you can use the Feature Flags & Settings Tab and:
97+
After you successfully configured your ConfigCat account in the **Settings**, you can use the **Feature Flags & Settings** tab and:
9898

9999
- View all of your Products, Configs and Feature Flags.
100100
- Create new Configs and Feature Flags.
@@ -110,41 +110,41 @@ After you successfully configured your ConfigCat account in the `Settings`, you
110110
#### Create a new Feature Flag
111111

112112
1. Select the Config in the tree where you want to create your new flag.
113-
1. Click the `+` button on the action bar to open the create dialog.
113+
1. Click the **+** button on the action bar to open the **Create Flag** dialog.
114114
1. Select the setting type.
115115
1. Enter the new Feature Flag name.
116116
1. Enter the new Feature Flag key.
117117
1. Add a hint to your Feature Flag (optional).
118-
1. Select 'OK' to confirm the Flag creation.
118+
1. Select **OK** to confirm the Flag creation.
119119

120120
#### Copy a Feature Flag's key to the clipboard
121121

122122
1. Select the Feature Flag in the tree whose key you want to copy.
123-
1. Click the `Copy` button on the action bar to copy the key to the clipboard.
123+
1. Click the **Copy** button on the action bar to copy the key to the clipboard.
124124

125-
#### Open your Flags on the ConfigCat Dashboard
125+
#### Open your Feature Flags on the ConfigCat Dashboard
126126

127-
1. Select the Flag you want to open in the Dashboard.
128-
1. Click the `Open Config in ConfigCat Dashboard` button on the action bar.
127+
1. In the tree, select the Feature Flag you want to open in the Dashboard.
128+
1. Click the **Open Config in ConfigCat Dashboard** button on the action bar to open the Feature Flag in the Dashboard.
129129

130130
#### Find your Feature Flag's usages in your code
131131

132132
1. Select the Feature Flag in the tree you want to search.
133-
1. Click the `Find Usage` button on the action bar.
133+
1. Click the **Find Usage** button on the action bar.
134134
1. See the search results in the opened dialog.
135135

136136
#### Create a new Config under a product
137137

138138
1. Select the Products in the tree where you want to create your new config.
139-
1. Click the `+` button on the action bar to open the create dialog.
139+
1. Click the **+** button on the action bar to open the **Create Config** dialog.
140140
1. Enter a name for the new config.
141141
1. Add a hint to your config (optional).
142-
1. Select `OK` to confirm the Config creation.
142+
1. Select **OK** to confirm the Config creation.
143143

144144
#### Open your Configs on the ConfigCat Dashboard
145145

146146
1. Select the Config which you want to open in the Dashboard.
147-
1. Click the `Open Config in ConfigCat Dashboard` button on the action bar.
147+
1. Click the **Open Config in ConfigCat Dashboard** button on the action bar to open the Config in the Dashboard.
148148

149149
:::info
150150
The actions are available by right click menu as well.

website/docs/integrations/jira.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ This integration is for Jira Cloud. It does not work on Jira Data Center or Jira
1717
## Installation
1818

1919
1. Add <a href="https://marketplace.atlassian.com/1222421" target="_blank">ConfigCat Feature Flags</a> to your Jira Cloud instance.
20-
2. Select `Configure`.
20+
2. Select **Configure**.
2121
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>.
22-
4. Click authorize.
22+
4. Click **Authorize**.
2323

2424
:::info
2525
Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin.
@@ -35,8 +35,8 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
3535
### Linking existing feature flags
3636

3737
1. Navigate to any Issue on your Jira board.
38-
2. Open the `ConfigCat Feature Flag` issue context.
39-
3. On the `Link existing` tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue.
38+
2. Open the **ConfigCat Feature Flag** issue context.
39+
3. On the **Link existing** tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue.
4040
4. When linked, you can manage the selected feature flag from this Issue.
4141

4242
<video className="video" controls muted>
@@ -47,8 +47,8 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
4747
### Creating new feature flags
4848

4949
1. Navigate to any Issue on your Jira board.
50-
2. Open the `ConfigCat Feature Flag` issue context.
51-
3. On the `Create and Link` tab, select a ConfigCat Product and Config where you want to create the feature flag.
50+
2. Open the **ConfigCat Feature Flag** issue context.
51+
3. On the **Create and Link** tab, select a ConfigCat Product and Config where you want to create the feature flag.
5252
4. Set up your feature flag.
5353
5. Select which environment you would like to link to this item.
5454
6. When linked, you can manage the selected feature flag from this Issue.
@@ -61,9 +61,9 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
6161
### View and Edit linked feature flags
6262

6363
1. Open an Issue on your Jira board with a linked feature flag.
64-
2. See the linked feature flags in the `Feature Flag (ConfigCat)` issue section.
64+
2. See the linked feature flags in the **Feature Flag (ConfigCat)** issue section.
6565
3. You can manage the selected feature flag from this Issue.
66-
4. You can add new Percentage Options to Feature Flags or Targeting Rules.
66+
4. You can add new Targeting Rules or Percentage Options to Feature Flags.
6767
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)
6868
6. You can remove Targeting Rules as well.
6969

@@ -75,7 +75,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
7575
### Remove linked feature flags
7676

7777
1. Open an Issue on your Jira board with a linked feature flag.
78-
2. Remove the linked feature flag by opening the "More menu" and selecting the "Remove from Issue" option.
78+
2. Remove the linked feature flag by opening the **More menu** and selecting the **Remove from Issue** option.
7979

8080
<video className="video" controls muted>
8181
<source src="/docs/assets/jira/remove-ff.mp4" type="video/mp4"/>
@@ -85,7 +85,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
8585
### View flag status in Releases
8686

8787
1. Open an Issue on your Jira board with a linked feature flag.
88-
2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue.
88+
2. Check the **Releases** field values in the issue **Details** section to see the linked feature flags status in the Issue.
8989
3. Click it for a more detailed dialog.
9090

9191
<video className="video" controls muted>

website/docs/integrations/monday.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide will help you with the plugin installation and familiarise you with t
1717
3. Add the ConfigCat Feature Flags monday app to your Item.
1818
4. To use ConfigCat Feature Flags, you must first authorize it with your ConfigCat Public API credentials.
1919
5. 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>.
20-
6. Click authorize.
20+
6. Click **Authorize**.
2121

2222
:::info
2323
Every monday.com user must authorize ConfigCat in monday.com who wants to use the ConfigCat Feature Flags app.
@@ -32,8 +32,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th
3232

3333
### Linking existing feature flags
3434

35-
1. Open any item on your monday.com board.
36-
2. Push the `Link existing feature flag`.
35+
1. Open any Item on your monday.com board.
36+
2. Push the **Link existing feature flag** button.
3737
3. Select a Product, Config, Environment, and Feature Flag to be linked to your monday.com Item.
3838
4. When linked, you can manage the selected feature flag from this monday.com Item.
3939

@@ -44,8 +44,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th
4444

4545
### Creating new feature flags
4646

47-
1. Open any item on your monday.com board.
48-
2. Push the `Create and link feature flag`.
47+
1. Open any Item on your monday.com board.
48+
2. Push the **Create and link feature flag** button.
4949
3. Select a Product and Config where you want to create the feature flag.
5050
4. Set up your feature flag.
5151
5. Select which environment you would like to link to this Item.
@@ -58,10 +58,10 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th
5858

5959
### View and Edit linked feature flags
6060

61-
1. Open any item on your monday.com board.
62-
2. See the linked feature flags in the `Feature Flag (ConfigCat)` view.
61+
1. Open any Item on your monday.com board.
62+
2. See the linked feature flags in the **Feature Flag (ConfigCat)** view.
6363
3. You can manage the selected feature flag from this Item.
64-
4. You can add new Percentage Options to Feature Flags or Targeting Rules.
64+
4. You can add new Targeting Rules or Percentage Options to Feature Flags.
6565
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)
6666
6. You can remove Targeting Rules as well.
6767

@@ -72,8 +72,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th
7272

7373
### Remove linked feature flags
7474

75-
1. Open any item on your monday.com board with a linked feature flag.
76-
2. Remove the linked feature flag by opening the "More menu" and selecting the "Unlink" option.
75+
1. Open any Item on your monday.com board with a linked feature flag.
76+
2. Remove the linked feature flag by opening the **More menu** and selecting the **Unlink** option.
7777

7878
<video className="video" controls muted>
7979
<source src="/docs/assets/monday/remove_ff.mp4" type="video/mp4"/>

0 commit comments

Comments
 (0)