shopsys / shopsys

Main repository for maintaining Shopsys Platform packages. Open for ISSUES and PULL REQUESTS.
https://www.shopsys.com
Other
331 stars 91 forks source link

Information in validation/readme.txt should be moved into docs folder and transferred into md file #406

Open vitek-rostislav opened 6 years ago

vitek-rostislav commented 6 years ago

What is happening

In packages/framework/src/Resources/scripts/common/validation/readme.txt (and duplicated in packages/framework/src/Resources/scripts/admin/validation/readme.txt) there are some useful information about the js validation but the file is lost among source code files.

Content of the files:

Client-side validation requires:
* subform must have HTML container with attribute id="{form_name}_{subform_name}" eg.: customer_deliveryAddressData
* collection of inputs or subforms must have HTML container with attribute id="{form_name}_{collection_name}" eg.: product_parameters
* when dynamically adding new collection item, this code must be added:
    Shopsys.validation.addNewItemToCollection('#{form_name}_{collection_name}', index);
* when dynamically removing new collection item, this code must be added:
  Shopsys.validation.removeItemFromCollection('#{form_name}_{collection_name}', index);

Expected result

The information about js validation are placed in md file in docs.

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because there was no activity within the last 4 months (and it is quite a long time). It will be closed if no further activity occurs. Thank you for your contributions.

pk16011990 commented 5 years ago

ping (prevent stale)

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because there was no activity within the last 4 months (and it is quite a long time). It will be closed if no further activity occurs. Thank you for your contributions.

pk16011990 commented 5 years ago

stale bot, I'm patient...

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because there was no activity within the last 4 months (and it is quite a long time). It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because there was no activity within the last 4 months (and it is quite a long time). It will be closed if no further activity occurs. Thank you for your contributions.

grossmannmartin commented 4 years ago

files are now in packages/framework/assets/js/admin/validation/readme.txt and packages/framework/assets/js/common/validation/readme.txt

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because there was no activity within the last 4 months (and it is quite a long time). It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 3 years ago

This issue has been automatically closed because there was no acivity within the last half a year.