search

contao / docs-archive

Contao Documentation
https://docs.contao.org/
Other
43 stars 77 forks source link

Contao compatibility in the cookbook. #378

Closed lionel-m closed 8 years ago

lionel-m commented 8 years ago

Some chapters are compatible with Contao 2 and the others with Contao 3 etc. It would be nice to add a compatibility information or find an alternative solution.

We can create a cookbook for Contao 3.x and another for Contao 4.x and we specify the compatibility with the minor releases e.g. "Compatible with Contao from 3.2 to 3.5" in each chapter.

lionel-m commented 8 years ago

@christianromeni cc for information after discussion in https://github.com/contao/docs/pull/375#issuecomment-221751042.

aschempp commented 8 years ago

I would suggest to add comments like we do in hooks for the version information? https://github.com/contao/docs/blob/master/api/extensions/hooks/addLogEntry.md

christianromeni commented 8 years ago

To be honest... I would recommend that every version would get its own. Reason behind this, is that it might be easily overseen that this function is only working in a specific version.

Also, if I know what version I'm working with, I would always first check the version, then the functionality. Its the same in the manual.

aschempp commented 8 years ago

The cookbook is usually developer related, and the changes for developers in minor releases are so small it does not really make sense to start a new cookbook.

lionel-m commented 8 years ago

We can close this issue for the moment (?)