From 7aa725fde996b16882a919b3b7397d94d29b6f7b Mon Sep 17 00:00:00 2001 From: Ben Irvin Date: Mon, 26 Jun 2023 14:18:27 +0200 Subject: [PATCH] update structure --- docs/docs/docs/01-core/data-transfer/01-engine.md | 2 +- .../{01-providers => 02-providers}/00-overview.md | 10 +++++----- .../01-source-providers.md | 0 .../02-destination-providers.md | 0 .../03-strapi-file}/00-overview.md | 2 +- .../03-strapi-file}/01-file-structure.md | 0 .../03-strapi-file}/02-source.md | 2 +- .../03-strapi-file}/03-destination.md | 2 +- .../03-strapi-file}/_category_.json | 0 .../04-local-strapi}/00-overview.md | 2 +- .../04-local-strapi}/01-source.md | 2 +- .../04-local-strapi}/02-destination.md | 2 +- .../04-local-strapi}/_category_.json | 0 .../05-remote-strapi}/00-overview.md | 2 +- .../05-remote-strapi}/01-websocket.md | 2 +- .../05-remote-strapi}/02-source.md | 2 +- .../05-remote-strapi}/03-destination.md | 2 +- .../05-remote-strapi}/_category_.json | 0 .../{01-providers => 02-providers}/_category_.json | 2 +- 19 files changed, 17 insertions(+), 17 deletions(-) rename docs/docs/docs/01-core/data-transfer/{01-providers => 02-providers}/00-overview.md (60%) rename docs/docs/docs/01-core/data-transfer/{01-providers => 02-providers}/01-source-providers.md (100%) rename docs/docs/docs/01-core/data-transfer/{01-providers => 02-providers}/02-destination-providers.md (100%) rename docs/docs/docs/01-core/data-transfer/{02-file-providers => 02-providers/03-strapi-file}/00-overview.md (93%) rename docs/docs/docs/01-core/data-transfer/{02-file-providers => 02-providers/03-strapi-file}/01-file-structure.md (100%) rename docs/docs/docs/01-core/data-transfer/{02-file-providers => 02-providers/03-strapi-file}/02-source.md (98%) rename docs/docs/docs/01-core/data-transfer/{02-file-providers => 02-providers/03-strapi-file}/03-destination.md (97%) rename docs/docs/docs/01-core/data-transfer/{02-file-providers => 02-providers/03-strapi-file}/_category_.json (100%) rename docs/docs/docs/01-core/data-transfer/{03-local-strapi-providers => 02-providers/04-local-strapi}/00-overview.md (97%) rename docs/docs/docs/01-core/data-transfer/{03-local-strapi-providers => 02-providers/04-local-strapi}/01-source.md (95%) rename docs/docs/docs/01-core/data-transfer/{03-local-strapi-providers => 02-providers/04-local-strapi}/02-destination.md (98%) rename docs/docs/docs/01-core/data-transfer/{03-local-strapi-providers => 02-providers/04-local-strapi}/_category_.json (100%) rename docs/docs/docs/01-core/data-transfer/{04-remote-strapi-providers => 02-providers/05-remote-strapi}/00-overview.md (95%) rename docs/docs/docs/01-core/data-transfer/{04-remote-strapi-providers => 02-providers/05-remote-strapi}/01-websocket.md (98%) rename docs/docs/docs/01-core/data-transfer/{04-remote-strapi-providers => 02-providers/05-remote-strapi}/02-source.md (96%) rename docs/docs/docs/01-core/data-transfer/{04-remote-strapi-providers => 02-providers/05-remote-strapi}/03-destination.md (97%) rename docs/docs/docs/01-core/data-transfer/{04-remote-strapi-providers => 02-providers/05-remote-strapi}/_category_.json (100%) rename docs/docs/docs/01-core/data-transfer/{01-providers => 02-providers}/_category_.json (55%) diff --git a/docs/docs/docs/01-core/data-transfer/01-engine.md b/docs/docs/docs/01-core/data-transfer/01-engine.md index d33fffb757..269ef70833 100644 --- a/docs/docs/docs/01-core/data-transfer/01-engine.md +++ b/docs/docs/docs/01-core/data-transfer/01-engine.md @@ -32,7 +32,7 @@ Once all stages have been completed, the transfer waits for all providers to clo ## Setting up the transfer engine -A transfer engine object is created by using `createTransferEngine`, which accepts a [source provider](./source-providers/overview), a [destination provider](./destination-providers/overview), and an options object. +A transfer engine object is created by using `createTransferEngine`, which accepts a [source provider](./02-providers/01-source-providers.md), a [destination provider](./02-providers/02-destination-providers.md), and an options object. Note: By default, a transfer engine will transfer ALL data, including admin data, api tokens, etc. Transform filters must be used if you wish to exclude, as seen in the example below. An array called `DEFAULT_IGNORED_CONTENT_TYPES` is available from @strapi/data-transfer containing the uids that are excluded by default from the import, export, and transfer commands. If you intend to transfer admin data, be aware that this behavior will likely change in the future to automatically exclude the entire `admin::` uid namespace and will instead require them to be explicitly included. diff --git a/docs/docs/docs/01-core/data-transfer/01-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/02-providers/00-overview.md similarity index 60% rename from docs/docs/docs/01-core/data-transfer/01-providers/00-overview.md rename to docs/docs/docs/01-core/data-transfer/02-providers/00-overview.md index 7014c49345..942e87d92d 100644 --- a/docs/docs/docs/01-core/data-transfer/01-providers/00-overview.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/00-overview.md @@ -1,5 +1,5 @@ --- -title: Data Transfer Providers +title: Introduction tags: - providers - data-transfer @@ -16,15 +16,15 @@ Data transfer providers are the interfaces for streaming data during a transfer. Strapi provides both source and destination providers for the following: -- [Strapi file](../02-file-providers/00-overview.md): a standardized file format designed for the transfer process -- [Local Strapi](../03-local-strapi-providers/00-overview.md): a connection to a local Strapi project which uses its configured database connection to manage data -- [Remote Strapi](../04-remote-strapi-providers/00-overview.md): a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi +- [Strapi file](./03-strapi-file/00-overview.md): a standardized file format designed for the transfer process +- [Local Strapi](./04-local-strapi/00-overview.md): a connection to a local Strapi project which uses its configured database connection to manage data +- [Remote Strapi](./05-remote-strapi/00-overview.md): a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi Each provider must provide the same interface for transferring data, but will usually include its own unique set of options to be passed in when initializing the provider. ## Creating your own providers -To create your own providers, you must implement the interface(s) defined in ISourceProvider and IDestinationProvider found in `packages/core/data-transfer/types/providers.d.ts`. +To create your own providers, you must implement the interface(s) defined in `ISourceProvider` and `IDestinationProvider` found in `packages/core/data-transfer/types/providers.d.ts`. It is not necessary to create both a source and destination provider, only the part necessary for your use. diff --git a/docs/docs/docs/01-core/data-transfer/01-providers/01-source-providers.md b/docs/docs/docs/01-core/data-transfer/02-providers/01-source-providers.md similarity index 100% rename from docs/docs/docs/01-core/data-transfer/01-providers/01-source-providers.md rename to docs/docs/docs/01-core/data-transfer/02-providers/01-source-providers.md diff --git a/docs/docs/docs/01-core/data-transfer/01-providers/02-destination-providers.md b/docs/docs/docs/01-core/data-transfer/02-providers/02-destination-providers.md similarity index 100% rename from docs/docs/docs/01-core/data-transfer/01-providers/02-destination-providers.md rename to docs/docs/docs/01-core/data-transfer/02-providers/02-destination-providers.md diff --git a/docs/docs/docs/01-core/data-transfer/02-file-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/00-overview.md similarity index 93% rename from docs/docs/docs/01-core/data-transfer/02-file-providers/00-overview.md rename to docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/00-overview.md index 3a330482e1..28e939dab6 100644 --- a/docs/docs/docs/01-core/data-transfer/02-file-providers/00-overview.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/00-overview.md @@ -1,5 +1,5 @@ --- -title: File Providers +title: Overview tags: - experimental - providers diff --git a/docs/docs/docs/01-core/data-transfer/02-file-providers/01-file-structure.md b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/01-file-structure.md similarity index 100% rename from docs/docs/docs/01-core/data-transfer/02-file-providers/01-file-structure.md rename to docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/01-file-structure.md diff --git a/docs/docs/docs/01-core/data-transfer/02-file-providers/02-source.md b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/02-source.md similarity index 98% rename from docs/docs/docs/01-core/data-transfer/02-file-providers/02-source.md rename to docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/02-source.md index 3cc408f3c2..ab3adc32f7 100644 --- a/docs/docs/docs/01-core/data-transfer/02-file-providers/02-source.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/02-source.md @@ -1,5 +1,5 @@ --- -title: Strapi File +title: Source tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/02-file-providers/03-destination.md b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/03-destination.md similarity index 97% rename from docs/docs/docs/01-core/data-transfer/02-file-providers/03-destination.md rename to docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/03-destination.md index 0b5b6e9113..c82d8a07a2 100644 --- a/docs/docs/docs/01-core/data-transfer/02-file-providers/03-destination.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/03-destination.md @@ -1,5 +1,5 @@ --- -title: Strapi File +title: Destination tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/02-file-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/_category_.json similarity index 100% rename from docs/docs/docs/01-core/data-transfer/02-file-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/02-providers/03-strapi-file/_category_.json diff --git a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/00-overview.md similarity index 97% rename from docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/00-overview.md rename to docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/00-overview.md index b9aae79419..86872c1107 100644 --- a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/00-overview.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/00-overview.md @@ -1,5 +1,5 @@ --- -title: Local Strapi Providers +title: Overview tags: - experimental - providers diff --git a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/01-source.md b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/01-source.md similarity index 95% rename from docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/01-source.md rename to docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/01-source.md index 84104c86a1..7148f1f621 100644 --- a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/01-source.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/01-source.md @@ -1,5 +1,5 @@ --- -title: Local Strapi Source +title: Source tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/02-destination.md b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/02-destination.md similarity index 98% rename from docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/02-destination.md rename to docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/02-destination.md index e4d79e6eb9..f8ba4b4795 100644 --- a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/02-destination.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/02-destination.md @@ -1,5 +1,5 @@ --- -title: Local Strapi Destination +title: Destination tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/_category_.json similarity index 100% rename from docs/docs/docs/01-core/data-transfer/03-local-strapi-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/02-providers/04-local-strapi/_category_.json diff --git a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/00-overview.md similarity index 95% rename from docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/00-overview.md rename to docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/00-overview.md index 4e4f786140..a66f3c3479 100644 --- a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/00-overview.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/00-overview.md @@ -1,5 +1,5 @@ --- -title: Remote Strapi Providers +title: Overview tags: - experimental - providers diff --git a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/01-websocket.md b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/01-websocket.md similarity index 98% rename from docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/01-websocket.md rename to docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/01-websocket.md index 195ba25761..143e015294 100644 --- a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/01-websocket.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/01-websocket.md @@ -1,5 +1,5 @@ --- -title: Remote Provider Websocket +title: Websocket tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/02-source.md b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/02-source.md similarity index 96% rename from docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/02-source.md rename to docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/02-source.md index c5507d2be2..390e1cc408 100644 --- a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/02-source.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/02-source.md @@ -1,5 +1,5 @@ --- -title: Strapi Remote Source Provider +title: Source tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/03-destination.md b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/03-destination.md similarity index 97% rename from docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/03-destination.md rename to docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/03-destination.md index 9610867c49..140ea9573a 100644 --- a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/03-destination.md +++ b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/03-destination.md @@ -1,5 +1,5 @@ --- -title: Remote Destination Provider +title: Destination tags: - providers - data-transfer diff --git a/docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/_category_.json similarity index 100% rename from docs/docs/docs/01-core/data-transfer/04-remote-strapi-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/02-providers/05-remote-strapi/_category_.json diff --git a/docs/docs/docs/01-core/data-transfer/01-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/02-providers/_category_.json similarity index 55% rename from docs/docs/docs/01-core/data-transfer/01-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/02-providers/_category_.json index 0754ae334b..906e287df0 100644 --- a/docs/docs/docs/01-core/data-transfer/01-providers/_category_.json +++ b/docs/docs/docs/01-core/data-transfer/02-providers/_category_.json @@ -1,5 +1,5 @@ { - "label": "Data Transfer Providers", + "label": "Providers", "collapsible": true, "collapsed": true }