From e4affd4bf952dc52df296263d043fd73f117984b Mon Sep 17 00:00:00 2001 From: Dan Ribbens Date: Fri, 29 Apr 2022 14:40:49 -0400 Subject: [PATCH] docs: updated links --- docs/fields/array.mdx | 2 +- docs/fields/blocks.mdx | 2 +- docs/fields/checkbox.mdx | 2 +- docs/fields/code.mdx | 2 +- docs/fields/date.mdx | 2 +- docs/fields/email.mdx | 2 +- docs/fields/group.mdx | 2 +- docs/fields/number.mdx | 2 +- docs/fields/overview.mdx | 2 +- docs/fields/point.mdx | 2 +- docs/fields/radio.mdx | 2 +- docs/fields/relationship.mdx | 2 +- docs/fields/rich-text.mdx | 2 +- docs/fields/select.mdx | 2 +- docs/fields/text.mdx | 2 +- docs/fields/textarea.mdx | 2 +- docs/fields/upload.mdx | 2 +- docs/queries/overview.mdx | 2 +- docs/rest-api/overview.mdx | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/fields/array.mdx b/docs/fields/array.mdx index 76debefb3..00392da0b 100644 --- a/docs/fields/array.mdx +++ b/docs/fields/array.mdx @@ -31,7 +31,7 @@ keywords: array, fields, config, configuration, documentation, Content Managemen | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide an array of row data to be used for this field's default value. | +| **`defaultValue`** | Provide an array of row data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. | | **`required`** | Require this field to have a value. | | **`labels`** | Customize the row labels appearing in the Admin dashboard. | diff --git a/docs/fields/blocks.mdx b/docs/fields/blocks.mdx index b6e7348f7..7944417a7 100644 --- a/docs/fields/blocks.mdx +++ b/docs/fields/blocks.mdx @@ -32,7 +32,7 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme | **`hooks`** | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel. | -| **`defaultValue`** | Provide an array of block data to be used for this field's default value. | +| **`defaultValue`** | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. || **`required`** | Require this field to have a value. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`labels`** | Customize the block row labels appearing in the Admin dashboard. | diff --git a/docs/fields/checkbox.mdx b/docs/fields/checkbox.mdx index 4c54075bd..d7b3703b2 100644 --- a/docs/fields/checkbox.mdx +++ b/docs/fields/checkbox.mdx @@ -22,7 +22,7 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value, will default to false if field is also `required`. | +| **`defaultValue`** | Provide data to be used for this field's default value, will default to false if field is also `required`. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. | diff --git a/docs/fields/code.mdx b/docs/fields/code.mdx index 5f5b1a49c..ab9e3ed4c 100644 --- a/docs/fields/code.mdx +++ b/docs/fields/code.mdx @@ -28,7 +28,7 @@ This field uses `prismjs` for syntax highlighting and `react-simple-code-editor` | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/date.mdx b/docs/fields/date.mdx index 0cc30c7cd..3b48ddaf6 100644 --- a/docs/fields/date.mdx +++ b/docs/fields/date.mdx @@ -25,7 +25,7 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/email.mdx b/docs/fields/email.mdx index b41f741fb..5495e205c 100644 --- a/docs/fields/email.mdx +++ b/docs/fields/email.mdx @@ -23,7 +23,7 @@ keywords: email, fields, config, configuration, documentation, Content Managemen | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/group.mdx b/docs/fields/group.mdx index b0469e9de..2fc761476 100644 --- a/docs/fields/group.mdx +++ b/docs/fields/group.mdx @@ -22,7 +22,7 @@ keywords: group, fields, config, configuration, documentation, Content Managemen | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide an object of data to be used for this field's default value. | +| **`defaultValue`** | Provide an object of data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/number.mdx b/docs/fields/number.mdx index 37deb66c7..ae7539832 100644 --- a/docs/fields/number.mdx +++ b/docs/fields/number.mdx @@ -25,7 +25,7 @@ keywords: number, fields, config, configuration, documentation, Content Manageme | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/overview.mdx b/docs/fields/overview.mdx index c07ac9715..c5b79f566 100644 --- a/docs/fields/overview.mdx +++ b/docs/fields/overview.mdx @@ -228,7 +228,7 @@ const customFieldWithCondition = { ``` -### DefaultValue +### Default values Fields can be prefilled with starting values using the `defaultValue` property. This is used in the admin UI and also on the backend as API requests will be populated with missing or undefined field values. You can assign the defaultValue directly in the field configuration or supply a function for dynamic behavior. Values assigned during a create request on the server are added before validation occurs. diff --git a/docs/fields/point.mdx b/docs/fields/point.mdx index 2274a1261..2f1532e5b 100644 --- a/docs/fields/point.mdx +++ b/docs/fields/point.mdx @@ -26,7 +26,7 @@ The data structure in the database matches the GeoJSON structure to represent po | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/radio.mdx b/docs/fields/radio.mdx index 1197d85cf..4c30a1d34 100644 --- a/docs/fields/radio.mdx +++ b/docs/fields/radio.mdx @@ -23,7 +23,7 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/relationship.mdx b/docs/fields/relationship.mdx index 4f16a55a1..37cc91114 100644 --- a/docs/fields/relationship.mdx +++ b/docs/fields/relationship.mdx @@ -33,7 +33,7 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. | diff --git a/docs/fields/rich-text.mdx b/docs/fields/rich-text.mdx index b86fd0876..1d92c9a05 100644 --- a/docs/fields/rich-text.mdx +++ b/docs/fields/rich-text.mdx @@ -27,7 +27,7 @@ The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.or | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/select.mdx b/docs/fields/select.mdx index 3f5483b03..1baa28675 100644 --- a/docs/fields/select.mdx +++ b/docs/fields/select.mdx @@ -25,7 +25,7 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. | diff --git a/docs/fields/text.mdx b/docs/fields/text.mdx index a4c597648..bca0babce 100644 --- a/docs/fields/text.mdx +++ b/docs/fields/text.mdx @@ -25,7 +25,7 @@ keywords: text, fields, config, configuration, documentation, Content Management | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/textarea.mdx b/docs/fields/textarea.mdx index 40c781dfa..a47a2bb5a 100644 --- a/docs/fields/textarea.mdx +++ b/docs/fields/textarea.mdx @@ -25,7 +25,7 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | diff --git a/docs/fields/upload.mdx b/docs/fields/upload.mdx index 207f46896..9d822697e 100644 --- a/docs/fields/upload.mdx +++ b/docs/fields/upload.mdx @@ -37,7 +37,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | | **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | | **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. | -| **`defaultValue`** | Provide data to be used for this field's default value. | +| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`localized`** | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. | | **`required`** | Require this field to have a value. | | **`admin`** | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. | diff --git a/docs/queries/overview.mdx b/docs/queries/overview.mdx index b6112939b..e6c65893d 100644 --- a/docs/queries/overview.mdx +++ b/docs/queries/overview.mdx @@ -64,7 +64,7 @@ The above example demonstrates a simple query but you can get much more complex. | `in` | The value must be found within the provided comma-delimited list of values. | | `not_in` | The value must NOT be within the provided comma-delimited list of values. | | `exists` | Only return documents where the value either exists (`true`) or does not exist (`false`). | -| `near` | For distance related to a [point field]('/docs/fields/point') comma separated as `, , , `. | +| `near` | For distance related to a [point field](/docs/fields/point) comma separated as `, , , `. | Tip:
diff --git a/docs/rest-api/overview.mdx b/docs/rest-api/overview.mdx index 72e225628..05cb43a5f 100644 --- a/docs/rest-api/overview.mdx +++ b/docs/rest-api/overview.mdx @@ -65,7 +65,7 @@ Globals cannot be created or deleted, so there are only two REST endpoints opene ## Preferences -In addition to the dynamically generated endpoints above Payload also has REST endpoints to manage the admin user [preferences](/docs/admin#preferences) for data specific to the authenticated user. +In addition to the dynamically generated endpoints above Payload also has REST endpoints to manage the admin user [preferences](/docs/admin/overview#preferences) for data specific to the authenticated user. | Method | Path | Description | | -------- | --------------------------- | ----------------------- |