diff --git a/doc/01_Installation_and_Upgrade/01_Upgrade_Notes.md b/doc/01_Installation_and_Upgrade/01_Upgrade_Notes.md index 961b95a6..d5531bc4 100644 --- a/doc/01_Installation_and_Upgrade/01_Upgrade_Notes.md +++ b/doc/01_Installation_and_Upgrade/01_Upgrade_Notes.md @@ -3,15 +3,15 @@ ## 1.6.0 - [General] If you want to use data-hub 1.6 and Pimcore 11, please make sure to require the `pimcore/admin-ui-classic-bundle`. - [Config Location] Change default directory for configurations to `var/config/data_hub` -- When using Pimcore 11 configurations from `datahub-configurations.php` are no longer used. To migrate those configurations +- When using Pimcore 11, configurations from `datahub-configurations.php` are no longer used. To migrate those configurations to the settings store, use the provided `datahub:configuration:migrate-legacy-config` command. -- Added the ability to import and export each type of data-hub configuration. +- Added the ability to import and export each type of Datahub configuration. Be sure to include the `supported_types` configuration in any custom implementation to use the import functionality! - Added possibility to disable the introspection for GraphQL via configuration tree. ## 1.5.0 - When "Skip Permission Check" is active in a GraphQL configuration, the "Workspaces" settings are also skipped -- It is possible to add more than one API-key per configuration now. Therefore, the API-key gets stored as an array +- It is possible to add more than one API-key per configuration now. Therefore, the API-keys get stored as an array in the configuration. Configurations from previous versions are still supported, but they get converted to the new format as soon as they get saved. - Added "Translation Listing" and "Translation" to the Generic Types diff --git a/doc/02_Basic_Principle.md b/doc/02_Basic_Principle.md index 505fc6a9..5fda502f 100644 --- a/doc/02_Basic_Principle.md +++ b/doc/02_Basic_Principle.md @@ -1,23 +1,22 @@ # Basic Principle -Pimcore Datahub allows defining multiple endpoints that allow data delivery and consumption. These -endpoints are configured via so called configurations that can be added in Pimcore admin user interface: +Pimcore Datahub allows defining multiple endpoints that allow data delivery and consumption. These endpoints are configured via so called configurations that can be added in the Pimcore admin user interface: -## Adding a new configuration +## Adding a New Configuration -Open Datahub configuration panel +1. Open the Datahub configuration panel: ![Configuration Overview](./img/graphql/configuration3.png) -Choose endpoint technology +2. Choose an endpoint technology: ![Add Configuration](./img/add_config.png) -And get the configuration done by defining -- general settings -- schema configuration -- security definitions -- and additional settings +3. Get the configuration done by defining the followings: +- General settings +- Schema configuration +- Security definitions +- Additional settings -Example for [GraphQL](./10_GraphQL/README.md) +Here you can find an example for [GraphQL](./10_GraphQL/README.md). diff --git a/doc/10_GraphQL/01_Configuration/03_Security_Settings.md b/doc/10_GraphQL/01_Configuration/03_Security_Settings.md index 60f673e6..f01e6378 100644 --- a/doc/10_GraphQL/01_Configuration/03_Security_Settings.md +++ b/doc/10_GraphQL/01_Configuration/03_Security_Settings.md @@ -2,7 +2,7 @@ ## Authentication -Defines how users are authenticated when accessing the endpoint. +Here you can define how users are authenticated when accessing the endpoint. #### Supported Methods diff --git a/doc/10_GraphQL/01_Configuration/04_Custom_Permissions.md b/doc/10_GraphQL/01_Configuration/04_Custom_Permissions.md index 0cca365f..78a0136f 100644 --- a/doc/10_GraphQL/01_Configuration/04_Custom_Permissions.md +++ b/doc/10_GraphQL/01_Configuration/04_Custom_Permissions.md @@ -1,8 +1,6 @@ # Custom Permissions -When creating custom queries or creating other custom extensions to Datahub, it might be useful to -add additional permissions to define access rules for certain data entities (like it is possible to -define access for documents, assets, etc.). +When creating custom queries or creating other custom extensions to Datahub, it might be useful to add additional permissions to define access rules for certain data entities (like it is possible to define access for Documents, Assets, etc.). ## Adding Custom Permissions diff --git a/doc/20_Deployment.md b/doc/20_Deployment.md index 7fdc42c3..cbd6208d 100644 --- a/doc/20_Deployment.md +++ b/doc/20_Deployment.md @@ -11,11 +11,11 @@ When deploying configurations following steps are necessary: - Rebuild workspaces by running `datahub:configuration:rebuild-workspaces` -Either call +Either call: ```bash datahub:configuration:rebuild-workspaces ``` -to do that for all definitions, or +to do that for all definitions, or: ```bash diff --git a/doc/img/add_config.png b/doc/img/add_config.png index 86e2ca29..a81a52d3 100644 Binary files a/doc/img/add_config.png and b/doc/img/add_config.png differ