update titles and folder names (#759)

pimcore · Jun 30, 2023 · 836c690 · 836c690
1 parent 5885f4e
commit 836c690
Show file tree

Hide file tree

Showing 41 changed files with 77 additions and 72 deletions.
diff --git a/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md b/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md
@@ -1,8 +1,6 @@
 # Schema Settings
 
-Schema settings define which data entities (data object classes, assets, documents) should be exposed 
-via the endpoint. For assets and documents, default schemas are provided, for data object classes the
-schema can be defined in the field configuration. 
+Schema settings define which data entities (Data Object classes, Assets, Documents) should be exposed via the endpoint. For Assets and Documents, default schemas are provided, for Data Object classes the schema can be defined in the field configuration. 
 
 ![Add](../../img/graphql/schema_add.png)
 

diff --git a/doc/10_GraphQL/01_Configuration/03_Security_Settings.md b/doc/10_GraphQL/01_Configuration/03_Security_Settings.md
@@ -1,4 +1,4 @@
-## Security Settings
+# Security Settings
 
 ## Authentication
 
@@ -9,7 +9,7 @@ Defines how users are authenticated when accessing the endpoint.
 * API Key: needs to be sent with every request.
 * ... more to come
 
-## Introspection settings
+## Introspection Settings
 
 Introspection provides an information about queries which are supported by GraphQl schema. This is currently enabled by default. It can be disabled via security settings or in the symfony configuration tree:
 ```

diff --git a/doc/10_GraphQL/01_Configuration/15_Customize_Endpoint_URL.md b/doc/10_GraphQL/01_Configuration/15_Customize_Endpoint_URL.md
@@ -1,4 +1,4 @@
-## Customizing the endpoint
+# Customizing the Endpoint
 
 The standard endpoint is
 ```

diff --git a/doc/10_GraphQL/04_Query/01_Document_Queries.md b/doc/10_GraphQL/04_Query/01_Document_Queries.md
@@ -1,14 +1,14 @@
 # Document Queries
 
-## Supported Document types
+## Supported Document Types
 
 * Email
 * Hardlink
 * Link
 * Page
 * Snippet
 
-## Supported Page Element types
+## Supported Page Element Types
 
 * Areablock
 * Checkbox
@@ -32,7 +32,7 @@
 
 ## Document Query Samples
 
-### Fetch Document Page and get date editable
+### Fetch Document Page and Get Date Editable
 
 ```graphql
 {
@@ -54,7 +54,7 @@
 ```
 
 
-### Fetch Document Page and get all editables, including the inherited editables
+### Fetch Document Page and Get All Editables, Including the Inherited Editables
 
 ```graphql
 {
@@ -69,7 +69,7 @@
 }
 ```
 
-## Fetch Document Page via data object relation and get more editable data
+## Fetch Document Page via Data Object Relation and Get More Editable Data
 
 * get data object ID 61
 * get many-to-one relation
@@ -140,7 +140,7 @@ Get Link Document and resolve the target news text.
 
 see [Element Properties](./11_Query_Samples/05_Sample_Element_Properties.md)
 
-## Fetch Document Translation links
+## Fetch Document Translation Links
 
 ```graphql
 {
@@ -162,7 +162,7 @@ see [Element Properties](./11_Query_Samples/05_Sample_Element_Properties.md)
 
 ```
 
-### Fetch Language specific Document Translation Link
+### Fetch Language Specific Document Translation Link
 
 ```graphql
 {

diff --git a/doc/10_GraphQL/04_Query/04_Asset_Queries.md b/doc/10_GraphQL/04_Query/04_Asset_Queries.md
@@ -2,7 +2,7 @@
 
 Asset queries support getting single assets, single asset folders and asset listings. 
 
-## Get single Asset
+## Get Single Asset
 
 Base structure for getting single asset: 
 
@@ -20,7 +20,7 @@ See also following examples:
 - [Sample Asset Metadata](./11_Query_Samples/12_Sample_Asset_Metadata.md)
 
 
-## Get single AssetFolder
+## Get Single Asset Folder
 
 Base structure for getting single asset folder (same as for assets): 
 
@@ -33,7 +33,7 @@ Base structure for getting single asset folder (same as for assets):
 
 ```
 
-## Get list of Assets
+## Get List of Assets
 
 Base structure for getting a list of assets, restricted by IDs: 
 

diff --git a/doc/10_GraphQL/04_Query/05_DataObject_Queries.md b/doc/10_GraphQL/04_Query/05_DataObject_Queries.md
@@ -1,6 +1,6 @@
 # DataObject Queries
 
-## Supported data types
+## Supported Data Types
 
 Also check out the Pimcore's [data type documentation](https://pimcore.com/docs/6.x/Development_Documentation/Objects/Object_Classes/Data_Types/index.html). 
 
@@ -51,7 +51,7 @@ Also check out the Pimcore's [data type documentation](https://pimcore.com/docs/
 * Video
 * Wysiwyg
 
-## Available query operators
+## Available Query Operators
 
 Check out the [Operators](./06_Operators.md) page for more information.
 
@@ -79,7 +79,7 @@ Base structure for getting single data object:
 
 ```
 
-## Get list of Data Objects 
+## Get List of Data Objects 
 
 Base structure for getting a list of data objects, restricted by IDs: 
 
@@ -169,7 +169,7 @@ For details see [filtering documentation page](./10_Filtering.md)
 Queries can be localized For details see the [localization documentation page](./08_Localization.md).
 
 
-## Extend Data Object queries
+## Extend Data Object Queries
 It is possible to add custom query data types and query operators. For details see detail documentation
 pages: 
 * [Add a custom query datatype](./15_Add_Custom_Query_Datatype.md)

diff --git a/doc/10_GraphQL/04_Query/06_Operators.md b/doc/10_GraphQL/04_Query/06_Operators.md
@@ -1,4 +1,4 @@
-## Query Operators
+# Query Operators
 
 Operators allow to modify and transform the data before it is delivered to the endpoint. 
 

diff --git a/doc/10_GraphQL/04_Query/08_Localization.md b/doc/10_GraphQL/04_Query/08_Localization.md
@@ -1,4 +1,4 @@
-## Localization
+# Localization
 
 ### Default Language
 
@@ -13,7 +13,7 @@ for single and listing queries.
 }
 ```
 
-### Define language on field level
+### Define Language on Field Level
 
 However, you can always provide an alternative language for a specific field.
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/05_Sample_Element_Properties.md b/doc/10_GraphQL/04_Query/11_Query_Samples/05_Sample_Element_Properties.md
@@ -1,11 +1,10 @@
-## Get Element Properties
+# Get Element Properties
 
 ![Sample Document Properties](../../../img/graphql/element_properties.png)
 
 ### Request
 
-Properties can be filtered by providing the `keys` argument. All properties will
-be returned by default.
+Properties can be filtered by providing the `keys` argument. All properties will be returned by default.
 
 ```graphql
 {

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/08_ClassificationStore.md b/doc/10_GraphQL/04_Query/11_Query_Samples/08_ClassificationStore.md
@@ -1,6 +1,6 @@
 # Classification Store
 
-## Supported data types
+## Supported Data Types
 
 * BooleanSelect
 * Calculated Value
@@ -24,7 +24,7 @@
 * Wysiwyg
 
 
-## Request example
+## Request Example
 
 `csfield` is the classification store field.
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/10_Sample_GetTranslation.md b/doc/10_GraphQL/04_Query/11_Query_Samples/10_Sample_GetTranslation.md
@@ -1,4 +1,4 @@
-## Get Translation By Key
+# Get Translation By Key
 
 If you want to access one translation.
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/11_Sample_GetAsset.md b/doc/10_GraphQL/04_Query/11_Query_Samples/11_Sample_GetAsset.md
@@ -1,6 +1,6 @@
-## Get Asset By Id
+# Get Asset By Id
 
-If you want to access a asset directly.
+If you want to access an Asset directly.
 Note that the data will be base64 encoded and quite time-consuming to deliver.
 
 Deeplink: [http://pimcore-demo-basic.pim.zone/admin/login/deeplink?asset_4_image](http://pimcore-demo-basic.pim.zone/admin/login/deeplink?asset_4_image)

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/12_Sample_Asset_Metadata.md b/doc/10_GraphQL/04_Query/11_Query_Samples/12_Sample_Asset_Metadata.md
@@ -1,4 +1,4 @@
-## Get Asset Metadata
+# Get Asset Metadata
 
 ![Metadata](../../../img/graphql/asset_metadata.png)
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/13_Sample_GetAssetListing.md b/doc/10_GraphQL/04_Query/11_Query_Samples/13_Sample_GetAssetListing.md
@@ -1,4 +1,4 @@
-## Get Asset Listing
+# Get Asset Listing
 
 ### Request
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/14_Sample_GetTranslationListing.md b/doc/10_GraphQL/04_Query/11_Query_Samples/14_Sample_GetTranslationListing.md
@@ -1,4 +1,4 @@
-## Get Translation Listing
+# Get Translation Listing
 
 ### Request
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/20_Sample_Manufacturer_Listing.md b/doc/10_GraphQL/04_Query/11_Query_Samples/20_Sample_Manufacturer_Listing.md
@@ -1,4 +1,4 @@
-## Get Manufacturer Listing
+# Get Manufacturer Listing
 
 ![Grid](../../../img/graphql/manufacturer_listing.png)
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/21_Sample_ManyToMany_Object_Relation.md b/doc/10_GraphQL/04_Query/11_Query_Samples/21_Sample_ManyToMany_Object_Relation.md
@@ -1,4 +1,4 @@
-## Many-to-Many Object Relation
+# Many-to-Many Object Relation
 
 ![Data](../../../img/graphql/many_to_many_object_relation.png)
 

diff --git a/...phQL/04_Query/11_Query_Samples/22_Sample_Advanced_ManyToMany_Object_Relation.md b/...phQL/04_Query/11_Query_Samples/22_Sample_Advanced_ManyToMany_Object_Relation.md
@@ -1,4 +1,4 @@
-## Advanced Many-to-Many Object Relation + Metadata
+# Advanced Many-to-Many Object Relation and Metadata
 
 >TODO: Align this with the new demo as soon as reasonable content is available. 
 

diff --git a/...QL/04_Query/11_Query_Samples/23_Sample_Advanced_ManyToMany_Relation_Metadata.md b/...QL/04_Query/11_Query_Samples/23_Sample_Advanced_ManyToMany_Relation_Metadata.md
@@ -1,4 +1,4 @@
-## Get Advanced Many-to-Many Relation Metadata
+# Get Advanced Many-to-Many Relation Metadata
 
 ![Metadata](../../../img/graphql/many2many.png)
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/24_Sample_Fieldcollections.md b/doc/10_GraphQL/04_Query/11_Query_Samples/24_Sample_Fieldcollections.md
@@ -1,9 +1,8 @@
-## Field-Collections on Data Objects
+# Field-Collections on Data Objects
 
 ### Configuration
 
-If you want to run this sample on the [Official Demo Site](https://demo.pimcore.fun), please
-create the following configuration
+If you want to run this sample on the [Official Demo Site](https://demo.pimcore.fun), please create the following configuration
 
 ![Schema](../../../img/graphql/news_configuration.png)
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/25_Sample_Parent_Children_Siblings.md b/doc/10_GraphQL/04_Query/11_Query_Samples/25_Sample_Parent_Children_Siblings.md
@@ -1,4 +1,4 @@
-## Get objects Parent/Children/Siblings
+# Get objects Parent/Children/Siblings
 
 For example, to get `berlina` object's (id:261) parent, children and siblings
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/26_Sample_Get_Linked_Data.md b/doc/10_GraphQL/04_Query/11_Query_Samples/26_Sample_Get_Linked_Data.md
@@ -1,4 +1,6 @@
-## Get Car with referenced Manufacturer + Manufacturer Logo image thumbnail
+# Get Linked Data
+
+## Get Car With Referenced Manufacturer and Manufacturer Logo Image Thumbnail
 
 ### Configuration
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/27_Sample_Translate_Values.md b/doc/10_GraphQL/04_Query/11_Query_Samples/27_Sample_Translate_Values.md
@@ -1,4 +1,4 @@
-## Translate Values
+# Translate Values
 
 The following example translates the `AccessoryPart` condition value.
 

diff --git a/doc/10_GraphQL/04_Query/11_Query_Samples/_category_.json b/doc/10_GraphQL/04_Query/11_Query_Samples/_category_.json
@@ -0,0 +1,3 @@
+{
+    "label": "Query Samples"
+}
diff --git a/doc/10_GraphQL/04_Query/16_Add_Custom_Query_Operator.md b/doc/10_GraphQL/04_Query/16_Add_Custom_Query_Operator.md
@@ -4,7 +4,7 @@ For adding a new query operator two steps are necessary:
 - add a type definition
 - add the operator implementation
 
-### Type definition
+### Type Definition
 
 Add a section similar to this one to your `services.yml` file.
 

diff --git a/doc/10_GraphQL/04_Query/20_Add_Custom_Query.md b/doc/10_GraphQL/04_Query/20_Add_Custom_Query.md
@@ -1,4 +1,4 @@
-## Add Custom Query
+# Add a Custom Query
 
 You can extend the query schema and add your custom query in the following way.
 

diff --git a/doc/10_GraphQL/07_Mutation/01_Document_Mutations.md b/doc/10_GraphQL/07_Mutation/01_Document_Mutations.md
@@ -1,13 +1,13 @@
-## Document Mutations
+# Document Mutations
 
-## Supported Document types
+## Supported Document Types
 
 * Email
 * Link
 * Page
 * ...
 
-## Supported Page Element types
+## Supported Page Element Types
 
 * Areablock
 * Block
@@ -32,7 +32,7 @@ creating and updating documents.
 
 Update or add single or multiple editables by defining their exact name and their content.
 
-##### Sample (Update existing document)
+##### Sample (Update Existing Document)
 
 
 ```graphql
@@ -74,7 +74,7 @@ See following list for more examples with the free-form API approach:
 If you are not familiar with Pimcore's [editable naming strategy](https://pimcore.com/docs/6.x/Development_Documentation/Documents/Editable_Naming_Strategies.html)
 you can also use the nested approach.
 
-### Sample (Update a page with an areablock using the nested approach)
+### Sample (Update a Page With an Areablock Using the Nested Approach)
 
 ```graphql
 mutation {

diff --git a/doc/10_GraphQL/07_Mutation/04_Asset_Mutations.md b/doc/10_GraphQL/07_Mutation/04_Asset_Mutations.md
@@ -6,7 +6,7 @@ TODO add sample
 
 ## Update Asset
 
-This will rename the asset + update the data.
+This will rename the Asset and update the data.
 Request:
 ```
 mutation {

diff --git a/doc/10_GraphQL/07_Mutation/20_DataObject_Mutations.md b/doc/10_GraphQL/07_Mutation/20_DataObject_Mutations.md
@@ -1,4 +1,4 @@
-## DataObject Mutations
+# DataObject Mutations
 
 >TODO: Align this with the new demo as soon as reasonable content is available.
  
@@ -14,7 +14,7 @@ In addition, you can turn on mutations to modify assets, create object folders a
 Note that for `Create` and `Update` operate you can query the updated data using the same request.
 Keep in mind that for all kinds of mutations you need the `Write` permission.
 
-## Supported mutation datatypes
+## Supported Mutation Datatypes
 
 ![Mutation grid](../../img/graphql/mutation_grid.png)
 
@@ -55,7 +55,7 @@ Also check out the Pimcore's [data type documentation](https://pimcore.com/docs/
 * Time
 * Wysiwyg
 
-## Supported mutation operators
+## Supported Mutation Operators
 
 * IfEmpty
 * Locale Switcher
@@ -158,7 +158,7 @@ Response:
 
 
 
-## Extend Data Object mutations
+## Extend Data Object Mutations
 It is possible to add custom mutation data types and mutation operators. For details see detail documentation
 pages: 
 * [Add a custom mutation datatype](./25_Add_Custom_Mutation_Datatype.md)

diff --git a/doc/10_GraphQL/07_Mutation/21_Mutation_Operators.md b/doc/10_GraphQL/07_Mutation/21_Mutation_Operators.md
@@ -1,4 +1,4 @@
-## Mutation Operators
+# Mutation Operators
 
 Operators allow to modify and transform the data before it is stored in Pimcore.