Add video and refactor page #941
Conversation
Deploying devcycle-docs with
|
| Latest commit: |
d3070ff
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://720474fa.devcycle-docs.pages.dev |
| Branch Preview URL: | https://add-feature-importer-video-t.devcycle-docs.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR refactors the Feature Flag Importer documentation page by updating terminology for consistency, improving formatting, and adding a tutorial video. The changes primarily focus on standardizing capitalization (Project, Feature, Variable, etc.) throughout the document and restructuring the page layout.
Key Changes:
- Added a "Tutorial Video" section with a YouTube link
- Standardized capitalization of domain-specific terms (Project, Feature, Variable, Environment, etc.)
- Improved formatting of configuration examples and section headers
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [Required](#required) | ||
| - [Optional](#optional) | ||
| - [Code Migration](#code-migration) | ||
| https://youtu.be/xGpBF67ue6Y |
There was a problem hiding this comment.
The video link should be embedded using proper Markdown format or documentation-specific video embedding syntax. A plain URL without any formatting may not render correctly in the documentation.
| https://youtu.be/xGpBF67ue6Y | |
| [Watch the tutorial video on YouTube](https://youtu.be/xGpBF67ue6Y) |
|
|
||
| :::info | ||
| The feature importer script is fully open-source. Check it out here: https://github.com/devcyclehq/feature-importer | ||
| The Feature importer script is fully open-source. Check it out here: https://github.com/devcyclehq/feature-importer |
There was a problem hiding this comment.
Inconsistent capitalization: "Feature importer" should be "Feature Flag Importer" to match the title and other references in the document.
| ### Configuration File | ||
|
|
||
| The feature importer can be configured using environment variables or a JSON config file. | ||
| The Feature importer can be configured using environment Variables or a JSON config file. |
There was a problem hiding this comment.
Inconsistent capitalization: "Feature importer" should be "Feature Flag Importer" to match the title and other references in the document.
| The Feature importer can be configured using environment Variables or a JSON config file. | |
| The Feature Flag Importer can be configured using environment Variables or a JSON config file. |
| ### Configuration File | ||
|
|
||
| The feature importer can be configured using environment variables or a JSON config file. | ||
| The Feature importer can be configured using environment Variables or a JSON config file. |
There was a problem hiding this comment.
Inconsistent capitalization: "environment Variables" should be "environment variables" (lowercase 'v'). Environment variables is a technical term that should not have 'Variables' capitalized in this context.
| The Feature importer can be configured using environment Variables or a JSON config file. | |
| The Feature importer can be configured using environment variables or a JSON config file. |
|
|
||
| :::info | ||
| The feature importer only supports LaunchDarkly API Version `20220603`. Please select this version when creating an API access token in LaunchDarkly. | ||
| The Feature importer only supports LaunchDarkly API Version `20220603`. Please select this version when creating an API access token in LaunchDarkly. |
There was a problem hiding this comment.
Inconsistent capitalization: "Feature importer" should be "Feature Flag Importer" to match the title and other references in the document.
| </p> | ||
| <p> | ||
| Further, if you'd like to create a new tool or integration, a great starting point is <a href="/management-api/">DevCycle's Management API</a> which allows you to modify and interact with features and more within a devcycle project, as well as the <a href="/bucketing-api/">DevCycle Bucketing API</a> which is used to give users features and variables (as used within the DevCycle SDKs!) | ||
| Further, if you'd like to create a new tool or integration, a great starting point is <a href="/management-api/">DevCycle's Management API</a> which allows you to modify and interact with Features and more within a Devcycle Project, as well as the <a href="/bucketing-api/">DevCycle Bucketing API</a> which is used to give users Features and Variables (as used within the DevCycle SDKs!) |
There was a problem hiding this comment.
Typo: "Devcycle" should be "DevCycle" with consistent capitalization.
| Further, if you'd like to create a new tool or integration, a great starting point is <a href="/management-api/">DevCycle's Management API</a> which allows you to modify and interact with Features and more within a Devcycle Project, as well as the <a href="/bucketing-api/">DevCycle Bucketing API</a> which is used to give users Features and Variables (as used within the DevCycle SDKs!) | |
| Further, if you'd like to create a new tool or integration, a great starting point is <a href="/management-api/">DevCycle's Management API</a> which allows you to modify and interact with Features and more within a DevCycle Project, as well as the <a href="/bucketing-api/">DevCycle Bucketing API</a> which is used to give users Features and Variables (as used within the DevCycle SDKs!) |
| - In LaunchDarkly, the primary identifier is `key`, in DVC the equivalent value should be passed as `user_id` | ||
| - DVC supports the following top-level properties on the user object: see [DVC User Object](/sdk/client-side-sdks/javascript/javascript-gettingstarted#devcycleuser-object). | ||
| Any other properties used for targeting should be passed within the `customData` map. | ||
| Any other properties used for Targeting should be passed within the `customData` map. |
There was a problem hiding this comment.
Inconsistent capitalization: "Targeting" should be lowercase "targeting" to match standard technical documentation style. The term "targeting" is used in lowercase elsewhere in the document (e.g., line 102).
| Any other properties used for Targeting should be passed within the `customData` map. | |
| Any other properties used for targeting should be passed within the `customData` map. |
| Any other properties used for Targeting should be passed within the `customData` map. | ||
| - If you are passing a date to be used with LD's before/after operators, the value should be converted to a Long when passed to DVC. The importer will convert `before` & `after` operators to `<` & `>` in DVC. | ||
| - DVC doesn't support targeting by the top-level `isAnonymous` property. If you are using LD's targeting with the `anonymous` attribute, make sure to include an `anonymous` property in the user's `customData` | ||
| - DVC doesn't support Targeting by the top-level `isAnonymous` property. If you are using LD's Targeting with the `anonymous` attribute, make sure to include an `anonymous` property in the user's `customData` |
There was a problem hiding this comment.
Inconsistent capitalization: "Targeting" should be lowercase "targeting" to match standard technical documentation style. The term "targeting" is used in lowercase elsewhere in the document (e.g., line 102).
| - DVC doesn't support Targeting by the top-level `isAnonymous` property. If you are using LD's Targeting with the `anonymous` attribute, make sure to include an `anonymous` property in the user's `customData` | |
| - DVC doesn't support targeting by the top-level `isAnonymous` property. If you are using LD's targeting with the `anonymous` attribute, make sure to include an `anonymous` property in the user's `customData` |
No description provided.