docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
28
www/apps/docs/content/development/feature-flags/overview.mdx
Normal file
28
www/apps/docs/content/development/feature-flags/overview.mdx
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
description: "Learn what feature flags in Medusa. Feature flags are used in Medusa to guard beta features that aren’t ready for live and production applications."
|
||||
---
|
||||
|
||||
import DocCard from '@theme/DocCard';
|
||||
import Icons from '@theme/Icon';
|
||||
|
||||
# Feature Flags
|
||||
|
||||
In this document, you’ll learn what feature flags in Medusa.
|
||||
|
||||
## Introduction
|
||||
|
||||
Feature flags are used in Medusa to guard beta features that aren’t ready for live and production applications. This allows the Medusa team to keep publishing releases more frequently, while also working on necessary future features behind the scenes. To use these beta features, you must enable their feature flags.
|
||||
|
||||
If a feature is guarded by a flag, entities, migrations, endpoints, and other resources associated with that feature are guarded by that flag as well. So, these resources will only be available to use in Medusa if you have enabled the associated feature flag.
|
||||
|
||||
You can view a list of available feature flags that you can toggle in [the Beta Features documentation](../../beta.md).
|
||||
|
||||
<DocCard item={{
|
||||
type: 'link',
|
||||
href: '/development/feature-flags/toggle',
|
||||
label: 'Toggle Feature Flags',
|
||||
customProps: {
|
||||
icon: Icons['academic-cap-solid'],
|
||||
description: 'Learn how to enable or disabled a feature flag.'
|
||||
}
|
||||
}} />
|
||||
83
www/apps/docs/content/development/feature-flags/toggle.md
Normal file
83
www/apps/docs/content/development/feature-flags/toggle.md
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
description: 'Learn how to toggle feature flags in Medusa. This guide explains the steps required to toggle a feature flag.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
# How to Toggle Feature Flags
|
||||
|
||||
In this document, you’ll learn about how to toggle feature flags.
|
||||
|
||||
:::info
|
||||
|
||||
If a feature flag is enabled/disabled by default, you don’t need to manually enable/disable it. Only set the feature flag’s value if it’s different than the default.
|
||||
|
||||
:::
|
||||
|
||||
## Enable Feature Flags
|
||||
|
||||
:::caution
|
||||
|
||||
Features guarded by feature flags are experimental and beta features. Enable them with caution.
|
||||
|
||||
:::
|
||||
|
||||
There are two ways to enable a feature flag.
|
||||
|
||||
### Method One: Using Environment Variables
|
||||
|
||||
You can enable a feature by setting the value of its environment variable to `true`. You can find [the name of a feature flag’s environment variable in the Beta Features documentation page](../../beta.md).
|
||||
|
||||
For example, to enable the Tax-Inclusive Pricing beta feature, add the following environment variable:
|
||||
|
||||
```bash
|
||||
MEDUSA_FF_TAX_INCLUSIVE_PRICING=true
|
||||
```
|
||||
|
||||
### Method Two: Using Backend Configurations
|
||||
|
||||
You can enable a feature by using the backend configurations in `medusa-config.js`. You can find [the feature flag’s key in the Beta Features documentation page](../../beta.md) it’s defined in. It is defined under the property `key` in the exported object.
|
||||
|
||||
For example, to enable the Tax-Inclusive Pricing beta feature, add the following to the exported object in `medusa-config.js`:
|
||||
|
||||
```js title=medusa-config.js
|
||||
module.exports = {
|
||||
featureFlags: {
|
||||
tax_inclusive_pricing: true,
|
||||
},
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
### Note About Precedence
|
||||
|
||||
The environment variable’s value has higher precedence over the backend configurations. So, if you use both these methods on your backend, the value of the environment variable will be used.
|
||||
|
||||
For example, if the value of the environment variable is set to `false`, but the value of the feature flag in the backend configurations is set to `true`, the feature flag will take the value of the environment variable and will be disabled.
|
||||
|
||||
### Running Migrations
|
||||
|
||||
As feature flags generally include adding new entities or making changes to entities in the database, you must run the migrations after enabling the feature flag:
|
||||
|
||||
```bash
|
||||
npx medusa migrations run
|
||||
```
|
||||
|
||||
:::info
|
||||
|
||||
You can learn more about migrations in this documentation.
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Disable Feature Flags
|
||||
|
||||
Disabling feature flags follows the same process as enabling the feature flags. All you have to do is change the value in the environment variables or the backend configurations to `false`.
|
||||
|
||||
Once you disable a feature flag, all endpoints, entities, services, or other related classes and functionalities are disabled.
|
||||
|
||||
### Revert Migrations
|
||||
|
||||
If you had the feature flag previously enabled, and you want to disable this feature flag completely, you might need to revert the migrations you ran when you enabled it.
|
||||
|
||||
You can follow [this documentation to learn how to revert the last migration you ran](../../cli/reference.mdx#migrations).
|
||||
Reference in New Issue
Block a user