diff --git a/website/docs/advanced/cli.md b/website/docs/advanced/cli.md index 8e81c4b1..72901700 100644 --- a/website/docs/advanced/cli.md +++ b/website/docs/advanced/cli.md @@ -4,9 +4,9 @@ title: Command Line Interface (CLI) description: The ConfigCat Command Line Interface (CLI) connect and match feature flags in your source code with feature flags in the Dashboard. --- -The ConfigCat Command Line Interface (CLI) allows you to interact with the [Public Management API](advanced/public-api.md) via the command line. It supports most functionality found on the ConfigCat Dashboard. You can manage ConfigCat resources like Feature Flags, Targeting / Percentage rules, Products, Configs, Environments, and more. +The ConfigCat Command Line Interface (CLI) allows you to interact with the [Public Management API](/advanced/public-api) via the command line. It supports most functionality found on the ConfigCat Dashboard. You can manage ConfigCat resources like Feature Flags, Targeting / Percentage rules, Products, Configs, Environments, and more. -The ConfigCat Command Line Interface (CLI) has the ability to [scan your source code](/advanced/code-references/overview.md) for feature flag and setting usages and upload the found code references to ConfigCat. +The ConfigCat Command Line Interface (CLI) has the ability to [scan your source code](/advanced/code-references/overview) for feature flag and setting usages and upload the found code references to ConfigCat. ``` configcat diff --git a/website/docs/advanced/config-v2-migration-guide.md b/website/docs/advanced/config-v2-migration-guide.md index c06a808a..7b137e29 100644 --- a/website/docs/advanced/config-v2-migration-guide.md +++ b/website/docs/advanced/config-v2-migration-guide.md @@ -42,7 +42,7 @@ It's important to note that the V2 config will be created with the same settings In your application, upgrade the ConfigCat SDK to the latest version. Old versions of the SDK will not be able to access the new config. Make sure you upgrade every application that uses the migrated V2 config. -Here is a list of the SDKs that support Config V2: [See the supported SDK versions.](advanced/config-v2-sdk-compatibility.md) +Here is a list of the SDKs that support Config V2: [See the supported SDK versions.](/advanced/config-v2-sdk-compatibility) ### Step 3: Update the ConfigCat SDK Key diff --git a/website/docs/advanced/public-api.md b/website/docs/advanced/public-api.md index 18a12f09..94d8ca84 100644 --- a/website/docs/advanced/public-api.md +++ b/website/docs/advanced/public-api.md @@ -13,7 +13,7 @@ The API is based on HTTP REST, uses resource-oriented URLs, status codes and sup :::caution Please avoid using the Management API for feature flag evaluation, it is not designed to handle massive loads. -For that, we have the CDN and the [SDKs instead](sdk-reference/overview.md). +For that, we have the CDN and the [SDKs instead](/sdk-reference/overview). ::: ## Endpoints @@ -66,7 +66,7 @@ You can create clients easily using ConfigCat Dashboard based on the parameters given to ConfigCat by your application. +**As a product manager**, you can set [Targeting rules](/advanced/targeting) on the ConfigCat Dashboard based on the parameters given to ConfigCat by your application. -**As a developer**, User Object allows you to pass optional parameters to the ConfigCat SDK, which you (or your teammates) can use in the ConfigCat Dashboard to apply [Targeting rules](advanced/targeting.md) on. +**As a developer**, User Object allows you to pass optional parameters to the ConfigCat SDK, which you (or your teammates) can use in the ConfigCat Dashboard to apply [Targeting rules](/advanced/targeting) on. ### Example @@ -65,7 +65,7 @@ The data that could and should be passed to the User Object. | Property | Description | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Identifier | **REQUIRED** We recommend adding a UserID, Email address, or SessionID. [More](advanced/user-object.md#identifier-property) | +| Identifier | **REQUIRED** We recommend adding a UserID, Email address, or SessionID. [More](/advanced/user-object#identifier-property) | | Email | **OPTIONAL** By adding this parameter you will be able to create Email address-based targeting. e.g: Only turn on a feature for users with @example.com addresses. | | Country | **OPTIONAL** Fill this for location or country-based targeting. e.g: Turn on a feature for users in Canada only. | | Custom | **OPTIONAL** This parameter will let you create targeting based on any user data you like. e.g: Age, Subscription type, User role, Device type, App version number, etc. | @@ -100,7 +100,7 @@ var userObject = { }; ``` -_The above scheme is in JavaScript. Find the proper schemes in each [SDK's reference.](sdk-reference/overview.md)_ +_The above scheme is in JavaScript. Find the proper schemes in each [SDK's reference.](/sdk-reference/overview)_ On the Dashboard a targeting rule for the custom property `EyeColor` would look like: customPropertyUsageDashboard diff --git a/website/docs/faq.md b/website/docs/faq.md index 37de266a..79f4feef 100644 --- a/website/docs/faq.md +++ b/website/docs/faq.md @@ -26,7 +26,7 @@ You can always check your Usage & Quota [here](https://app.configcat.com/organiz ### Where can I find and download my invoices? All the invoices we issued are available for download from the [Billing & Invoices page.](https://app.configcat.com/organization/billing). -You need to have a [Billing Manager](organization.md/#billing-manager-role) role to access the Billing & Invoices page. +You need to have a [Billing Manager](/organization/#billing-manager-role) role to access the Billing & Invoices page. ### Is it possible to pay via wire transfer? @@ -35,7 +35,7 @@ Using a credit card via the ConfigCat Dashboard is the preferred way of payment, ### How do I upgrade / downgrade my billing plan? You can change your billing plan on the [Plans](https://app.configcat.com/organization/plans) page. -You need to have a [Billing Manager](organization.md/#billing-manager-role) role to access the Plans page. +You need to have a [Billing Manager](/organization/#billing-manager-role) role to access the Plans page. ### Can I get a discounted rate? @@ -56,12 +56,12 @@ Please note: Switching emails means you'll lose preferences from your old accoun ### How do I change the billing email address the way I receive my invoices? Go to the [Billing & Invoices page.](https://app.configcat.com/organization/billing) And click the `Update billing details` link. -You need to have a [Billing Manager](organization.md/#billing-manager-role) role to access the Billing & Invoices page. +You need to have a [Billing Manager](/organization/#billing-manager-role) role to access the Billing & Invoices page. ### How do I change my payment method or billing information? Go to the [Billing & Invoices page.](https://app.configcat.com/organization/billing) and click the `Update billing details` link. -You need to have a [Billing Manager](organization.md/#billing-manager-role) role to access the Billing & Invoices page. +You need to have a [Billing Manager](/organization/#billing-manager-role) role to access the Billing & Invoices page. ### The ChargeBee payment gets stuck | Throws an error @@ -70,12 +70,12 @@ If you're using Firefox, try switching to a Chromium-based browser that has exte ### How do I cancel my account? Go to the [Plans](https://app.configcat.com/organization/plans) page and click the `Switch Plan` button under the Free plan. -You need to have a [Billing Manager](organization.md/#billing-manager-role) role to access the Plans page. +You need to have a [Billing Manager](/organization/#billing-manager-role) role to access the Plans page. ### How do I change my currency? Go to the [Plans](https://app.configcat.com/organization/plans) page and use the currency toggle to switch between USD and EUR. -You need to have a [Billing Manager](organization.md#billing-manager-role) role to access the Plans page. +You need to have a [Billing Manager](/organization#billing-manager-role) role to access the Plans page. ## Security @@ -195,11 +195,11 @@ Also, consider the following: - All SDKs evaluate the rules in the exact same way. (10% is the same 10% in all SDKs) - The percentage rules are sticky by feature flag. (10% is a different 10% for each feature flag) -[More on stickiness and consistency](advanced/targeting.md/#stickiness--consistency) +[More on stickiness and consistency](/advanced/targeting/#stickiness--consistency) ### How to use targeting rules based on sensitive data? -If you want to use targeting rules based on email address, phone number, or other sensitive data, you can use the [Confidential text comparators](advanced/targeting.md/#confidential-text-comparators). +If you want to use targeting rules based on email address, phone number, or other sensitive data, you can use the [Confidential text comparators](/advanced/targeting/#confidential-text-comparators). ## Technical Debt diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index 77df3356..b6d22a90 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -28,7 +28,7 @@ There are ready to use code snippets for `.NET`, `Java`, `Android (Java)`, `Kotl All the ConfigCat SDKs are open-source and available on GitHub. -See the detailed [Docs on how to use the ConfigCat SDKs.](/sdk-reference/overview.md) +See the detailed [Docs on how to use the ConfigCat SDKs.](/sdk-reference/overview) Here's a short example to demonstrate the concept: diff --git a/website/docs/glossary.md b/website/docs/glossary.md index 8a0e1db9..7315c4f2 100644 --- a/website/docs/glossary.md +++ b/website/docs/glossary.md @@ -195,7 +195,7 @@ The Software Development Life Cycle (SDLC) is a systematic approach aimed at pro Software as a Service (SaaS) is a cloud-based delivery model where applications are hosted and maintained by a service provider and accessed by users over the internet, typically on a subscription basis. -#### [Staging Environment](glossary/what-is-a-staging-environment.md) +#### [Staging Environment](/glossary/what-is-a-staging-environment) A staging environment is a dry run for your code under the closest possible parameters to its real-world application. It is a near-perfect replica of the servers, infrastructure, architecture, and application of the actual use environment of your code. The key difference is that it is completely walled off from the front-facing actual environment. diff --git a/website/docs/integrations/overview.md b/website/docs/integrations/overview.md index 011f1aea..37fe0517 100644 --- a/website/docs/integrations/overview.md +++ b/website/docs/integrations/overview.md @@ -9,65 +9,65 @@ Integrate ConfigCat with your technology stack and leverage all the benefits of ## Slack Get a notification in Slack when a feature flag changes. -[Documentation](integrations/slack.md) +[Documentation](/integrations/slack) ## Jira Turn features On / Off right from a linked Issue on your Jira board. -[Documentation](integrations/jira.md) +[Documentation](/integrations/jira) ## Trello Turn features On / Off right from a linked Card on your Trello board. -[Documentation](integrations/trello.md) +[Documentation](/integrations/trello) ## monday Turn features On / Off right from a linked item on your monday board. -[Documentation](integrations/monday.md) +[Documentation](/integrations/monday) ## DataDog Ensure that every setting change in ConfigCat is sent to DataDog as an Event. -[Documentation](integrations/datadog.md) +[Documentation](/integrations/datadog) ## Zapier Connect ConfigCat to 2,000+ other web services. Automated connections called Zaps, set up in minutes with no coding, can automate your day-to-day tasks and build workflows between apps that otherwise wouldn't be possible. -[Documentation](integrations/zapier.md) +[Documentation](/integrations/zapier) ## Zoho Flow Connect ConfigCat to 500+ other web apps without any code. It helps you automate day-to-day tasks and build complex business workflows within minutes. -[Documentation](integrations/zoho-flow.md) +[Documentation](/integrations/zoho-flow) ## CircleCI Discover feature flag usages in your source code and upload the found code references to ConfigCat. -[Documentation](integrations/circleci.md) +[Documentation](/integrations/circleci) ## GitHub Actions Discover feature flag usages in your source code and upload the found code references to ConfigCat. -[Documentation](integrations/github.md) +[Documentation](/integrations/github) ## Bitbucket Pipe Discover feature flag usages in your source code and upload the found code references to ConfigCat. -[Documentation](integrations/bitbucket.md) +[Documentation](/integrations/bitbucket) ## Bitrise Step Discover feature flag usages in your source code and upload the found code references to ConfigCat. -[Documentation](integrations/bitrise.md) +[Documentation](/integrations/bitrise) ## Terraform Manage feature flags directly from Terraform HCL scripts. -[Documentation](integrations/terraform.md) +[Documentation](/integrations/terraform) ## Amplitude Annotate your Amplitude charts with feature flag changes. -[Documentation](integrations/amplitude.md) +[Documentation](/integrations/amplitude) diff --git a/website/docs/purchase.md b/website/docs/purchase.md index dc3c6389..7ee11062 100644 --- a/website/docs/purchase.md +++ b/website/docs/purchase.md @@ -9,7 +9,7 @@ description: This page explains how to purchase ConfigCat plans, how to manage y ConfigCat is a feature flag service with unlimited team size, awesome support, and a reasonable price tag. You can use ConfigCat by subscribing with an email address which is free forever. Additionally, we offer three more plans with fewer limitations and more additional features. For a detailed comparison check out the pricing table. -If you need a comprehensive table of all the business and technical limits of each plan, see the [Subscription Plan Limits Table](subscription-plan-limits.md). +If you need a comprehensive table of all the business and technical limits of each plan, see the [Subscription Plan Limits Table](/subscription-plan-limits). ### Shared vs Dedicated infrastructure @@ -32,7 +32,7 @@ provide reports, review contracts or set up bank transfers. You can purchase a ConfigCat subscription plan on the Plans page. :::info -You must have a [Billing Manager](organization.md) role in your Organization to change or upgrade your plan. +You must have a [Billing Manager](/organization) role in your Organization to change or upgrade your plan. ::: ### Our payment provider @@ -47,5 +47,5 @@ Credit card information is stored and managed by Manage Billing page. :::info -You must have a [Billing Manager](organization.md) role in your Organization to update your billing info. +You must have a [Billing Manager](/organization) role in your Organization to update your billing info. ::: diff --git a/website/docs/sdk-reference/android.md b/website/docs/sdk-reference/android.md index f06a027f..cea5ae2c 100644 --- a/website/docs/sdk-reference/android.md +++ b/website/docs/sdk-reference/android.md @@ -108,7 +108,7 @@ These are the available options on the `Options` class: | Options | Description | | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly`. | +| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly`. | | `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. | | `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). | | `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). | @@ -131,7 +131,7 @@ These clients can be closed all at once with the `ConfigCatClient.closeAll()` me | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -149,7 +149,7 @@ boolean value = client.getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -175,7 +175,7 @@ client.getValueAsync( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -212,7 +212,7 @@ The details result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```java User user = User.newBuilder().build("#UNIQUE-USER-IDENTIFIER#"); // Optional User Object diff --git a/website/docs/sdk-reference/community/laravel.md b/website/docs/sdk-reference/community/laravel.md index 22d58e82..d78cedd2 100644 --- a/website/docs/sdk-reference/community/laravel.md +++ b/website/docs/sdk-reference/community/laravel.md @@ -139,7 +139,7 @@ The following view content will only be rendered if the feature flag is truthy: ### User targeting -The [User Object](/sdk-reference/php/#user-object) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/sdk-reference/php/#user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ConfigCat needs to understand the representation of your users from your application. To do so, you will need to transform your user into a `ConfigCat\User` object. This can be done directly from the [`config/configcat.php`](https://github.com/Pod-Point/laravel-configcat/blob/main/config/configcat.php) file. Here is an example: diff --git a/website/docs/sdk-reference/cpp.md b/website/docs/sdk-reference/cpp.md index 5dc79870..a5f17056 100644 --- a/website/docs/sdk-reference/cpp.md +++ b/website/docs/sdk-reference/cpp.md @@ -97,7 +97,7 @@ _ConfigCat Client_ is responsible for: | Properties | Description | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `baseUrl` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | -| `dataGovernance` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly`. | +| `dataGovernance` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly`. | | `connectTimeoutMs` | Optional, defaults to `8000ms`. Sets the amount of milliseconds to wait for the server to make the initial connection (i.e. completing the TCP connection handshake). `0` means it never times out during transfer | | `readTimeoutMs` | Optional, defaults to `5000ms`. Sets the amount of milliseconds to wait for the server to respond before giving up. `0` means it never times out during transfer. | | `pollingMode` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). | @@ -126,7 +126,7 @@ These clients can be closed all at once with `ConfigCatClient::closeAll()` metho | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```cpp auto user = ConfigCatUser("#USER-IDENTIFIER#"); @@ -145,7 +145,7 @@ auto value = client->getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```cpp auto user = ConfigCatUser("#USER-IDENTIFIER#"); @@ -171,7 +171,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```cpp auto user = ConfigCatUser("#UNIQUE-USER-IDENTIFIER#"); @@ -406,7 +406,7 @@ It allows the usage of all features you can do on the ConfigCat Dashboard. You can download your current config JSON from ConfigCat's CDN and use it as a baseline. -The URL to your current config JSON is based on your [Data Governance](advanced/data-governance.md) settings: +The URL to your current config JSON is based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/dart.md b/website/docs/sdk-reference/dart.md index 9fdcb607..378dfc66 100644 --- a/website/docs/sdk-reference/dart.md +++ b/website/docs/sdk-reference/dart.md @@ -120,7 +120,7 @@ These are the available options on the `ConfigCatOptions` class: | Properties | Description | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataGovernance` | Optional, defaults to `global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `global`, `euOnly`. | +| `dataGovernance` | Optional, defaults to `global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `global`, `euOnly`. | | `baseUrl` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the config JSON. | | `connectTimeout` | Optional, sets the underlying Dio HTTP client's connect timeout. [More about the HTTP Client](#httpclient). | | `receiveTimeout` | Optional, sets the underlying Dio HTTP client's receive timeout. [More about the HTTP Client](#httpclient). | @@ -145,7 +145,7 @@ These clients can be closed all at once with the `ConfigCatClient.closeAll()` me | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```dart final value = await client.getValue( @@ -163,7 +163,7 @@ final value = await client.getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```dart final details = await client.getValueDetails( @@ -188,7 +188,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```dart final user = ConfigCatUser(identifier: '#UNIQUE-USER-IDENTIFIER#'); diff --git a/website/docs/sdk-reference/dotnet.md b/website/docs/sdk-reference/dotnet.md index 5d614851..9fc74ff4 100644 --- a/website/docs/sdk-reference/dotnet.md +++ b/website/docs/sdk-reference/dotnet.md @@ -108,7 +108,7 @@ These are the available options on the `ConfigCatClientOptions` class: | `HttpClientHandler` | Optional, `HttpClientHandler` to provide network credentials and proxy settings. [More about the proxy settings](##using-configcat-behind-a-proxy). | built-in `HttpClientHandler` | | `HttpTimeout` | Optional, sets the underlying HTTP client's timeout. [More about the HTTP timeout](#http-timeout). | `TimeSpan.FromSeconds(30)` | | `FlagOverrides` | Optional, sets the local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides). | | -| `DataGovernance` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly` | `Global` | +| `DataGovernance` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly` | `Global` | | `DefaultUser` | Optional, sets the default user. [More about default user](#default-user). | `null` (none) | | `Offline` | Optional, determines whether the client should be initialized to offline mode. [More about offline mode](#online--offline-mode). | `false` | @@ -136,7 +136,7 @@ You can close all open clients at once using the `ConfigCatClient.DisposeAll()` | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```csharp User userObject = new User("#UNIQUE-USER-IDENTIFIER#"); // Optional User Object @@ -192,7 +192,7 @@ var value = client.GetValue("keyOfMyDecimalSetting", 0); | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```csharp User userObject = new User("#UNIQUE-USER-IDENTIFIER#"); // Optional User Object @@ -225,7 +225,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```csharp User userObject = new User("#UNIQUE-USER-IDENTIFIER#"); @@ -523,9 +523,9 @@ and execute the following command: configcat config-json get -f v6 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` @@ -673,9 +673,9 @@ and execute the following command: configcat config-json get -f v5 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/elixir.md b/website/docs/sdk-reference/elixir.md index dcf5351b..8dbf2d01 100644 --- a/website/docs/sdk-reference/elixir.md +++ b/website/docs/sdk-reference/elixir.md @@ -73,7 +73,7 @@ _ConfigCat Client_ is responsible for: | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `sdk_key` | **REQUIRED.** SDK Key to access your feature flags and configurations. Get it from _ConfigCat Dashboard_. | | `base_url` | Sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | -| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. Defaults to `:global`. [More about Data Governance](advanced/data-governance.md). Available options: `:global`, `:eu_only`. | +| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. Defaults to `:global`. [More about Data Governance](/advanced/data-governance). Available options: `:global`, `:eu_only`. | | `cache_policy` | `CachePolicy.auto/1`, `CachePolicy.lazy/1` and `CachePolicy.manual/0`. Defaults to: `CachePolicy.auto/0` See [See below](#polling-modes) for details. | | `cache` | Caching module you want `configcat` to use. Defaults to: `ConfigCat.InMemoryCache`. [More about cache](#custom-cache-behaviour-with-cache-option-parameter). | | `http_proxy` | Specify this option if you need to use a proxy server to access your ConfigCat settings. You can provide a simple URL, like `https://my_proxy.example.com` or include authentication information, like `https://user:password@my_proxy.example.com/`. | @@ -91,7 +91,7 @@ _ConfigCat Client_ is responsible for: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `default_value` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _ConfigCat.User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _ConfigCat.User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `client` | If you are running multiple instances of `ConfigCat`, provide the `client: :unique_name` option, specifying the name of the instance which you want to access. | ```elixir @@ -110,7 +110,7 @@ value = ConfigCat.get_value( | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `default_value` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `client` | If you are running multiple instances of `ConfigCat`, provide the `client: :unique_name` option, specifying the name of the instance which you want to access. | ```elixir @@ -136,7 +136,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```elixir user_object = ConfigCat.User.new("#UNIQUE-USER-IDENTIFIER#") @@ -494,7 +494,7 @@ It allows the usage of all features you can do on the ConfigCat Dashboard. You can download your current config JSON from ConfigCat's CDN and use it as a baseline. -The URL to your current config JSON is based on your [Data Governance](advanced/data-governance.md) settings: +The URL to your current config JSON is based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/go.md b/website/docs/sdk-reference/go.md index e0da5a18..995a6431 100644 --- a/website/docs/sdk-reference/go.md +++ b/website/docs/sdk-reference/go.md @@ -83,7 +83,7 @@ Available optional properties: | Properties | Type | Description | | ------------------ | -------------------------- | ------------ | | `SDKKey` | `string` | SDK Key to access your feature flags and configurations. Get it from _ConfigCat Dashboard_. | -| `DataGovernance` | `configcat.DataGovernance` | Defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly`. | +| `DataGovernance` | `configcat.DataGovernance` | Defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly`. | | `BaseUrl` | `string` | _Obsolete_ Sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. | | `Cache ` | `ConfigCache` | Sets a custom cache implementation for the client. [See below](#custom-cache). | | `NoWaitForRefresh` | `bool` | Defaults to `false`. When it's `true` the typed get methods (`Get[TYPE]Value()`) will never wait for a configuration refresh to complete before returning. When it's `false` and `PollingMode` is `AutoPoll`, the first request may block, when `PollingMode` is `Lazy`, any request may block. | @@ -119,7 +119,7 @@ Basically all of the value evaluator methods share the same signature, they only | -------------- | -------------------------------------------------------------------------------------------------- | | `key` | Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | This value will be returned in case of an error. | -| `user` | _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```go boolValue := client.GetBoolValue( @@ -145,7 +145,7 @@ intValue := client.GetIntValue( | -------------- | -------------------------------------------------------------------------------------------------- | | `key` | Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | This value will be returned in case of an error. | -| `user` | _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```go details := client.GetBoolValueDetails( @@ -178,7 +178,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```go user = &configcat.UserData{Identifier: "#UNIQUE-USER-IDENTIFIER#"} @@ -452,9 +452,9 @@ and execute the following command: configcat config-json get -f v6 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` @@ -664,9 +664,9 @@ and execute the following command: configcat config-json get -f v5 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/ios.md b/website/docs/sdk-reference/ios.md index a6e6f272..7d173057 100644 --- a/website/docs/sdk-reference/ios.md +++ b/website/docs/sdk-reference/ios.md @@ -213,7 +213,7 @@ These are the available options on the `ConfigCatOptions` class: | Arguments | Type | Description | | ---------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataGovernance` | `DataGovernance` | Optional, defaults to `global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `global`, `euOnly`. | +| `dataGovernance` | `DataGovernance` | Optional, defaults to `global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `global`, `euOnly`. | | `configCache` | `ConfigCache?` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). | | `pollingMode` | `PollingMode` | Optional, sets the polling mode for the client. [More about polling modes](#polling-modes). | | `sessionConfiguration` | `URLSessionConfiguration` | Optional, sets a custom `URLSessionConfiguration` used by the HTTP calls. | @@ -236,7 +236,7 @@ These clients can be closed all at once with the `ConfigCatClient.closeAll()` me | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `completion` | **REQUIRED.** Callback function to call, when the result is ready. | @@ -298,7 +298,7 @@ ConfigCatUser* user = [[ConfigCatUser alloc]initWithIdentifier:@"#UNIQUE-USER-ID | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | @@ -423,7 +423,7 @@ let state = await client.waitForReady() ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. @@ -686,7 +686,7 @@ Evaluates and returns the values of all feature flags and settings. Passing a [U | Parameters | Description | | ---------- | ------------------------------------------------------------------------------------------------------------ | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | diff --git a/website/docs/sdk-reference/java.md b/website/docs/sdk-reference/java.md index 26ccd8af..ff4814d7 100644 --- a/website/docs/sdk-reference/java.md +++ b/website/docs/sdk-reference/java.md @@ -111,7 +111,7 @@ These are the available options on the `Options` class: | Option | Description | | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly`. | +| `dataGovernance(DataGovernance)` | Optional, defaults to `Global`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly`. | | `baseUrl(string)` | _Obsolete_ Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the sdk will download the configurations. | | `httpClient(OkHttpClient)` | Optional, sets the underlying `OkHttpClient` used to download the feature flags and settings over HTTP. [More about the HTTP Client](#httpclient). | | `cache(ConfigCache)` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). | @@ -134,7 +134,7 @@ These clients can be closed all at once with the `ConfigCatClient.closeAll()` me | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -152,7 +152,7 @@ boolean value = client.getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -178,7 +178,7 @@ client.getValueAsync( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `classOfT` | **REQUIRED.** The type of the setting. | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | ```java @@ -214,7 +214,7 @@ The details result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```java User user = User.newBuilder().build("#UNIQUE-USER-IDENTIFIER#"); @@ -517,9 +517,9 @@ and execute the following command: configcat config-json get -f v6 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` @@ -667,9 +667,9 @@ and execute the following command: configcat config-json get -f v5 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/js-ssr.md b/website/docs/sdk-reference/js-ssr.md index 9d67d79b..3abe7694 100644 --- a/website/docs/sdk-reference/js-ssr.md +++ b/website/docs/sdk-reference/js-ssr.md @@ -104,7 +104,7 @@ The available options depends on the chosen polling mode. However, there are som | `logger` | Custom [`IConfigCatLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) implementation for tracing. | [`ConfigCatConsoleLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) (with WARN level) | | `requestTimeoutMs` | The amount of milliseconds the SDK waits for a response from the ConfigCat servers before returning values from the cache. | 30000 | | `baseUrl` | Sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | | -| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | +| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | | `cache` | Custom [`IConfigCatCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) implementation for caching the downloaded config. | [`InMemoryConfigCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) | | `flagOverrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides). | - | | `defaultUser` | Sets the default user. [More about default user](#default-user). | `undefined` (none) | @@ -140,7 +140,7 @@ Returns a Promise with the value. | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const value = await configCatClient.getValueAsync( @@ -197,7 +197,7 @@ If you specify an allowed type but it mismatches the setting kind, an error mess | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const details = await configCatClient.getValueDetailsAsync( @@ -242,7 +242,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. For simple targeting: diff --git a/website/docs/sdk-reference/js.md b/website/docs/sdk-reference/js.md index 600aa03f..a0bdebd2 100644 --- a/website/docs/sdk-reference/js.md +++ b/website/docs/sdk-reference/js.md @@ -18,7 +18,7 @@ export const JavaScriptSchema = require('@site/src/schema-markup/sdk-reference/j [![JSDELIVR](https://data.jsdelivr.com/v1/package/npm/configcat-js/badge)](https://www.jsdelivr.com/package/npm/configcat-js) :::info -For JavaScript SSR (Server-Side Rendered) applications we recommend using [ConfigCat JS-SSR SDK](js-ssr.md). +For JavaScript SSR (Server-Side Rendered) applications we recommend using [ConfigCat JS-SSR SDK](/sdk-reference/js-ssr). ::: ConfigCat JavaScript SDK on GitHub @@ -126,7 +126,7 @@ The available options depends on the chosen polling mode. However, there are som | `logger` | Custom [`IConfigCatLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) implementation for tracing. | [`ConfigCatConsoleLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) (with WARN level) | | `requestTimeoutMs` | The amount of milliseconds the SDK waits for a response from the ConfigCat servers before returning values from the cache. | 30000 | | `baseUrl` | Sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | | -| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | +| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | | `cache` | Custom [`IConfigCatCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) implementation for caching the downloaded config. | [`InMemoryConfigCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) | | `flagOverrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides). | - | | `defaultUser` | Sets the default user. [More about default user](#default-user). | `undefined` (none) | @@ -162,7 +162,7 @@ Returns a Promise with the value. | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const value = await configCatClient.getValueAsync( @@ -219,7 +219,7 @@ If you specify an allowed type but it mismatches the setting kind, an error mess | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const details = await configCatClient.getValueDetailsAsync( @@ -264,7 +264,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. For simple targeting: diff --git a/website/docs/sdk-reference/kotlin.md b/website/docs/sdk-reference/kotlin.md index 2adcf041..a9d07db3 100644 --- a/website/docs/sdk-reference/kotlin.md +++ b/website/docs/sdk-reference/kotlin.md @@ -108,7 +108,7 @@ These are the available options on the `ConfigCatOptions` class: | Properties | Type | Description | | ---------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `dataGovernance` | `DataGovernance` | Optional, defaults to `DataGovernance.GLOBAL`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `DataGovernance.GLOBAL`, `DataGovernance.EU_ONLY`. | +| `dataGovernance` | `DataGovernance` | Optional, defaults to `DataGovernance.GLOBAL`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `DataGovernance.GLOBAL`, `DataGovernance.EU_ONLY`. | | `baseUrl` | `String` | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | | `requestTimeout` | `Duration` | Optional, defaults to `30s`. Sets the underlying HTTP client's request timeout. [More about HTTP Timeout](#http-timeout). | | `configCache` | `ConfigCache` | Optional, sets a custom cache implementation for the client. [More about cache](#custom-cache). | @@ -134,7 +134,7 @@ These clients can be closed all at once with the `ConfigCatClient.closeAll()` me | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```kotlin val value = client.getValue( @@ -152,7 +152,7 @@ val value = client.getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```kotlin val details = client.getValueDetails( @@ -177,7 +177,7 @@ The details result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```kotlin val user = ConfigCatUser(identifier = "#UNIQUE-USER-IDENTIFIER#") diff --git a/website/docs/sdk-reference/node.md b/website/docs/sdk-reference/node.md index ae3993cc..a566b108 100644 --- a/website/docs/sdk-reference/node.md +++ b/website/docs/sdk-reference/node.md @@ -16,7 +16,7 @@ export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.js [![Node.JS](https://img.shields.io/node/v/configcat-node)](https://img.shields.io/node/v/configcat-node) :::info -For JavaScript SSR (Server-Side Rendered) applications we recommend using [ConfigCat JS-SSR SDK](js-ssr.md). +For JavaScript SSR (Server-Side Rendered) applications we recommend using [ConfigCat JS-SSR SDK](/sdk-reference/js-ssr). ::: ConfigCat Node.js SDK on GitHub @@ -109,7 +109,7 @@ The available options depends on the chosen polling mode. However, there are som | `requestTimeoutMs` | The amount of milliseconds the SDK waits for a response from the ConfigCat servers before returning values from the cache. | 30000 | | `baseUrl` | Sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | | | `proxy` | Proxy settings. [More about the proxy settings](#using-configcat-behind-a-proxy). | | -| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | +| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | | `cache` | Custom [`IConfigCatCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) implementation for caching the downloaded config. | [`InMemoryConfigCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) | | `flagOverrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides). | - | | `defaultUser` | Sets the default user. [More about default user](#default-user). | `undefined` (none) | @@ -145,7 +145,7 @@ Returns a Promise with the value. | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const value = await configCatClient.getValueAsync( @@ -202,7 +202,7 @@ If you specify an allowed type but it mismatches the setting kind, an error mess | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```js const details = await configCatClient.getValueDetailsAsync( @@ -247,7 +247,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. For simple targeting: diff --git a/website/docs/sdk-reference/overview.md b/website/docs/sdk-reference/overview.md index 9e14c785..969ab747 100644 --- a/website/docs/sdk-reference/overview.md +++ b/website/docs/sdk-reference/overview.md @@ -10,57 +10,57 @@ Check out our language specificGitHub repository of the ConfigCat .NET SDK. ## C++ -- [Documentation](sdk-reference/cpp.md) on how to connect your application. +- [Documentation](/sdk-reference/cpp) on how to connect your application. - GitHub repository of the ConfigCat C++ SDK. ## Dart (Flutter) -- [Documentation](sdk-reference/dart.md) on how to connect your application. +- [Documentation](/sdk-reference/dart) on how to connect your application. - GitHub repository of the ConfigCat Dart (Flutter) SDK. ## Elixir -- [Documentation](sdk-reference/elixir.md) on how to connect your application. +- [Documentation](/sdk-reference/elixir) on how to connect your application. - GitHub repository of the ConfigCat Elixir SDK. ## Go -- [Documentation](sdk-reference/go.md) on how to connect your application. +- [Documentation](/sdk-reference/go) on how to connect your application. - GitHub repository of the ConfigCat Go SDK. ## Java -- [Documentation](sdk-reference/java.md) on how to connect your application. +- [Documentation](/sdk-reference/java) on how to connect your application. - GitHub repository of the ConfigCat Java SDK. ## Java (Android) -- [Documentation](sdk-reference/android.md) on how to connect your application. +- [Documentation](/sdk-reference/android) on how to connect your application. - GitHub repository of the ConfigCat Android (Java) SDK. ## JavaScript -- [Documentation](sdk-reference/js.md) on how to connect your application. +- [Documentation](/sdk-reference/js) on how to connect your application. - GitHub repository of the ConfigCat JavaScript SDK. ## JavaScript (Deno) - Community maintained -- [Documentation](sdk-reference/community/deno.md) on how to connect your application. +- [Documentation](/sdk-reference/community/deno) on how to connect your application. - GitHub repository of the ConfigCat Deno SDK. ## JavaScript (React) -- [Documentation](sdk-reference/react.md) on how to connect your application. +- [Documentation](/sdk-reference/react) on how to connect your application. - GitHub repository of the ConfigCat React SDK. ## JavaScript (Server-Side Rendered apps) -- [Documentation](sdk-reference/js-ssr.md) on how to connect your application. +- [Documentation](/sdk-reference/js-ssr) on how to connect your application. - GitHub repository of the ConfigCat JS SSR SDK. ## JavaScript (Chromium Extension) @@ -69,35 +69,35 @@ Check out our language specificGitHub repository of the ConfigCat Kotlin Multiplatform SDK. ## Node.js -- [Documentation](sdk-reference/node.md) on how to connect your application. +- [Documentation](/sdk-reference/node) on how to connect your application. - GitHub repository of the ConfigCat Node SDK. ## PHP -- [Documentation](sdk-reference/php.md) on how to connect your application. +- [Documentation](/sdk-reference/php) on how to connect your application. - GitHub repository of the ConfigCat PHP SDK. ## PHP (Laravel) - Community maintained -- [Documentation](sdk-reference/community/laravel.md) on how to connect your application. +- [Documentation](/sdk-reference/community/laravel) on how to connect your application. - GitHub repository of the Laravel ConfigCat package. ## Python -- [Documentation](sdk-reference/python.md) on how to connect your application. +- [Documentation](/sdk-reference/python) on how to connect your application. - GitHub repository of the ConfigCat Python SDK. ## Ruby -- [Documentation](sdk-reference/ruby.md) on how to connect your application. +- [Documentation](/sdk-reference/ruby) on how to connect your application. - GitHub repository of the ConfigCat Ruby SDK. ## Swift (iOS) -- [Documentation](sdk-reference/ios.md) on how to connect your application. +- [Documentation](/sdk-reference/ios) on how to connect your application. - GitHub repository of the ConfigCat Swift SDK. diff --git a/website/docs/sdk-reference/php.md b/website/docs/sdk-reference/php.md index 00d52e9c..32a25af5 100644 --- a/website/docs/sdk-reference/php.md +++ b/website/docs/sdk-reference/php.md @@ -61,7 +61,7 @@ Available options: | Name | Type | Description | | ------------------------ | ----- | ------------ | -| `data-governance` | `int` | Optional, defaults to `DataGovernance::GLOBAL_`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `GLOBAL_`, `EU_ONLY`. | +| `data-governance` | `int` | Optional, defaults to `DataGovernance::GLOBAL_`. Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `GLOBAL_`, `EU_ONLY`. | | `logger` | [`\Psr\Log\LoggerInterface`](https://github.com/php-fig/log/blob/master/src/LoggerInterface.php) | Optional, sets the logger for errors and warnings produced by the SDK, defaults to [Monolog](https://github.com/Seldaek/monolog). [More about logging](#logging). | | `log-level` | `int` | Optional, defaults to `LogLevel::WARNING`. Sets the internal log level. [More about log levels](#logging). | | `cache` | [`\ConfigCat\Cache\ConfigCache`](https://github.com/configcat/php-sdk/blob/master/src/Cache/ConfigCache.php) | Optional, sets a `\ConfigCat\Cache\ConfigCache` implementation for caching the latest feature flag and setting values. [More about cache](#cache). You can check the currently available implementations [here](https://github.com/configcat/php-sdk/tree/master/src/Cache). | @@ -93,7 +93,7 @@ $client = new \ConfigCat\ConfigCatClient("#YOUR-SDK-KEY#", [ | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```php $value = $client->getValue( @@ -111,7 +111,7 @@ $value = $client->getValue( | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** The key of a specific setting or feature flag. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```php $details = $client->getValueDetails( @@ -136,7 +136,7 @@ The `details` result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```php $user = new \ConfigCat\User("#UNIQUE-USER-IDENTIFIER#"); @@ -322,7 +322,7 @@ It allows the usage of all features you can do on the ConfigCat Dashboard. You can download your current config JSON from ConfigCat's CDN and use it as a baseline. -The URL to your current config JSON is based on your [Data Governance](advanced/data-governance.md) settings: +The URL to your current config JSON is based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` diff --git a/website/docs/sdk-reference/python.md b/website/docs/sdk-reference/python.md index 705fb7d4..026f3ba2 100644 --- a/website/docs/sdk-reference/python.md +++ b/website/docs/sdk-reference/python.md @@ -79,7 +79,7 @@ _ConfigCat Client_ is responsible for: | `connect_timeout_seconds` | The number of seconds to wait for the server to make the initial connection (i.e. completing the TCP connection handshake). | 10 | | `read_timeout_seconds` | The number of seconds to wait for the server to respond before giving up. | 30 | | `flag_overrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides) | None | -| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `Global`, `EuOnly`. | `Global`| +| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `Global`, `EuOnly`. | `Global`| | `default_user` | Sets the default user. [More about default user](#default-user). | None | | `hooks` | Used to subscribe events that the SDK sends in specific scenarios. [More about hooks](#hooks). | None | | `offline` | Indicates whether the SDK should be initialized in offline mode. [More about offline mode](#online--offline-mode). | False | @@ -105,7 +105,7 @@ These clients can be closed all at once with the `configcatclient.close_all()` m | --------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `default_value` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```python value = client.get_value( @@ -124,7 +124,7 @@ object with more detailed information about the evaluation result. | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```python details = client.get_value_details( @@ -150,7 +150,7 @@ The details result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```python user_object = User('#UNIQUE-USER-IDENTIFIER#') @@ -454,9 +454,9 @@ and execute the following command: configcat config-json get -f v6 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v6.json` @@ -604,9 +604,9 @@ and execute the following command: configcat config-json get -f v5 -p {YOUR-SDK-KEY} > config.json ``` -(Depending on your [Data Governance](advanced/data-governance.md) settings, you may need to add the `--eu` switch.) +(Depending on your [Data Governance](/advanced/data-governance) settings, you may need to add the `--eu` switch.) -Alternatively, you can download the config JSON manually, based on your [Data Governance](advanced/data-governance.md) settings: +Alternatively, you can download the config JSON manually, based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` @@ -750,7 +750,7 @@ Evaluates and returns the values of all feature flags and settings. Passing a [U | Parameters | Description | | ---------- | ------------------------------------------------------------------------------------------------------------ | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```python client = configcatclient.get('#YOUR-SDK-KEY#') diff --git a/website/docs/sdk-reference/react.md b/website/docs/sdk-reference/react.md index 8607bf98..ac64cfc3 100644 --- a/website/docs/sdk-reference/react.md +++ b/website/docs/sdk-reference/react.md @@ -131,7 +131,7 @@ The available options depends on the chosen polling mode. However, there are som | `logger` | Custom [`IConfigCatLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) implementation for tracing. | [`ConfigCatConsoleLogger`](https://github.com/configcat/common-js/blob/master/src/ConfigCatLogger.ts) (with WARN level) | | `requestTimeoutMs` | The amount of milliseconds the SDK waits for a response from the ConfigCat servers before returning values from the cache. | 30000 | | `baseUrl` | Sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. | | -| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | +| `dataGovernance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `DataGovernance.Global`, `DataGovernance.EuOnly`. | `DataGovernance.Global` | | `cache` | Custom [`IConfigCatCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) implementation for caching the downloaded config. | [`InMemoryConfigCache`](https://github.com/configcat/common-js/blob/master/src/ConfigCatCache.ts) | | `flagOverrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides). | - | | `defaultUser` | Sets the default user. [More about default user](#default-user). | `undefined` (none) | @@ -167,7 +167,7 @@ The SDK supports two ways to acquire the initialized ConfigCat instance: | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```tsx function ButtonComponent() { @@ -314,7 +314,7 @@ A helper function to get the value of a feature flag. | -------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `defaultValue` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```tsx class TestHOCComponent extends React.Component< @@ -369,7 +369,7 @@ The timestamp of when the config was last updated. ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. For simple targeting: diff --git a/website/docs/sdk-reference/ruby.md b/website/docs/sdk-reference/ruby.md index 14c30a9b..9c531ff3 100644 --- a/website/docs/sdk-reference/ruby.md +++ b/website/docs/sdk-reference/ruby.md @@ -78,7 +78,7 @@ _ConfigCat Client_ is responsible for: | `open_timeout_seconds` | The number of seconds to wait for the server to make the initial connection (i.e. completing the TCP connection handshake). | 10 | | `read_timeout_seconds` | The number of seconds to wait for the server to respond before giving up. | 30 | | `flag_overrides` | Local feature flag & setting overrides. [More about feature flag overrides](#flag-overrides) | nil | -| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](advanced/data-governance.md). Available options: `GLOBAL`, `EU_ONLY`. | `GLOBAL` | +| `data_governance` | Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. [More about Data Governance](/advanced/data-governance). Available options: `GLOBAL`, `EU_ONLY`. | `GLOBAL` | | `default_user` | Sets the default user. [More about default user](#default-user). | nil | | `hooks` | Used to subscribe events that the SDK sends in specific scenarios. [More about hooks](#hooks). | nil | | `offline` | Indicates whether the SDK should be initialized in offline mode. [More about offline mode](#online--offline-mode). | false | @@ -103,7 +103,7 @@ These clients can be closed all at once with the `ConfigCat.close_all` method or | --------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `default_value` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```ruby value = client.get_value( @@ -122,7 +122,7 @@ object with more detailed information about the evaluation result. | --------------- | ------------------------------------------------------------------------------------------------------------ | | `key` | **REQUIRED.** Setting-specific key. Set on _ConfigCat Dashboard_ for each setting. | | `default_value` | **REQUIRED.** This value will be returned in case of an error. | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```ruby details = client.get_value_details( @@ -147,7 +147,7 @@ The details result contains the following information: ## User Object -The [User Object](../advanced/user-object.md) is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature. +The [User Object](/advanced/user-object) is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature. ```ruby user_object = ConfigCat::User.new('#UNIQUE-USER-IDENTIFIER#') @@ -401,7 +401,7 @@ It allows the usage of all features you can do on the ConfigCat Dashboard. You can download your current config JSON from ConfigCat's CDN and use it as a baseline. -The URL to your current config JSON is based on your [Data Governance](advanced/data-governance.md) settings: +The URL to your current config JSON is based on your [Data Governance](/advanced/data-governance) settings: - GLOBAL: `https://cdn-global.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` - EU: `https://cdn-eu.configcat.com/configuration-files/{YOUR-SDK-KEY}/config_v5.json` @@ -539,7 +539,7 @@ Evaluates and returns the values of all feature flags and settings. Passing a [U | Parameters | Description | | ---------- | ------------------------------------------------------------------------------------------------------------ | -| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](advanced/targeting.md) | +| `user` | Optional, _User Object_. Essential when using Targeting. [Read more about Targeting.](/advanced/targeting) | ```ruby client = ConfigCat.get('#YOUR-SDK-KEY#')