diff --git a/website/docs/collections/multiple_filters.md b/website/docs/collections/multiple_filters.md index 5f10daf04..72c729260 100644 --- a/website/docs/collections/multiple_filters.md +++ b/website/docs/collections/multiple_filters.md @@ -4,7 +4,7 @@ title: Multiple filters in collection views sidebar_label: Multiple filters --- -Unfortunately Firestore is limited to a single `where` clause per query by default. +Firestore is a bit limited when filtering and sorting. limited to a single `where` clause per query by default. This means that filtering by multiple fields is not possible out of the box. Anyhow, you can define indexes in Firestore to allow queries per multiple fields. diff --git a/website/docs/migrating_from_v2.mdx b/website/docs/migrating_from_v2.mdx index accb70cfb..a670efbb4 100644 --- a/website/docs/migrating_from_v2.mdx +++ b/website/docs/migrating_from_v2.mdx @@ -26,6 +26,20 @@ By doing this you will **not need to specify your Firebase project credentials** since the service will be able to access your project directly. You will only need to specify the **project id**. +## Initialize a FireCMS 3 project in a new folder + +It is advisable to create a new project from scratch and then migrate your collections and views to +the new folder. + +In order to do so, run +``` +yarn create firecms-app +``` +and create a new project in a new folder. + +The CLI will initialize an empty project with the new format, and all the configuration files +ready so you don't need to worry about it. + ## Migrating collections to the new format @@ -36,17 +50,19 @@ code like until now. Also, you can have collections defined in both places, and decide if the code defined collections can be modified by the user or not. +Please note that properties defined in code will not be editable by the user, unless you +explicitly mark them as `editable: true`. + ## Changing the import The package has been renamed to `@firecms/firebase` instead of `firecms`. You need to update your imports to use the new package name. - ## New format Since it is now possible to deploy FireCMS in our hosted service, the output -of your project needs to be a in a specific format. +of your project needs to be in a specific format. The `index.ts` file should export a `FireCMSAppConfig` object, which is defined as follows: diff --git a/website/docs/navigation/app_config.mdx b/website/docs/navigation/app_config.mdx index f3f698189..40fe610e0 100644 --- a/website/docs/navigation/app_config.mdx +++ b/website/docs/navigation/app_config.mdx @@ -3,11 +3,17 @@ id: app_config title: App Config --- -When creating a FireCMS app, you will **either** be using the components: -- `FirebaseCMSApp` Default implementation of FireCMS that uses Firebase Auth, Firestore -and Firebase Storage. -- `FireCMSApp` Lower level component that allows you to provide your own implementations -of the different services and more customization. +The app config is the main configuration object of FireCMS. It is defined +by the interface `FireCMSAppConfig`. In order to customize the CMS, you need +to create a project in [app.firecms.co](https://app.firecms.co) and +initialise a new project in code with `yarn create firecms-app`. + +After those steps are ready you can use the `FireCMSAppConfig` export to add +your own customizations, like custom reusable properties or fields, collections, +entity views, cms views, etc. + + + ### Navigation @@ -30,8 +36,7 @@ collections that get mapped to CMS views, or create your own top level React vie ### Customization -Let's see all the customization options available for `FirebaseCMSApp` (most -of them are also available for `FireCMSApp`). +Let's see all the customization options available: * `name`: Name of the app, displayed as the main title and in the tab title diff --git a/website/docs/openai.md b/website/docs/openai.md deleted file mode 100644 index bae44c537..000000000 --- a/website/docs/openai.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: openai -title: ChatGPT plugin -sidebar_label: ✨ ChatGPT plugin ---- - - -The OpenAI plugin allows you to use the **OpenAI API** to generate content using -the latest **GPT models**. This plugin is able to understand the structure of -your -data and generate content that fits your schema. - -
-
-