Skip to content

Commit 8c95d26

Browse files
committed
Merge branch 'master' into feature/http-api
# Conflicts: # content/getting-started/satellite/_index.en.md
2 parents cf5a8c8 + e9e5d3e commit 8c95d26

File tree

221 files changed

+14315
-40907
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+14315
-40907
lines changed

.github/workflows/gh-pages.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ on:
44
push:
55
branches:
66
- master
7+
pull_request:
78

89
jobs:
910
deploy:
1011
runs-on: ubuntu-20.04
1112
concurrency:
1213
group: ${{ github.workflow }}-${{ github.ref }}
1314
steps:
14-
- uses: actions/checkout@v2
15+
- uses: actions/checkout@v3
1516
with:
1617
submodules: true
1718
fetch-depth: 0

config.toml

Lines changed: 58 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ theme = "middleware"
55
# site title
66
title = "Gyroscops"
77
# disable language
8-
disableLanguages = []
8+
disableLanguages = ['fr']
99
# google analytics
1010
googleAnalytics = "" # paste your analytics ID here. (Ex: UA-123-45)
1111
publishDir = "docs"
@@ -17,36 +17,59 @@ hasChildren = true
1717

1818
[[menu.main]]
1919
parent = "Getting Started"
20-
name = "Setup"
21-
url = "getting-started/setup"
20+
name = "Environment Setup"
21+
url = "getting-started/environment-setup"
2222
weight = 1
2323

2424
[[menu.main]]
2525
parent = "Getting Started"
26-
name = "Creating Satellites"
27-
url = "getting-started/satellite"
26+
name = "Installation"
27+
url = "getting-started/installation"
2828
weight = 2
2929

3030
[[menu.main]]
3131
parent = "Getting Started"
32-
name = "Pipelines"
33-
url = "getting-started/pipeline"
32+
name = "Writing Configuration"
33+
url = "getting-started/writing-configuration"
3434
weight = 3
3535

3636
[[menu.main]]
3737
parent = "Getting Started"
38-
name = "Workflows"
39-
url = "getting-started/workflow"
38+
name = "Compilation"
39+
url = "getting-started/compilation"
4040
weight = 4
4141

42-
# [[menu.main]]
43-
# parent = "Getting Started"
44-
# name = "Hooks and APIs"
45-
# url = "installation/manual"
46-
# weight = 5
42+
[[menu.main]]
43+
parent = "Getting Started"
44+
name = "Execution"
45+
url = "getting-started/execution"
46+
weight = 5
4747

4848
[[menu.main]]
49+
name = "Core concepts"
4950
weight = 2
51+
hasChildren = true
52+
53+
[[menu.main]]
54+
parent = "Core concepts"
55+
name = "Satellite"
56+
url = "core-concept/satellite"
57+
weight = 1
58+
59+
[[menu.main]]
60+
parent = "Core concepts"
61+
name = "Pipeline"
62+
url = "core-concept/pipeline"
63+
weight = 2
64+
65+
[[menu.main]]
66+
parent = "Core concepts"
67+
name = "Workflow"
68+
url = "core-concept/workflow"
69+
weight = 3
70+
71+
[[menu.main]]
72+
weight = 3
5073
name = "Features"
5174
hasChildren = true
5275

@@ -81,7 +104,7 @@ hasChildren = true
81104
weight = 5
82105

83106
[[menu.main]]
84-
weight = 4
107+
weight = 3
85108
name = "Connectivity"
86109
hasChildren = true
87110

@@ -123,8 +146,8 @@ hasChildren = true
123146

124147
[[menu.main]]
125148
parent = "Connectivity"
126-
name = "NL-JSON"
127-
url = "connectivity/nl-json"
149+
name = "JSON"
150+
url = "connectivity/json"
128151
weight = 7
129152

130153
[[menu.main]]
@@ -145,6 +168,18 @@ hasChildren = true
145168
url = "connectivity/sylius"
146169
weight = 10
147170

