developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Improve plugin install/upgrade docs

Open dennisameling opened this issue 3 years ago • 0 comments

There is a section in the docs called "Install/Upgrade" for plugin developers.

This section has a large deprecation notice in it now:

THIS IS NOW DEPRECATED AND DISCOURAGED FROM USE. USE THE INTEGRATION FRAMEWORK’S MIGRATION INSTEAD.

However, the "Install/Upgrade" section is not only for developers who want to add database migrations. It can also be used in the installation process to check if certain dependencies are installed, etc.

We should merge the docs for "Install/Upgrade" and the new Integration Framework and mention the following:

  • You can use onPluginInstall(), onPluginUpdate, etc. to check things during the installation process
  • Do you need to add custom tables to the database? Use the new isApplicable() and up() methods that the IntegrationsBundle makes available.

image


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

dennisameling avatar Mar 23 '21 09:03 dennisameling