Skip to content

Standardize csv wording in docs #790

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

Merged
ComfortablyCoding merged 2 commits into from
Jul 29, 2026
Merged

Standardize csv wording in docs #790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee9dd07
Make metrics tokens and services variables easier to understand
djigoio Jul 29, 2026
373c1ef
improve consistency
ComfortablyCoding Jul 29, 2026
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
2 changes: 1 addition & 1 deletion content/community/3.codebase/3.testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ pnpm --filter tests-blackbox test --project db

### Testing Specific Database Vendors

Provide a CSV of database vendors via the `TEST_DB` environment variable to target only a specific subset:
Provide a comma-separated list of database vendors via the `TEST_DB` environment variable to target only a specific subset:

```bash
# Example targeting multiple vendors
Expand Down
2 changes: 1 addition & 1 deletion content/configuration/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ description: Configuration for database connections.
| `DB_PASSWORD` | Database user's password. Required when using `pg`, `mysql`, `oracledb`, or `mssql`. | |
| `DB_FILENAME` | Where to read/write the SQLite database. Required when using `sqlite3`. | |
| `DB_CONNECTION_STRING` | When using `pg`, you can submit a connection string instead of individual properties. Using this will ignore any of the other connection settings. | |
| `DB_EXCLUDE_TABLES` | CSV of tables you want Directus to ignore completely | `spatial_ref_sys,sysdiagrams` |
| `DB_EXCLUDE_TABLES` | A comma-separated list of tables for Directus to ignore completely. | `spatial_ref_sys,sysdiagrams` |
| `DB_CHARSET` / `DB_CHARSET_NUMBER` | Charset/collation to use in the connection to MySQL<sup>[1](https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html)</sup>/MariaDB<sup>[2](https://mariadb.com/docs/server/reference/data-types/string-data-types/character-sets/supported-character-sets-and-collations)</sup>. | `UTF8_GENERAL_CI` |
| `DB_VERSION` | Database version, in case you use the PostgreSQL adapter to connect a non-standard database. Not usually required. | |
| `DB_HEALTHCHECK_THRESHOLD` | Healthcheck timeout threshold in milliseconds. | `150` |
Expand Down
2 changes: 1 addition & 1 deletion content/configuration/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the Data Studio, files will automatically be uploaded to the first configured

| Variable | Description | Default Value |
| ------------------- | --------------------------------------------------------------------------------------------- | ------------- |
| `STORAGE_LOCATIONS` | A comma separated list of storage locations. You can use any names you'd like for these keys. | `local` |
| `STORAGE_LOCATIONS` | A comma-separated list of storage locations. You can use any names you'd like for these keys. | `local` |

For each of the storage locations listed, you must provide the following configuration (variable name must be uppercase in these options):

Expand Down
16 changes: 8 additions & 8 deletions content/configuration/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ description: Configuration for metrics.

To enable performance and error measurement of connected services, Directus can provide Prometheus metrics.

| Variable | Description | Default Value |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `METRICS_ENABLED` | Whether or not to enable metrics. | `false` |
| `METRICS_SCHEDULE` | The cron schedule at which to generate the metrics, the default is every minute | `*/1 * * * *` |
| `METRICS_TOKENS` | A CSV of tokens to allow access to via a `Authorization: Metrics <token>` header. By default it is restricted to admins | -- |
| `METRICS_SERVICES` | A CSV of directus services to observe metrics for. Currently `database`, `cache`, `redis` and `storage` are supported | `database,cache,redis,storage` |
| `METRICS_NAME_PREFIX` | Prefix applied to all Prometheus metric names. | `directus_` |
| `METRICS_HEALTH_CHECK_PREFIX` | Prefix for health check keys used in cache, Redis, and storage checks. | `directus-metric-` |
| Variable | Description | Default Value |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `METRICS_ENABLED` | Whether or not to enable metrics. | `false` |
| `METRICS_SCHEDULE` | The cron schedule at which to generate the metrics. | `*/1 * * * *` |
| `METRICS_TOKENS` | A comma-separated list of tokens (e.g. `token1,token2`) that grant access via the `Authorization: Metrics <token>` header. By default, access is restricted to admins. | -- |
| `METRICS_SERVICES` | A comma-separated list of Directus services to observe metrics for. Supported values: `database`, `cache`, `redis`, `storage`. | `database,cache,redis,storage` |
| `METRICS_NAME_PREFIX` | Prefix applied to all Prometheus metric names. | `directus_` |
| `METRICS_HEALTH_CHECK_PREFIX` | Prefix for health check keys used in cache, Redis, and storage checks. | `directus-metric-` |

::callout{icon="i-lucide-triangle-alert" color="warning"}
**Metric Aggregation**
Expand Down
18 changes: 9 additions & 9 deletions content/configuration/security-limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ Modifying `HASH_MEMORY_COST` and/or `HASH_PARALLELISM` will affect the amount of

## CORS

| Variable | Description | Default Value |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `CORS_ENABLED` | Whether or not to enable the CORS headers. | `false` |
| `CORS_ORIGIN` | Value for the `Access-Control-Allow-Origin` header. Use `true` to match the Origin header, or provide a domain or a CSV of domains for specific access. | `false` |
| `CORS_METHODS` | Value for the `Access-Control-Allow-Methods` header. | `GET,POST,PATCH,DELETE` |
| `CORS_ALLOWED_HEADERS` | Value for the `Access-Control-Allow-Headers` header. | `Content-Type,Authorization` |
| `CORS_EXPOSED_HEADERS` | Value for the `Access-Control-Expose-Headers` header. | `Content-Range` |
| `CORS_CREDENTIALS` | Whether or not to send the `Access-Control-Allow-Credentials` header. | `true` |
| `CORS_MAX_AGE` | Value for the `Access-Control-Max-Age` header. | `18000` |
| Variable | Description | Default Value |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
| `CORS_ENABLED` | Whether or not to enable the CORS headers. | `false` |
| `CORS_ORIGIN` | Value for the `Access-Control-Allow-Origin` header. Use `true` to match the Origin header, or provide a domain or a comma-separated list of domains for specific access. | `false` |
| `CORS_METHODS` | Value for the `Access-Control-Allow-Methods` header. | `GET,POST,PATCH,DELETE` |
| `CORS_ALLOWED_HEADERS` | Value for the `Access-Control-Allow-Headers` header. | `Content-Type,Authorization` |
| `CORS_EXPOSED_HEADERS` | Value for the `Access-Control-Expose-Headers` header. | `Content-Range` |
| `CORS_CREDENTIALS` | Whether or not to send the `Access-Control-Allow-Credentials` header. | `true` |
| `CORS_MAX_AGE` | Value for the `Access-Control-Max-Age` header. | `18000` |

For more details about each configuration variable, please see the [CORS package documentation](https://www.npmjs.com/package/cors#configuration-options).

Expand Down
2 changes: 1 addition & 1 deletion content/guides/02.content/8.visual-editor/1.frontend-library.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The generated attribute will be:
```

::callout{icon="i-lucide-info"}
The `fields` property in the `setAttr` function can also accept an array of strings, which will render a comma separated list like: `data-directus="collection:posts;item:12;fields:title,subtitle,slug"`
The `fields` property in the `setAttr` function can also accept an array of strings, which will render a comma-separated list like: `data-directus="collection:posts;item:12;fields:title,subtitle,slug"`
::

| Option | Type | Description |
Expand Down
Loading