171+
[[menu.main]]
172+
parent = "Connectivity"
173+
name = "Prestashop"
174+
url = "connectivity/prestashop"
175+
weight = 11
176+
177+
[[menu.main]]
178+
parent = "Connectivity"
179+
name = "Filtering, drop or reject"
180+
url = "connectivity/filtering"
181+
weight = 12
182+
148183
[params]
149184
logo = "logo-web.svg"
150185
logo_white = "logo-web.svg"
@@ -156,7 +191,8 @@ body_color = "#ddd"
156191
text_color = "#666"
157192
text_color_dark = "#333"
158193
text_color_light = "#eee"
159-
white_color = "#eee"
194+
white_color = "#fff"
195+
light_color = "#eee"
160196
font_family = "lato"
161197

162198
################################ English Language ######################
@@ -165,7 +201,7 @@ languageName = "English"
165201
languageCode = "en-us"
166202
weight = 1
167203
home = "Home"
168-
copyright = "The Gyroscops Documents are copyright © [Kiboko](https://kiboko.fr/) 2020, 2021."
204+
copyright = "The Gyroscops Documentation is copyright © [Gyroscops](https://gyroscops.com/) 2020-2023."
169205

170206
# banner
171207
[Languages.en.params.banner]
@@ -183,7 +219,7 @@ content = "You can reach our sales team we will find together the best way to pr
183219
[Languages.en.params.cta.button]
184220
enable = true
185221
label = "contact us"
186-
link = "contact"
222+
link = "mailto:sales@gyroscops.com"
187223

188224
# Heading in the home page
189225
[Languages.en.params.heading]
@@ -204,7 +240,7 @@ languageName = "Français"
204240
languageCode = "fr-fr"
205241
weight = 2
206242
home = "Accueil"
207-
copyright = "La documentation Gyroscops est copyright © [Kiboko](https://kiboko.fr/) 2020, 2021."
243+
copyright = "La documentation Gyroscops est copyright © [Gyroscops](https://gyroscops.com/) 2020-2023."
208244

209245
# banner
210246
[Languages.fr.params.banner]
@@ -222,7 +258,7 @@ content = "Vous pouvez contacter nos équipes commerciales pour trouver le meill
222258
[Languages.fr.params.cta.button]
223259
enable = true
224260
label = "contactez-nous"
225-
link = "contact"
261+
link = "mailto:sales@gyroscops.com"
226262

227263
# Heading in the home page
228264
[Languages.fr.params.heading]

content/connectivity/akeneo/_index.en.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,15 @@ description: "Connect your Akeneo PIM through pipelines"
88
weight: 1
99
---
1010

