Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fitn committed Mar 3, 2016
1 parent 906dcd8 commit 99211b0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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.
14 changes: 4 additions & 10 deletions Resources/doc/Home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/akeneo/pim-community-standard>`__.
Expand All @@ -20,6 +18,10 @@ Getting started
- `Initializing the PIM with a XLSX
file <Getting-started.rst#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
------------------------------------

Expand All @@ -39,11 +41,3 @@ Define system element (for integrators)
- `Choices <Choices-tab.rst>`__
- `Metric types <Metric-types.rst>`__
- `Metric units <Metric-units.rst>`__

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.

0 comments on commit 99211b0

Please sign in to comment.