From 99211b05d59c377ed4897fc89807cd67a2aceb77 Mon Sep 17 00:00:00 2001 From: Romain Monceau Date: Thu, 3 Mar 2016 17:27:23 +0100 Subject: [PATCH] Update documentation --- README.md | 17 +++++++++++++++-- Resources/doc/Home.rst | 14 ++++---------- 2 files changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1260d2e..02a4c5c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/akeneo-labs/ExcelConnectorBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/akeneo-labs/ExcelConnectorBundle/?branch=master) [![Build Status](https://travis-ci.org/akeneo-labs/ExcelConnectorBundle.svg?branch=master)](https://travis-ci.org/akeneo-labs/ExcelConnectorBundle) +![alt text](./Resources/doc/pictures/akeneo_excel.png "") + This bundle adds support of Excel XSLX files as a source for initializing catalog structure and import/export of products for [Akeneo PIM](https://github.com/akeneo/pim-community-standard). ## Requirements @@ -13,7 +15,7 @@ This bundle adds support of Excel XSLX files as a source for initializing catalo | v1.5.* | v1.4.* | | v1.4.* | v1.3.* | | v1.3.* | v1.2.* | -| v1.1.\*, v1.2.\* | v1.1.\* | +| v1.1.\*, v1.2.\* | v1.1.* | | v1.0.* | v1.0.* | ## Installation @@ -44,9 +46,13 @@ Then clean the cache and reinstall the assets: ## Documentation -See [Resources/doc folder](./Resources/doc/Home.rst) for more details on how to set your catalog structure +### Getting started + +See [Resources/doc/Getting started](./Resources/doc/Getting-started.rst) for more details on how to set your catalog structure using the [init.xslx](./Resources/fixtures/minimal/init.xlsx) file. +See [Resources/doc folder](./Resources/doc/Home.rst) for more details on how to set your catalog structur + ### Supported file Input file must follow [init.xslx](./Resources/fixtures/minimal/init.xlsx) structure. @@ -57,3 +63,10 @@ that are available in the spreadsheet. This bundle allows you to import products files directly in the UI through Import > Import jobs. Please note that the init.xlsx import is also available via the UI. However, it should not be used as an import system for entities available within this file (families, categories, etc.) once the catalog structure has been set. + + +## Troubleshooting + +###The import fails when importing families + +Check that your channels names are correct in both family and channel tabs. You might have a typo in the channels tab and not in the family tab. You will have to remove the mispelled channel once you corrected this. diff --git a/Resources/doc/Home.rst b/Resources/doc/Home.rst index dcb017b..2bfcc34 100644 --- a/Resources/doc/Home.rst +++ b/Resources/doc/Home.rst @@ -4,8 +4,6 @@ What is Akeneo Excel Connector Bundle? .. figure:: /Resources/doc/pictures/akeneo_excel.png :alt: Logo ExcelConnector - Logo ExcelConnector - This bundle adds support of Excel XSLX files as a source for initialization and importation of catalog structure for `Akeneo PIM `__. @@ -20,6 +18,10 @@ Getting started - `Initializing the PIM with a XLSX file `__ +**Note:** The file init.xslx must be opened and edited with Excel. Usage +of LibreOffice/OpenOffice disables validation of input and can lead to +malformed file. + Define the structure of your catalog ------------------------------------ @@ -39,11 +41,3 @@ Define system element (for integrators) - `Choices `__ - `Metric types `__ - `Metric units `__ - -Troubleshooting ---------------- - -The import fails when importing families -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Check that your channels names are correct in both family and channel tabs. You might have a typo in the channels tab and not in the family tab. You will have to remove the mispelled channel once you corrected this. -