11-
- [Goal](#goal)
12-
- [The Akeneo plugin for ETL Pipeline](#the-akeneo-plugin-for-etl-pipeline)
13-
- [The Akeneo expression functions](#the-akeneo-expression-functions)
14-
---
15-
16-
### Goal
17-
18-
The packages listed below aims at the integration of [Akeneo PIM](https://www.akeneo.com) into the [ETL Pipeline](../../components/pipeline)
19-
and [Satellite](../../components/satellite) stacks.
11+
The packages listed below aims at the integration of [Akeneo PIM](https://www.akeneo.com) into the [ETL Pipeline](../../core-concept/pipeline)
12+
and [Satellite](../../core-concept/satellite) stacks.
2013

2114
The tools built for Akeneo is composed of ETL capacities and data processing functions to be used in
22-
[Fast Map](../../components/fast-map).
15+
[Fast Map](../fast-map).
2316

2417
### The Akeneo plugin for ETL Pipeline
2518

26-
This plugin will enable Akeneo connectivity to the [ETL Pipeline](../../components/pipeline), in order to
19+
This plugin will enable Akeneo connectivity to the [ETL Pipeline](../../core-concept/pipeline), in order to
2720
read and write from and to Akeneo PIM. This integration is compatible with both
2821
[Akeneo Enterprise Edition client](https://github.com/akeneo/api-php-client-ee)
2922
and the [Akeneo Community Edition client](https://github.com/akeneo/api-php-client).

content/connectivity/akeneo/expression-language.en.md

Lines changed: 64 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,34 @@ title: "Akeneo expression language functions"
33
date: 2021-01-24T09:23:54+01:00
44
draft: false
55
description: "Functions for manipulating Akeneo API data"
6+
weight: 2
67
---
78

89
{{< feature-state for_mw_version="0.1" state="alpha" >}}
910

1011
- [What is it ?](#what-is-it-)
1112
- [Installation](#installation)
12-
- [Usage](#usage)
13-
- [Functions reference](#functions-reference)
14-
- [Attribute data manipulation](#attribute-data-manipulation)
15-
- [Filter by locale](#filter-by-locale)
16-
- [Filter by scope](#filter-by-scope)
17-
- [Take the first available value by scopes](#take-the-first-available-value-by-scopes)
18-
- [Combining results filter](#combining-results-filter)
19-
- [Excluding results filter](#excluding-results-filter)
20-
- [Extracting a slice of the values list](#extracting-a-slice-of-the-values-list)
21-
- [Extracting the beginning of the values list](#extracting-the-beginning-of-the-values-list)
22-
- [Extracting the end of the values list](#extracting-the-end-of-the-values-list)
23-
- [Extracting the values list, after an offset](#extracting-the-values-list-after-an-offset)
24-
- [Extracting the first value from the list](#extracting-the-first-value-from-the-list)
25-
- [Extracting the last value from the list](#extracting-the-last-value-from-the-list)
26-
- [Dates management with dateTime and dateTimeZone](#dates-management-with-datetime-and-datetimezone)
27-
- [Manage metrics with metricAmount, metricUnit and formatMetric](#manage-metrics-with-metricamount-metricunit-and-formatmetric)
28-
13+
- [Filter Provider](#filter-provider)
14+
- [Usage](#usage)
15+
- [Functions reference](#functions-reference)
16+
- [Attribute data manipulation](#attribute-data-manipulation)
17+
- [Filter by locale](#filter-by-locale)
18+
- [Filter by scope](#filter-by-scope)
19+
- [Take the first available value by scopes](#take-the-first-available-value-by-scopes)
20+
- [Combining results filter](#combining-results-filter)
21+
- [Excluding results filter](#excluding-results-filter)
22+
- [Extracting a slice of the values list](#extracting-a-slice-of-the-values-list)
23+
- [Extracting the beginning of the values list](#extracting-the-beginning-of-the-values-list)
24+
- [Extracting the end of the values list](#extracting-the-end-of-the-values-list)
25+
- [Extracting the values list, after an offset](#extracting-the-values-list-after-an-offset)
26+
- [Extracting the first value from the list](#extracting-the-first-value-from-the-list)
27+
- [Extracting the last value from the list](#extracting-the-last-value-from-the-list)
28+
- [Dates management with dateTime and dateTimeZone](#dates-management-with-datetime-and-datetimezone)
29+
- [Manage metrics with metricAmount, metricUnit and formatMetric](#manage-metrics-with-metricamount-metricunit-and-formatmetric)
30+
- [Builder Provider](#builder-provider)
31+
- [Usage](#builder-provider)
32+
- [Functions reference](#builder-provider)
33+
2934
## What is it ?
3035

3136
This library implements functions for manipulating Akeneo API data through the
@@ -37,7 +42,9 @@ This library implements functions for manipulating Akeneo API data through the
3742
composer require php-etl/akeneo-expression-language
3843
```
3944

40-
## Usage
45+
## Filter Provider
46+
47+
### Usage
4148

4249
To use Akeneo's expression language functions, you must first add the `expression_language` key and put in
4350
the provider `Kiboko\Component\ExpressionLanguage\Akeneo\AkeneoFilterProvider`.
@@ -97,9 +104,9 @@ $interpreter->evaluate($expression, ['input' => $input]);
97104

98105
{{< /tabs >}}
99106

100-
## Functions reference
107+
### Functions reference
101108

102-
### Attribute data manipulation
109+
#### Attribute data manipulation
103110

104111
Akeneo has a specific data format that would make cumbersome the data mapping
105112
if there were no dedicated tools. In this matter the Expression Language functions
@@ -714,3 +721,40 @@ This function will extract the unit part of a metric attribute's value
714721
`formatMetric(array $attribut, string $locale)`
715722

716723
This function will format the metric according to the specified locale
724+
725+
## Builder Provider
726+
727+
The Akeneo API expects you to have certain types of format for your attributes.
728+
The functions provided by the AkeneoBuilderProvider allow you to create the expected formats easily.
729+
730+
### Usage
731+
732+
To use the Akeneo's Builder expression language, you must first add the `expression_language` key and put in
733+
the provider `Kiboko\Component\ExpressionLanguage\Akeneo\AkeneoBuilderProvider`.
734+
735+
Then, in the fields that can use expression languages, you can use any [functions](#builder-functions-reference) provided by
736+
the Akeneo Builder provider.
737+
738+
{{< tabs name="basic_definition" >}}
739+
740+
{{< tab name="YAML" codelang="yaml" >}}
741+
- fastmap:
742+
expression_language:
743+
- 'Kiboko\Component\ExpressionLanguage\Akeneo\AkeneoBuilderProvider'
744+
map:
745+
- field: '[title]'
746+
expression: 'withValue(input["title"])'
747+
{{< /tab >}}
748+
749+
{{< /tabs >}}
750+
751+
### Functions reference
752+
753+
|Name|Description|Example|
754+
|---|---|---|
755+
|build(`string` ...values)|Enables several values to be grouped together in a single ordered array corresponding to the format that the API expects.|build(input["values"])|
756+
|withValue(`string` value, `string` locale, `string` scope)|Creates the expected format for attributes of type single-line text, multi-line text, boolean, date, number, measurement.|withValue(input["variant_name"], "fr_FR", "ecommerce")|
757+
|withSimpleOption(`string` code, `string` attribute, `string` labels, `string` locale = 'null', `string` scope = 'null')|Creates the expected format for single-option attributes.|build(withSimpleOption("PHY","kind", {"fr_FR": "PHY"}))|
758+
|withMultipleOption(`string` codes, `string` attribute, `string` labels, `string` locale, `string` scope)|Creates the expected format for multiple-option attributes.|withMultipleOption(input["collection"], "collection", {"fr_FR": "My collection"}, "fr_FR", "ecommerce")|
759+
|withReferenceEntityValue(`string` value, `string` locale = 'null', `string` channel = 'null')|Creates the expected format for reference entity record attributes of type single-line text, multi-line text, boolean, date, number, measurement.|withReferenceEntityValue(input["label"], "fr_FR")|
760+
|withReferenceEntitySimpleOption(`string` value, `string` locale = 'null', `string` channel = 'null')|Creates the expected format for simple-select reference entity record attributes.|withReferenceEntitySimpleOption(input["associated_crops_code"], "fr_FR")|

content/connectivity/akeneo/plugin.en.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: "Akeneo plugin"
33
date: 2021-01-24T09:23:54+01:00
44
draft: false
55
description: "Akeneo API integration in satellites pipelines"
6+
weight: 1
67
---
78

89
{{< feature-state for_mw_version="0.1" state="alpha" >}}
@@ -114,7 +115,7 @@ The options available are the same as for the [loader](#building-a-loader).
114115

115116
The `merge` option allows you to add data to your dataset, in a sense merging your actual dataset with your new data.
116117

117-
The `map` option comes from the [FastMap](../../../connectivity/fast-map) plugin, you may need to read its documentation
118+
The `map` option comes from the [FastMap](../fast-map) plugin, you may need to read its documentation
118119
to understand how to use it properly.
119120

120121
```yaml
@@ -239,7 +240,7 @@ You may need to read the [filtering documentation of Akeneo API](https://api.ake
239240
The plugin takes into account the [ExpressionLanguage](https://symfony.com/doc/current/components/expression_language.html)
240241
component provided by Symfony.
241242

242-
We have also provided [custom expression](../../akeneo/expression-language) to use when mapping your data.
243+
We have also provided [custom expression](expression-language) to use when mapping your data.
243244

244245
```yaml
245246
akeneo:

0 commit comments

Comments
 (0)