Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Improve plugin install/upgrade docs #192

Open
dennisameling opened this issue Mar 23, 2021 · 0 comments
Open

Improve plugin install/upgrade docs #192

dennisameling opened this issue Mar 23, 2021 · 0 comments

Comments

@dennisameling
Copy link
Member

dennisameling commented Mar 23, 2021

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant