Skip to content

Commit

Permalink
url fixes (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
laliconfigcat authored Jan 18, 2024
1 parent 750c5e9 commit fc5da47
Show file tree
Hide file tree
Showing 29 changed files with 151 additions and 151 deletions.
4 changes: 2 additions & 2 deletions website/docs/advanced/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a target="_blank" href="https://github.com/configcat/cli">ConfigCat Command Line Interface (CLI)</a> 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 <a target="_blank" href="https://github.com/configcat/cli">ConfigCat Command Line Interface (CLI)</a> 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 <a target="_blank" href="https://github.com/configcat/cli">ConfigCat Command Line Interface (CLI)</a> 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 <a target="_blank" href="https://github.com/configcat/cli">ConfigCat Command Line Interface (CLI)</a> 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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced/config-v2-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions website/docs/advanced/public-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -66,7 +66,7 @@ You can create clients easily using <a href="https://github.com/OpenAPITools/ope
## Throttling and rate limits

> Do not use this API for accessing and evaluating feature flag values. Use the
> [SDKs instead](sdk-reference/overview.md).
> [SDKs instead](/sdk-reference/overview).
`HTTP 429 - Too many requests` status is returned in case throttling gets activated, along
with a reason message with details.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/advanced/targeting.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ All other cases: OFF

### To all other users, serve

This value will be served as a fallback if none of the above rules apply or a [`User Object`](advanced/user-object.md) is not passed to the [ConfigCat SDK](sdk-reference/overview.md) correctly within your application.
This value will be served as a fallback if none of the above rules apply or a [`User Object`](/advanced/user-object) is not passed to the [ConfigCat SDK](/sdk-reference/overview) correctly within your application.

## Targeting a percentage of users

Expand Down Expand Up @@ -294,4 +294,4 @@ When the Setting Kind is _Text_, _Whole Number_, or _Decimal Number_ the maximum
### All other cases

This value will be served as a fallback if none of the above rules apply or a [`User Object`](advanced/user-object.md) was not passed to the [ConfigCat SDK](sdk-reference/overview.md) correctly within your application.
This value will be served as a fallback if none of the above rules apply or a [`User Object`](/advanced/user-object) was not passed to the [ConfigCat SDK](/sdk-reference/overview) correctly within your application.
4 changes: 2 additions & 2 deletions website/docs/advanced/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ First, you can verify on the [Service Status Monitor](https://status.configcat.c
1. It might be a good idea to update the ConfigCat SDK to the latest version.
1. Check if you configured the [Data Governance](/advanced/data-governance) functionality properly.
1. Singleton: We strongly recommend using the ConfigCat SDK as a Singleton. Initializing the SDK over and over again can cause serious performance issues in production. If you want to use multiple SDK Keys in the same application, create only one _ConfigCat Client_ per SDK Key.
1. Are you using the proper polling mode for your use case? Details on polling modes in the [SDK Docs](/sdk-reference/overview.md).
1. Might be a too frequent `Auto Polling` interval. Please check the [SDK Docs](/sdk-reference/overview.md).
1. Are you using the proper polling mode for your use case? Details on polling modes in the [SDK Docs](/sdk-reference/overview).
1. Might be a too frequent `Auto Polling` interval. Please check the [SDK Docs](/sdk-reference/overview).
1. In `Manual Polling` mode, it could be a too frequent `forceRefresh()` call in your code, making the SDK download the config JSON often.
1. You can try one of our lightweight sample applications to rule out local issues. Find in the [repository of each SDK](https://github.com/configcat).

Expand Down
12 changes: 6 additions & 6 deletions website/docs/advanced/user-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ description: The user object lets you target users based on their properties wit
---

The _User Object_ is an optional parameter when getting a feature flag or setting value from ConfigCat.
It allows you to pass potential [Targeting rule](advanced/targeting.md) variables to the ConfigCat SDK.
It allows you to pass potential [Targeting rule](/advanced/targeting) variables to the ConfigCat SDK.
And represents a user in your application.

> The _User Object_ is essential if you'd like to use ConfigCat's [Targeting](advanced/targeting.md) feature.
> The _User Object_ is essential if you'd like to use ConfigCat's [Targeting](/advanced/targeting) feature.
## The relationship between User Object and Targeting rules

**As a product manager**, you can set [Targeting rules](advanced/targeting.md) on the <a href="https://app.configcat.com" target="_blank">ConfigCat Dashboard</a> based on the parameters given to ConfigCat by your application.
**As a product manager**, you can set [Targeting rules](/advanced/targeting) on the <a href="https://app.configcat.com" target="_blank">ConfigCat Dashboard</a> 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 <a href="https://app.configcat.com" target="_blank">ConfigCat Dashboard</a> 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 <a href="https://app.configcat.com" target="_blank">ConfigCat Dashboard</a> to apply [Targeting rules](/advanced/targeting) on.

### Example

Expand Down Expand Up @@ -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. |
Expand Down Expand Up @@ -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:
<img src="/docs/assets/custom-property-ui.png" className="zoomable" alt="customPropertyUsageDashboard" />
16 changes: 8 additions & 8 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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?

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://github.com/configcat" target="_blank">GitHub</a>.

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:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
26 changes: 13 additions & 13 deletions website/docs/integrations/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 3 additions & 3 deletions website/docs/purchase.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://configcat.com/pricing/" target="_blank">check out the pricing table</a>.

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

Expand All @@ -32,7 +32,7 @@ provide reports, review contracts or set up bank transfers.

You can purchase a ConfigCat subscription plan on the <a href="https://app.configcat.com/plans" target="_blank">Plans page</a>.
:::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
Expand All @@ -47,5 +47,5 @@ Credit card information is stored and managed by <a href="https://www.chargebee.

You can update your billing info on the <a href="https://app.configcat.com/organization/billing" target="_blank">Manage Billing page</a>.
:::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.
:::
Loading

0 comments on commit fc5da47

Please sign in to comment.