pim-docs icon indicating copy to clipboard operation
pim-docs copied to clipboard

[Cookbook] CSV formats, attribute data structure

Open a2xchip opened this issue 9 years ago • 2 comments

I'm requesting enhancement

Story

Attribute data structure page was introduced and updated recently by @fitn and merged in branches by @juliensnz

As @jmleroux mentioned during commit conversation: it was created for current stable 1.5 branch.

I

After merging PR we got the same page version for master. But as I mentioned during conversation its information must be updated according to pim-community-dev master branch to correspond to the structure we have i.e.:

  • type
  • allowed_extensions
  • available_locales
  • code
  • date_max
  • date_min
  • decimals_allowed
  • default_metric_unit
  • group
  • label-locale
  • localizable
  • max_characters
  • max_file_size
  • metric_family
  • minimum_input_length
  • negative_allowed
  • number_max
  • number_min
  • reference_data_name
  • scopable
  • unique
  • useable_as_grid_filter
  • validation_regexp
  • validation_rule
  • wysiwyg_enabled

II

Currently I'm trying to finish Product information page see #295 and issue #267 , that describes how all product related data is kept and organized in PIM. And there is topic about product attribute types and table describing native attribute types, and as i see now this table is pretty close to that on Attribute data structure page. To make documentation clearer we need to avoid duplication and decide where is the place for attributes native types listing table. Anyway I don't think that page describing attribute data structure must contain information about attribute types at least in that part related to next PIM version tech doc, and the reason it is located there is because there was no dedicated page describing attribute types.

Now as i found updated Import/Export documentation in master I will update my PR for Product Information page with note-references to import/export pages apart for each product related entity described.

Task

  • Update Attribute data structure page on master to the actual master structure as in issue description above;
  • Avoid content duplication: to decide where is the best place for attribute types listing table and remove duplication.

a2xchip avatar Apr 18 '16 23:04 a2xchip

@nidup Is not documentation repository popular? Why nobody wants to discuss it? This is about documentation consistency and mono-style.

a2xchip avatar Apr 29 '16 20:04 a2xchip

@a2xchip not the repo the most popular for sure :wink:

:tada: Thank you a lot for opening the discussion :tada:

1/ Yes we we should add missing columns (new attribute properties) in the import format (in the master only)

2/ Yes we should avoid to duplicated such content, we should remove the list of attribute types from here http://docs.akeneo.com/master/reference/import_export/formats/attribute.html#attribute-types and add a link from this page to this page http://docs.akeneo.com/master/reference/product_information/index.html#attribute-type

Don't hesitate to open a PR on the master for this change, we'll merge it quickly.

BTW, thank you for re-introducing the product information page in reference doc, I'm pretty sure it really helps a new comer to understand concept and what are the different objects responsibilities

nidup avatar Apr 30 '16 13:04 nidup