Skip to content

Commit 253aa3e

Browse files
arduibagLevFlavien
authored andcommitted
Content modification to have an App instead a Connector
1 parent dc84ccb commit 253aa3e

File tree

11 files changed

+73
-98
lines changed

11 files changed

+73
-98
lines changed

content/guides/ecommerce-connection/step4-define-your-first-scope.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ You have to choose these versions according to:
1616
* The number of potential users owning this version.
1717
* The lifetime of this version. It is useless to specifically develop a version compatible with a version of your eCommerce solution if this one won't exist anymore in a couple of months.
1818

19+
## Follow the guide to build an App!
20+
21+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
22+
1923
## What are Akeneo's recommendations to build the first iteration of an eCommerce App release?
2024

2125
**Our recommendation: always listen to your customer's needs first!**

content/guides/erp-connection/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ Understand your target user: Who will install it? Who will set it up? Who will u
4242
Understand the product information that should flow between your ERP and the PIM.
4343
3. [Understand Akeneo PIM](step3-understand-akeneo-pim.html)
4444
Understand Akeneo PIM, its features, its data structure in order to be able to compare them with your ERP solution.
45-
4. [How to build your App?](step4-how-to-build-your-connector.html)
45+
4. [How to build your App?](step4-how-to-build-your-app.html)
4646
Ready to start? Some last recommendations on how to interact with our PIM...

content/guides/erp-connection/step4-how-to-build-your-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ All you need to know to interact with our PIM through our API can be found in ou
2323

2424
**Our recommendation: always listen to your customer's needs first.**
2525

26-
We are aware that it is quite difficult to develop a 100% complete connector that fits all your customer's needs immediately.
26+
We are aware that it is quite difficult to develop a 100% complete App that fits all your customer's needs immediately.
2727

28-
Once you are comfortable with your customer's needs, our recommendation is to follow the steps we describe and to iterate in order not to miss any important feature. Building an ERP connector is a complex task that requires a dedicated focus every step of the way.
28+
Once you are comfortable with your customer's needs, our recommendation is to follow the steps we describe and to iterate in order not to miss any important feature. Building an ERP App is a complex task that requires a dedicated focus every step of the way.
2929

3030
**To conclude: adopt an Agile approach**
3131

content/guides/print-connection/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
![Asset family illustration](../../img/illustrations/illus--Assetfamily.svg)
33

44
> Do you want to connect your PIM to your print solution?
5-
> You want to implement an Akeneo PIM print connector and you don't know where to start?
5+
> You want to implement an Akeneo PIM print App and you don't know where to start?
66
77
You landed in the right place!
88

@@ -23,4 +23,4 @@ Understand Akeneo PIM, its features, its data structure in order to be able to m
2323
4. [Reconcile PIM data with print capabilities](step3-reconcile-PIM-data-with-print-features.html)
2424
Discover how you can use PIM data on paper products.
2525
5. [Starting your first version](step4-define-your-first-scope.html)
26-
What are Akeneo's recommendations for starting the first version of a print connector?
26+
What are Akeneo's recommendations for starting the first version of a print App?

content/guides/print-connection/step2-understand-akeneo-pim.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@ Then, in order to understand our different editions and their capabilities, you
1616

1717
Play with our PIM!
1818

19-
It is crucial to understand the PIM features and data model in order to create a great print connector.
19+
It is crucial to understand the PIM features and data model in order to create a great print App.
2020

