-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation Sprint | Installing Modules (#1330)
* Add composer example. * Image for drupal_composer_dependencies examples * Adds Screenshot * Add a little formatting * Update install-enable-drupal-modules.md * Update install-enable-drupal-modules.md * Update install-enable-drupal-modules.md
- Loading branch information
1 parent
4a98acf
commit 458de5b
Showing
2 changed files
with
14 additions
and
2 deletions.
There are no files selected for viewing
Binary file added
BIN
+42 KB
docs/assets/install-enable-drupal-modules_drupal_composer_dependencies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions
16
docs/technical-documentation/install-enable-drupal-modules.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,18 @@ | ||
## Downloading and Enabling Drupal Modules and Themes | ||
|
||
Islandora 8 can make use of majority of the Drupal 8 [modules](https://www.drupal.org/project/project_module) and [themes](https://www.drupal.org/project/project_theme). Common use cases have been documented in the [Islandora 8 Cookbook](https://github.com/manez/Islandora-Cookbook). There are several ways to download and install Drupal modules. Please refer to [this guide](https://www.drupal.org/docs/8/extending-drupal-8) on Drupal.org. | ||
Islandora 8 can make use of majority of the Drupal 8 [modules](https://www.drupal.org/project/project_module) and [themes](https://www.drupal.org/project/project_theme). Common use cases have been documented in the [Islandora 8 Cookbook](https://github.com/Islandora-Labs/Islandora-Cookbook). There are several ways to download and install Drupal modules. Please refer to [this guide](https://www.drupal.org/docs/8/extending-drupal-8) on Drupal.org. | ||
|
||
[Composer](https://www.drupal.org/docs/develop/using-composer/using-composer-to-install-drupal-and-manage-dependencies) is the recommended method to install and update drupal modules and themes in Islandora 8. In the [Islandora 8 playbook](https://github.com/Islandora-Devops/claw-playbook), you can add a Drupal module's or theme's machine name to the `drupal_composer_dependencies` variable [here](https://github.com/Islandora-Devops/claw-playbook/blob/master/inventory/vagrant/group_vars/webserver/drupal.yml). To enable the Drupal module or theme, add the module machine name to the `drupal_enable_modules` variable as well. For modules that require additional steps, additional tasks may need to be added to the Ansible playbook. Re-provisioning your instance via Ansible will install the module. | ||
[Composer](https://www.drupal.org/docs/develop/using-composer/using-composer-to-install-drupal-and-manage-dependencies) is the recommended method to install and update drupal modules and themes in Islandora 8. | ||
```shell | ||
$ composer require "<vendor>/<package>:<version>" | ||
|
||
# Example | ||
$ composer require "islandora/islandora_defaults:1.0.0" | ||
``` | ||
|
||
In the [Islandora 8 playbook](https://github.com/Islandora-Devops/claw-playbook), you can add a Drupal module's or theme's machine name to the `drupal_composer_dependencies` variable [here](https://github.com/Islandora-Devops/islandora-playbook/blob/master/inventory/vagrant/group_vars/webserver/drupal.yml). | ||
To enable the Drupal module or theme, add the module machine name to the `drupal_enable_modules` variable as well. | ||
|
||
![alt text](../assets/install-enable-drupal-modules_drupal_composer_dependencies.png?raw=true "drupal_composer_dependencies Screenshot") | ||
|
||
For modules that require additional steps, additional tasks may need to be added to the Ansible playbook. Re-provisioning your instance via Ansible will install the module. |