Skip to content

Commit

Permalink
[Docs] small updates (#780)
Browse files Browse the repository at this point in the history
* small updates

* remove dash

* naming

* api key
  • Loading branch information
mcassier31 committed Aug 21, 2023
1 parent fada180 commit 44a4c3b
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 21 deletions.
8 changes: 4 additions & 4 deletions doc/01_Installation_and_Upgrade/01_Upgrade_Notes.md
@@ -1,17 +1,17 @@
# Upgrade Notes

## 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`.
- [General] If you want to use Datahub 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
21 changes: 10 additions & 11 deletions 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).
2 changes: 1 addition & 1 deletion doc/10_GraphQL/01_Configuration/03_Security_Settings.md
Expand Up @@ -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

Expand Down
4 changes: 1 addition & 3 deletions 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

Expand Down
4 changes: 2 additions & 2 deletions doc/20_Deployment.md
Expand Up @@ -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
Expand Down
Binary file modified doc/img/add_config.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 44a4c3b

Please sign in to comment.