From b4f0440a8f9a94a628a44f90c0485b7f7fe317c4 Mon Sep 17 00:00:00 2001 From: Ben Irvin Date: Wed, 21 Jun 2023 14:34:12 +0200 Subject: [PATCH] add providers --- .../01-data-providers/00-overview.md | 23 +++++++++++++++++++ .../01-data-providers/01-source-providers.md | 13 +++++++++++ .../02-destination-providers.md | 13 +++++++++++ .../_category_.json | 0 .../01-source-providers/00-overview.md | 21 ----------------- .../01-source-providers/03-remote-strapi.md | 13 ----------- .../02-destination-providers/00-overview.md | 21 ----------------- .../03-remote-strapi.md | 13 ----------- .../03-file-providers/00-overview.md | 13 +++++++++++ .../01-file-structure.md} | 4 ++-- .../03-file-providers/02-source.md | 13 +++++++++++ .../03-destination.md} | 0 .../_category_.json | 2 +- .../04-local-strapi-providers/00-overview.md | 13 +++++++++++ .../01-file-structure.md} | 6 ++--- .../04-local-strapi-providers/02-source.md | 13 +++++++++++ .../03-destination.md | 15 ++++++++++++ .../04-local-strapi-providers/_category_.json | 5 ++++ .../05-remote-strapi-providers/00-overview.md | 13 +++++++++++ .../01-file-structure.md} | 6 ++--- .../05-remote-strapi-providers/02-source.md | 13 +++++++++++ .../03-destination.md | 15 ++++++++++++ .../_category_.json | 5 ++++ 23 files changed, 176 insertions(+), 77 deletions(-) create mode 100644 docs/docs/docs/01-core/data-transfer/01-data-providers/00-overview.md create mode 100644 docs/docs/docs/01-core/data-transfer/01-data-providers/01-source-providers.md create mode 100644 docs/docs/docs/01-core/data-transfer/01-data-providers/02-destination-providers.md rename docs/docs/docs/01-core/data-transfer/{01-source-providers => 01-data-providers}/_category_.json (100%) delete mode 100644 docs/docs/docs/01-core/data-transfer/01-source-providers/00-overview.md delete mode 100644 docs/docs/docs/01-core/data-transfer/01-source-providers/03-remote-strapi.md delete mode 100644 docs/docs/docs/01-core/data-transfer/02-destination-providers/00-overview.md delete mode 100644 docs/docs/docs/01-core/data-transfer/02-destination-providers/03-remote-strapi.md create mode 100644 docs/docs/docs/01-core/data-transfer/03-file-providers/00-overview.md rename docs/docs/docs/01-core/data-transfer/{01-source-providers/01-strapi-file.md => 03-file-providers/01-file-structure.md} (70%) create mode 100644 docs/docs/docs/01-core/data-transfer/03-file-providers/02-source.md rename docs/docs/docs/01-core/data-transfer/{02-destination-providers/01-strapi-file.md => 03-file-providers/03-destination.md} (100%) rename docs/docs/docs/01-core/data-transfer/{02-destination-providers => 03-file-providers}/_category_.json (56%) create mode 100644 docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/00-overview.md rename docs/docs/docs/01-core/data-transfer/{01-source-providers/02-local-strapi.md => 04-local-strapi-providers/01-file-structure.md} (55%) create mode 100644 docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/02-source.md create mode 100644 docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/03-destination.md create mode 100644 docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/_category_.json create mode 100644 docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/00-overview.md rename docs/docs/docs/01-core/data-transfer/{02-destination-providers/02-local-strapi copy.md => 05-remote-strapi-providers/01-file-structure.md} (51%) create mode 100644 docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/02-source.md create mode 100644 docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/03-destination.md create mode 100644 docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/_category_.json diff --git a/docs/docs/docs/01-core/data-transfer/01-data-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/01-data-providers/00-overview.md new file mode 100644 index 0000000000..92d325a580 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/01-data-providers/00-overview.md @@ -0,0 +1,23 @@ +--- +title: Destination Providers +tags: + - providers + - data-transfer + - experimental +--- + +# Data Providers + +Data providers are the interfaces for streaming data during a transfer. Source providers provide read streams and destination providers provide write streams which the transfer engine pipes (and optionally transforms) during a transfer. + +Strapi provides both source and destination providers for the following: + +- [Strapi file](../03-file-providers/00-overview.md): a standardized file format designed for the transfer process +- [Local Strapi]: a connection to a local Strapi project which uses its configured database connection to manage data +- [Remote Strapi]: a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi + +## Creating your own providers + +It is possible to create your own providers by implementing the interface(s) defined in ISourceProvider and IDestinationProvider. It is not necessary to create both a source and destination provider, only the part necessary for your use. + +For examples, see the existing providers such as the local Strapi provider. diff --git a/docs/docs/docs/01-core/data-transfer/01-data-providers/01-source-providers.md b/docs/docs/docs/01-core/data-transfer/01-data-providers/01-source-providers.md new file mode 100644 index 0000000000..7682916809 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/01-data-providers/01-source-providers.md @@ -0,0 +1,13 @@ +--- +title: Source Providers +tags: + - providers + - data-transfer + - experimental +--- + +# Source Providers + +## Source provider structure + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/01-data-providers/02-destination-providers.md b/docs/docs/docs/01-core/data-transfer/01-data-providers/02-destination-providers.md new file mode 100644 index 0000000000..6d4a23e702 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/01-data-providers/02-destination-providers.md @@ -0,0 +1,13 @@ +--- +title: Destination Providers +tags: + - providers + - data-transfer + - experimental +--- + +# Destination Providers + +## Destination provider structure + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/01-source-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/01-data-providers/_category_.json similarity index 100% rename from docs/docs/docs/01-core/data-transfer/01-source-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/01-data-providers/_category_.json diff --git a/docs/docs/docs/01-core/data-transfer/01-source-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/01-source-providers/00-overview.md deleted file mode 100644 index 7b16704f15..0000000000 --- a/docs/docs/docs/01-core/data-transfer/01-source-providers/00-overview.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Source Providers -tags: - - providers - - data-transfer - - experimental ---- - -# Source Providers - -Data transfer source providers provide a standardized interface and streams of data for each stage in a transfer intended to be consumed by destination providers. - -The following source providers are available within Strapi: - -- [Strapi File](./01-strapi-file.md): loads data from a Strapi data file -- [Local Strapi](./02-local-strapi.md): uses a local Strapi project to retrieve data from its configured database -- [Remote Strapi](./03-remote-strapi.md): accepts a websocket connection to a running instance of Strapi over a network to send data - -## Creating your own providers - -It is possible to create your own provider by providing the interface defined in ISourceProvider. Please see existing providers (such as the local strapi source provider) for an example. diff --git a/docs/docs/docs/01-core/data-transfer/01-source-providers/03-remote-strapi.md b/docs/docs/docs/01-core/data-transfer/01-source-providers/03-remote-strapi.md deleted file mode 100644 index 785289ad36..0000000000 --- a/docs/docs/docs/01-core/data-transfer/01-source-providers/03-remote-strapi.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remote Strapi -tags: - - providers - - data-transfer - - experimental ---- - -# Remote Strapi Source Provider - -Note: This provider is a websocket interface wrapper for the Local Strapi Source Provider - -**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/02-destination-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/02-destination-providers/00-overview.md deleted file mode 100644 index 8c91e65c8a..0000000000 --- a/docs/docs/docs/01-core/data-transfer/02-destination-providers/00-overview.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Destination Providers -tags: - - providers - - data-transfer - - experimental ---- - -# Destination Providers - -Data transfer destination providers provide a standardized interface and streams of data for each stage in a transfer intended to consume the stream provided by a source provider. - -The following destination providers are available within Strapi: - -- [Strapi File](./01-strapi-file.md): writes data to a Strapi data file -- [Local Strapi](./02-local-strapi.md): uses a local Strapi project to insert data into its configured database -- [Remote Strapi](./03-remote-strapi.md): accepts a websocket connection to a running instance of Strapi over a network to receive data - -## Creating your own providers - -It is possible to create your own provider by providing the interface defined in ISourceProvider. Please see existing providers (such as the local strapi source provider) for an example. diff --git a/docs/docs/docs/01-core/data-transfer/02-destination-providers/03-remote-strapi.md b/docs/docs/docs/01-core/data-transfer/02-destination-providers/03-remote-strapi.md deleted file mode 100644 index 2c5ef5f0cf..0000000000 --- a/docs/docs/docs/01-core/data-transfer/02-destination-providers/03-remote-strapi.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Remote Strapi -tags: - - providers - - data-transfer - - experimental ---- - -# Remote Strapi Destination Provider - -Note: This provider is a websocket wrapper for the Local Strapi Destination Provider - -**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/03-file-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/03-file-providers/00-overview.md new file mode 100644 index 0000000000..ccc1428f00 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/03-file-providers/00-overview.md @@ -0,0 +1,13 @@ +--- +title: File Providers +tags: + - experimental + - providers + - import + - export + - data-transfer +--- + +# Strapi Data File Providers + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/01-source-providers/01-strapi-file.md b/docs/docs/docs/01-core/data-transfer/03-file-providers/01-file-structure.md similarity index 70% rename from docs/docs/docs/01-core/data-transfer/01-source-providers/01-strapi-file.md rename to docs/docs/docs/01-core/data-transfer/03-file-providers/01-file-structure.md index a8f1e5a00c..9f838bc403 100644 --- a/docs/docs/docs/01-core/data-transfer/01-source-providers/01-strapi-file.md +++ b/docs/docs/docs/01-core/data-transfer/03-file-providers/01-file-structure.md @@ -6,6 +6,6 @@ tags: - experimental --- -# Strapi File Source Provider +# Strapi File Structure -TODO +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/03-file-providers/02-source.md b/docs/docs/docs/01-core/data-transfer/03-file-providers/02-source.md new file mode 100644 index 0000000000..2b664c07ed --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/03-file-providers/02-source.md @@ -0,0 +1,13 @@ +--- +title: Strapi File +tags: + - providers + - data-transfer + - experimental +--- + +# Strapi File Source Provider + +This provider will output a Strapi Data File + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/02-destination-providers/01-strapi-file.md b/docs/docs/docs/01-core/data-transfer/03-file-providers/03-destination.md similarity index 100% rename from docs/docs/docs/01-core/data-transfer/02-destination-providers/01-strapi-file.md rename to docs/docs/docs/01-core/data-transfer/03-file-providers/03-destination.md diff --git a/docs/docs/docs/01-core/data-transfer/02-destination-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/03-file-providers/_category_.json similarity index 56% rename from docs/docs/docs/01-core/data-transfer/02-destination-providers/_category_.json rename to docs/docs/docs/01-core/data-transfer/03-file-providers/_category_.json index 229935ff0d..6663af8f1e 100644 --- a/docs/docs/docs/01-core/data-transfer/02-destination-providers/_category_.json +++ b/docs/docs/docs/01-core/data-transfer/03-file-providers/_category_.json @@ -1,5 +1,5 @@ { - "label": "Destination Providers", + "label": "File Providers", "collapsible": true, "collapsed": true } diff --git a/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/00-overview.md new file mode 100644 index 0000000000..ccc1428f00 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/00-overview.md @@ -0,0 +1,13 @@ +--- +title: File Providers +tags: + - experimental + - providers + - import + - export + - data-transfer +--- + +# Strapi Data File Providers + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/01-source-providers/02-local-strapi.md b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/01-file-structure.md similarity index 55% rename from docs/docs/docs/01-core/data-transfer/01-source-providers/02-local-strapi.md rename to docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/01-file-structure.md index faa25ae060..9f838bc403 100644 --- a/docs/docs/docs/01-core/data-transfer/01-source-providers/02-local-strapi.md +++ b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/01-file-structure.md @@ -1,11 +1,11 @@ --- -title: Local Strapi +title: Strapi File tags: - providers - data-transfer - experimental --- -# Destination Providers +# Strapi File Structure -TODO +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/02-source.md b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/02-source.md new file mode 100644 index 0000000000..2b664c07ed --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/02-source.md @@ -0,0 +1,13 @@ +--- +title: Strapi File +tags: + - providers + - data-transfer + - experimental +--- + +# Strapi File Source Provider + +This provider will output a Strapi Data File + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/03-destination.md b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/03-destination.md new file mode 100644 index 0000000000..9398ac4053 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/03-destination.md @@ -0,0 +1,15 @@ +--- +title: Strapi File +tags: + - providers + - data-transfer + - experimental +--- + +# Strapi File Destination Provider + +This provider will output a Strapi Data File + +Note: this destination provider does not provide a schema or metadata, and will therefore never report a schema match error or version validation error + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/_category_.json new file mode 100644 index 0000000000..6663af8f1e --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/04-local-strapi-providers/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "File Providers", + "collapsible": true, + "collapsed": true +} diff --git a/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/00-overview.md b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/00-overview.md new file mode 100644 index 0000000000..ccc1428f00 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/00-overview.md @@ -0,0 +1,13 @@ +--- +title: File Providers +tags: + - experimental + - providers + - import + - export + - data-transfer +--- + +# Strapi Data File Providers + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/02-destination-providers/02-local-strapi copy.md b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/01-file-structure.md similarity index 51% rename from docs/docs/docs/01-core/data-transfer/02-destination-providers/02-local-strapi copy.md rename to docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/01-file-structure.md index 4684d9a7c3..9f838bc403 100644 --- a/docs/docs/docs/01-core/data-transfer/02-destination-providers/02-local-strapi copy.md +++ b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/01-file-structure.md @@ -1,11 +1,11 @@ --- -title: Local Strapi +title: Strapi File tags: - providers - data-transfer - experimental --- -# Local Strapi Destination Provider +# Strapi File Structure -TODO +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/02-source.md b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/02-source.md new file mode 100644 index 0000000000..2b664c07ed --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/02-source.md @@ -0,0 +1,13 @@ +--- +title: Strapi File +tags: + - providers + - data-transfer + - experimental +--- + +# Strapi File Source Provider + +This provider will output a Strapi Data File + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/03-destination.md b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/03-destination.md new file mode 100644 index 0000000000..9398ac4053 --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/03-destination.md @@ -0,0 +1,15 @@ +--- +title: Strapi File +tags: + - providers + - data-transfer + - experimental +--- + +# Strapi File Destination Provider + +This provider will output a Strapi Data File + +Note: this destination provider does not provide a schema or metadata, and will therefore never report a schema match error or version validation error + +**TODO** diff --git a/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/_category_.json b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/_category_.json new file mode 100644 index 0000000000..6663af8f1e --- /dev/null +++ b/docs/docs/docs/01-core/data-transfer/05-remote-strapi-providers/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "File Providers", + "collapsible": true, + "collapsed": true +}