From ad2b47e725f868a6dc674540daca8f27722d7852 Mon Sep 17 00:00:00 2001 From: James Date: Mon, 4 Oct 2021 11:25:12 -0400 Subject: [PATCH] docs: clarity --- docs/configuration/overview.mdx | 2 +- docs/production/deployment.mdx | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/configuration/overview.mdx b/docs/configuration/overview.mdx index b425608b07c..f9734f43852 100644 --- a/docs/configuration/overview.mdx +++ b/docs/configuration/overview.mdx @@ -29,7 +29,7 @@ Payload is a *config-based*, code-first CMS and application framework. The Paylo | `csrf` | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection) | | `defaultDepth` | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth) | | `maxDepth` | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`. | -| `indexSortableFields`| Automatically create database an index on every sortable type of top-level field. | +| `indexSortableFields`| Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar. | | `upload` | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options). | | `routes` | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`. | | `email` | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration) | diff --git a/docs/production/deployment.mdx b/docs/production/deployment.mdx index f3466579efd..91ef84f9d4a 100644 --- a/docs/production/deployment.mdx +++ b/docs/production/deployment.mdx @@ -72,7 +72,10 @@ If you are using a [persistent filesystem-based cloud host](#persistent-vs-ephem Alternatively, you can rely on a third-party MongoDB host such as [MongoDB Atlas](https://www.mongodb.com/). With Atlas or a similar cloud provider, you can trust them to take care of your database's availability, security, redundancy, and backups. -When using Azure Cosmos, MongoDB requires an index on any field being sorted on in a query. To make this easier, see the [indexSortableFields](/docs/configuration/overview) configuration option. + + Note regarding Azure Cosmos:
+ When using Azure Cosmos, MongoDB requires an index on any field being sorted on. To make this easier, see the indexSortableFields configuration option. + ## File storage