2121
The best way to become an expert at Akeneo PIM is to play with it!
2222
Here, you can access our [Akeneo PIM Community Edition demo platform](http://demo.akeneo.com) (login/password: admin / admin).
2323

2424
:::warning
25-
Please note that this Akeneo PIM CE demo instance is for exploratory purposes only and will only allow you to start getting familiar with Akeneo PIM. This instance is reset frequently and is therefore not intended to be used to build a connector.
25+
Please note that this Akeneo PIM CE demo instance is for exploratory purposes only and will only allow you to start getting familiar with Akeneo PIM. This instance is reset frequently and is therefore not intended to be used to build a App.
2626
:::
2727

28-
If you need an Akeneo PIM **Enterprise Edition** instance to start developing your connector, please [contact us](https://www.akeneo.com/contact/).
28+
If you need an Akeneo PIM **Enterprise Edition** instance to start developing your App, please [contact us](https://www.akeneo.com/contact/).
2929

3030
## Acquire PIM knowledge
3131

3232
We advise you to take a look at our [Helpcenter](https://help.akeneo.com/pim/index.html) where you'll find a lot of documentation about all our features.
3333

3434
If you feel that a comprehensive training program would allow you to know everything about Akeneo PIM, we got you covered as well with our [training sessions](https://www.akeneo.com/training/). Don't hesitate to register!
3535

36-
In the context of building a print connector, here is a selection of PIM concepts you'll need to master before developing anything:
36+
In the context of building a print App, here is a selection of PIM concepts you'll need to master before developing anything:
3737
- The [product](/concepts/products.html#product),
3838
- The [product model](/concepts/products.html#product-model),
3939
- The [family](/concepts/catalog-structure.html#family),

content/guides/print-connection/step3-reconcile-PIM-data-with-print-features.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ Congratulations! Now that you have a good overview of Akeneo PIM data, you need
77
Next step, for each piece of PIM data, you need to ask yourself the following questions:
88

99
1. What data does my print solution need from the PIM?
10-
2. How will the configuration UI of my connector fulfill all of my end users' needs?
11-
3. How flexible does my connector need to be to adapt to any catalog structure created with the PIM?
10+
2. How will the configuration UI of my App fulfill all of my end users' needs?
11+
3. How flexible does my App need to be to adapt to any catalog structure created with the PIM?
1212
4. Documentation: What do I need to document? (Data processing, feature limits, possible settings...)
1313

14-
In order to help you develop your connector features, here are some useful features you can use.
14+
In order to help you develop your App features, here are some useful features you can use.
1515

1616
## API connection configuration
1717

1818
**What is it?**
1919

20-
In order for your connector to communicate with Akeneo PIM, you need to provide a setting to invite Julia to enter her PIM API credentials.
20+
In order for your App to communicate with Akeneo PIM, you need to provide a setting to invite Julia to enter her PIM API credentials.
2121

2222
**What do you need to implement?**
2323

@@ -44,7 +44,7 @@ Here are some examples of filters we believe are relevant:
4444
* Channel: Only import product data related to the selected channel (most of the time a "print" channel).
4545
* Locale: Only import product data related to the selected locale.
4646
* Completeness: A PIM product can be exported if it is complete in terms of data content, translation (localizable attribute), or information specific to the channels you are going to use (attribute with a value per channel).
47-
* Enabled/Disabled status: Each PIM product has an enable/disable status. You can set your connector to only export products that are `enabled`.
47+
* Enabled/Disabled status: Each PIM product has an enable/disable status. You can set your App to only export products that are `enabled`.
4848

4949
And sometimes, your customers may also need to export a PIM product to the print solution based on the following parameters:
5050

@@ -55,11 +55,11 @@ And sometimes, your customers may also need to export a PIM product to the print
5555
* A category tree or a subcategory tree
5656
* ...
5757

58-
**Conclusion:** each customer project has its own requirements and it is important to offer enough flexibility in your connector settings to allow each customer to import only the product information they need according to their own criteria.
58+
**Conclusion:** each customer project has its own requirements and it is important to offer enough flexibility in your App settings to allow each customer to import only the product information they need according to their own criteria.
5959

6060
**What do you need to implement?**
6161

62-
In the features of your connector configuration page, in order to be able to cover all of your customers' needs, you can choose to have one of the two filter systems. Either a “simple” one for straightforward use cases or an “advanced” one for the most specific requirements.
62+
In the features of your App configuration page, in order to be able to cover all of your customers' needs, you can choose to have one of the two filter systems. Either a “simple” one for straightforward use cases or an “advanced” one for the most specific requirements.
6363

6464
### Products with variants
6565

@@ -109,7 +109,7 @@ Apart from taking into consideration all these PIM modeling capabilities, you al
109109

110110
::: warning
111111
The number of images that a catalog can contain can be quite large and we know that images dedicated to a print catalog can be very heavy (high definition).
112-
Make sure you have all the mechanisms in your connector to optimize the performance to manage image binaries.
112+
Make sure you have all the mechanisms in your App to optimize the performance to manage image binaries.
113113
:::
114114

115115

@@ -172,7 +172,7 @@ The introduction of [our documentation on Reference Entities](https://help.akene
172172

173173
As you can see, Reference Entities can be used to enrich product information or to create dedicated pages with product relationships.
174174

175-
Keep in mind that Julia can use "Reference Entities" for a wide variety of needs, you might have to adapt accordingly.
175+
Keep in mind that Julia can use "Reference Entities" for a wide variety of needs, you might have to adapt accordingly.
176176

177177
**What do you need to implement?**
178178

content/guides/print-connection/step4-define-your-first-scope.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
11
# Define the scope of your first version
22

3-
## A "Connection-compliant" connector
4-
5-
The best way to interact with Julia's PIM is to develop a "[Connection-compliant](https://help.akeneo.com/pim/serenity/articles/what-is-a-connection.html)" connector (based on our API).
6-
7-
:::tips
8-
Why?
9-
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
10-
:::
11-
12-
## Follow the guide!
3+
## Find your PIM compatibility
134

145
As [mentioned before](step2-understand-akeneo-pim.html), there are [several editions](https://www.akeneo.com/compare-editions/) and several supported versions of Akeneo PIM.
156

16-
Of course, the choice of the PIM version/edition depends on your business but we strongly encourage you to develop a connector that is fully compatible with our latest **SaaS edition**.
7+
Of course, the choice of the PIM version/edition depends on your business but we strongly encourage you to develop an App that is fully compatible with our latest **SaaS edition**.
178

189
To know more about the different PIM versions, don't hesitate to consult our blog section on our [PIM release cycle](https://www.akeneo.com/blog/akeneo-introduces-a-simpler-product-release-cycle/).
1910

2011
You can also consult our [release notes](https://www.akeneo.com/release-notes/) and our ["new key features released" page](https://help.akeneo.com/pim/serenity/whats-new.html) to understand more about the latest Akeneo supported **versions** and their brand new features.
2112

22-
Well, now you can [start here](https://api.akeneo.com/getting-started/connect-the-pim-4x/welcome.html) to connect your print solution with our API! 🚀
13+
## Follow the guide to build an App!
14+
15+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
16+
17+
## Use our API
18+
19+
:::tips
20+
Why?
21+
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
22+
:::
23+
24+
Well, now you can [start here](https://api.akeneo.com/documentation/introduction.html) to connect your print solution with our API! 🚀
2325

2426
## Step by step
2527

2628
**Our recommendation: always listen to your customer's needs first!**
2729

28-
We are aware that it is difficult and expensive in terms of investment to achieve a 100% complete print connector that is flexible enough to adapt to any customer project.
30+
We are aware that it is difficult and expensive in terms of investment to achieve a 100% complete print App that is flexible enough to adapt to any customer project.
2931

30-
Furthermore, to build such a complex connector as a print connector in a single iteration would undoubtedly be too complex to design from scratch.
32+
Furthermore, to build such a complex App as a print App in a single iteration would undoubtedly be too complex to design from scratch.
3133

3234
**Our advice: adopt an Agile approach!**
3335

content/guides/syndication-connection/step3-define-your-first-scope.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
# Define the scope of your first version
22

3-
## A "Connection-compliant" App
4-
5-
The best way to interact with Julia's PIM is to develop a "[Connection-compliant](https://help.akeneo.com/pim/serenity/articles/what-is-a-connection.html)" App (based on our API).
6-
7-
:::tips
8-
Why?
9-
Please don't hesitate to read our ["4 reasons why you should use our API"](https://api.akeneo.com/documentation/why-the-api.html#4-reasons-why-you-should-use-our-api) page.
10-
:::
11-
12-
## Follow the guide!
3+
## Find your PIM compatibility
134

145
As [mentioned before](step2-understand-akeneo-pim.html), there are [several editions](https://www.akeneo.com/compare-editions/) and several supported version of Akeneo PIM.
156

@@ -19,7 +10,9 @@ To know more about the different PIM versions, don't hesitate to consult our blo
1910

2011
You can also consult our [release notes](https://www.akeneo.com/release-notes/) and our ["new key features released" page](https://help.akeneo.com/pim/serenity/whats-new.html) to understand more about the latest Akeneo supported **versions** and their brand new features.
2112

22-
Well, now you can [start here](https://api.akeneo.com/getting-started/connect-the-pim-4x/welcome.html) to connect your syndication solution with our API! 🚀
13+
## Follow the guide to build an App!
14+
15+
We have a ["complete guide"](https://api.akeneo.com/apps/introduction.html) to understand how to build an App.
2316

2417
## Step by step
2518

content/guides/translation-connection/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ We're here to help you find your way around, understand how Akeneo PIM will inte
1414

1515
## Follow the steps!
1616

17-
1. [Who is your connector for?](step1-who-is-your-app-for.html)
17+
1. [Who is your App for?](step1-who-is-your-app-for.html)
1818
Understand your target user: Who will install it? Who will set it up? Who will use it? What are their needs?
1919
2. [Understand Akeneo PIM](step2-understand-akeneo-pim.html)
2020
Understand Akeneo PIM product structure and what data can be translated.
21-
3. [How to build your connector?](step3-how-to-build-your-connector.html)
21+
3. [How to build your App?](step3-how-to-build-your-app.html)
2222
Discover Akeneo PIM interaction capabilities to enable product data translation.
2323
4. [Known limits](step4-known-limits.html)
2424
Also understand the current limits of the suggested design...

0 commit comments

Comments
 (0)