Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Change API links to full urls #802

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Change API links to full urls #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/best-practices/edgedb-and-edge-flags/edge-db-via-api-simple.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ First, enable EdgeDB in your project’s settings.

![Project Settings]Now, let's save some data to EdgeDB.

To do this, we’ll be following the EdgeDB docs from the [Bucketing API](/bucketing-api/#tag/EdgeDB).
To do this, we’ll be following the EdgeDB docs from the [Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/EdgeDB).
Copy link
Member

Choose a reason for hiding this comment

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

Won't this break testing locally?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea it does but I'm not sure how to fix these otherwise. Should we hold off?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another way to go about these broken anchors is to use HTML. So the above would look like...

To do this, we’ll be following the EdgeDB docs from the <a href="/bucketing-api/#tag/EdgeDB">Bucketing API</a>.

The link works, docusaurus doesn't complain and you can still test locally. However, this looks like it bypasses the broken link detection which is also not great.

Copy link
Member

Choose a reason for hiding this comment

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

Do these links work locally / prod? like they look correct to me why is the broken link detection even triggering for them?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, they all work in local and prod. I'm not sure why Docusaurus flags them, but both the API docs and CLI docs are generated by plugins so it's likely related to that.


In this case, we will update a user simply called “example_user”

Expand Down Expand Up @@ -86,7 +86,7 @@ And then we want to target the “special” users as we set up above.

![Targeting Rule Setup](/sept-6-2022-edge-flags-api-8.png)

Enable this feature for your environment, and save it, and now we can test for this user’s features using the [get variables feature in the Bucketing API](/bucketing-api/#tag/Bucketing-API/operation/getVariables)
Enable this feature for your environment, and save it, and now we can test for this user’s features using the [get variables feature in the Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getVariables)

One thing to note is that there must be an `enableEdgeDB=true` flag

Expand Down
2 changes: 1 addition & 1 deletion docs/best-practices/edgedb-and-edge-flags/import-from-anywhere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Super Segments are collections of users that are targeted by data from any exter

This means that users or their data can be “imported” into DevCycle for targeting in experiments or features by making use of EdgeDB.

While this can all be handled via the [EdgeDB API](/bucketing-api/#tag/EdgeDB), as outlined in [here](/platform/feature-flags/targeting/edgedb), DevCycle has created a Zapier integration which allows for easy sending of data directly to the desired EdgeDB environment in a project. This makes connecting any tools (like [Amplitude](https://amplitude.com/), [Segment](https://segment.com/) and others) with Zapier integrations directly to DevCycle extremely simple!
While this can all be handled via the [EdgeDB API](https://docs.devcycle.com/bucketing-api/#tag/EdgeDB), as outlined in [here](/platform/feature-flags/targeting/edgedb), DevCycle has created a Zapier integration which allows for easy sending of data directly to the desired EdgeDB environment in a project. This makes connecting any tools (like [Amplitude](https://amplitude.com/), [Segment](https://segment.com/) and others) with Zapier integrations directly to DevCycle extremely simple!

## Salesforce Guide

Expand Down
4 changes: 2 additions & 2 deletions docs/best-practices/security/compromised-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To generate new SDK keys for the affected environment, use the **`SdkKeysControl

Replace **`{project}`** with the Project key or ID, and **`{environment}`** with the environment key or ID.

The request body should follow the schema **`GenerateSdkTokensDto`**. Please refer to the **[API documentation](/management-api/#tag/Environments/operation/SdkKeysController_generate)** for more details.
The request body should follow the schema **`GenerateSdkTokensDto`**. Please refer to the **[API documentation](https://docs.devcycle.com/management-api/#tag/Environments/operation/SdkKeysController_generate)** for more details.

### **Replace Compromised SDK Keys in Your Application**

Expand All @@ -52,7 +52,7 @@ To invalidate the compromised SDK keys, use the **`SdkKeysController_invalidate`

Replace **`{project}`** with the Project key or ID, **`{environment}`** with the environment key or ID, and **`{key}`** with the compromised SDK key.

Please refer to the **[API documentation](/management-api/#tag/Environments/operation/SdkKeysController_invalidate)** for more details.
Please refer to the **[API documentation](https://docs.devcycle.com/management-api/#tag/Environments/operation/SdkKeysController_invalidate)** for more details.
After invalidation - the token is no longer available for use - and any future requests with the token will fail as the configuration attached to it has been deleted. Be aware the older versions of mobile/client applications may now return the default as the token they have is invalid.


Expand Down
2 changes: 1 addition & 1 deletion docs/platform/feature-flags/targeting/custom-properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The property _key_ is what will be used for matching while bucketing users.
**DevCycle Key**

This is an auto-generated field based on the property key.
This is the key that can be used to reference the property in the [DevCycle Management API](/management-api/#tag/Custom-Properties).
This is the key that can be used to reference the property in the [DevCycle Management API](https://docs.devcycle.com/management-api/#tag/Custom-Properties).

## Using an existing Property

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/feature-flags/variables-and-variations/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Removing a Variable from this page does not completely remove the Variable from
Taking this action will cause all references to the Variable in any code usage to default only to the default value used in your codebase.

:::info
To fully delete a Variable you must do so via our [Management API](/management-api/#tag/Variables/operation/VariablesController_remove).
To fully delete a Variable you must do so via our [Management API](https://docs.devcycle.com/management-api/#tag/Variables/operation/VariablesController_remove).
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/server-side-sdks/dotnet/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

# DevCycle .NET / C# SDK

The DevCycle .NET / C# SDK has two operation modes; Cloud Bucketing - which interfaces with the [DevCycle Bucketing API](/bucketing-api/#tag/Bucketing-API),
The DevCycle .NET / C# SDK has two operation modes; Cloud Bucketing - which interfaces with the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API),
and Local Bucketing - which performs bucketing locally.

We recommend using the Local Bucketing mode by default, as it performs fast local evaluations of your feature flags.
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/server-side-sdks/node/node-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To grab all the segmented variables for a user:
const variables = devcycleClient.allVariables(user)
```

See [getVariables](/bucketing-api/#tag/Bucketing-API/operation/getVariables) on the Bucketing API for the variable response format.
See [getVariables](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getVariables) on the Bucketing API for the variable response format.

:::caution

Expand All @@ -79,7 +79,7 @@ You can fetch all segmented features for a user:
const features = devcycleClient.allFeatures(user)
```

See [getFeatures](/bucketing-api/#tag/Bucketing-API/operation/getFeatures) on the Bucketing API for the feature response format.
See [getFeatures](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getFeatures) on the Bucketing API for the feature response format.

## Tracking User Events

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/server-side-sdks/php/php-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ try {

The default value can be of type string, boolean, number, or object.

If you would like to get the full Variable object defined by [getVariableByKey](/bucketing-api/#tag/Bucketing-API/operation/getVariableByKey)
If you would like to get the full Variable object defined by [getVariableByKey](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getVariableByKey)
you can use `variable()` instead of `variableValue()`.

## Get all Variables
Expand All @@ -57,7 +57,7 @@ try {
}
```

See [getVariables](/bucketing-api/#tag/Bucketing-API/operation/getVariables) on the Bucketing API for the variable response format.
See [getVariables](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getVariables) on the Bucketing API for the variable response format.

:::caution

Expand All @@ -79,7 +79,7 @@ try {
}
```

See [getFeatures](/bucketing-api/#tag/Bucketing-API/operation/getFeatures) on the Bucketing API for the feature response format.
See [getFeatures](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/operation/getFeatures) on the Bucketing API for the feature response format.

## Track Event

Expand Down