Drupal investigation

drupal.md

Drupal investigation

Proposal

• We should serve the web map from Drupal
• We can use Drupal custom content types to store policies
• We can use the Drupal REST API to consume policies (it's unclear the link, perhaps the code)
• It's worth investigating what happens with the domain name. Is it pointing directly to Acquia?
• We can store layers as content (each layer has its page and pages can be nested). However this work should be deprioritised as deemed not critical.

Questions

• What's the link between the CMS and the policies? At the moment we use the code of the policy
• Is the domain name pointing directly to Acquia?

Risks

• Loading assets from Drupal is not trivial
• No Drupal experience in the team
• No agreement Acquia

Notes

• You can create a drupal boilerplate project with composer create-project drupal-composer/drupal-project:8.x-dev drupal_dandy --stability dev --no-interaction
• You should merge Docker4Drupal and the create project. The final dir has the web folder and docker-compose.yml in the root of the project
• After you docker-compose up, you can find the URLs you can access here: https://wodby.com/docs/stacks/drupal/local/#domains
• You can set up a Drupal environment with Docker4Drupal and docker-compose https://wodby.com/docs/stacks/drupal/local/
• How to create a simple module with an Hello World controller: https://www.drupal.org/docs/8/creating-custom-modules/create-a-custom-page
• Drupal modules are locates in the modules directory
• Adding JS/CSS to module or theme
  • https://www.drupal.org/docs/8/api/javascript-api/add-javascript-to-your-theme-or-module
  • https://www.drupal.org/docs/8/creating-custom-modules/adding-stylesheets-css-and-javascript-js-to-a-drupal-8-module
• Dynamic assets plugin for drupal https://www.drupal.org/project/dynamic_asset
• Adding JS/CSS to plain request/response https://www.drupal.org/forum/support/module-development-and-code-questions/2018-01-22/add-javascript-and-css-to-plain
• There're two competing plugins for REST on Drupal, the official REST API and https://www.drupal.org/docs/8/modules/jsonapi/jsonapi-vs-cores-rest-module
• How to use and enable REST API in drupal https://drupalize.me/videos/rest-drupal-8?p=2360
• Please note that while the packages for REST are bundled with Drupal they're not active. You should enable RestUI, Restful Web Services, Serialisation and HAL module in the "Extend" section
• The REST UI module doesn't come with Drupal 8. You can install it by downloading it from here https://www.drupal.org/project/restui and placing it in the web/default/modules folder
• The REST UI is used to visually enable permission to query entities. There's a way to define that in code.
• Customising content is a lengthy process, but doable https://www.drupal.org/docs/8/api/entity-api/creating-a-custom-content-type-in-drupal-8. It works with the REST API (it's still part of the "content" permission).

Useful modules

• https://www.drupal.org/project/openid_connect_sso

Going forward

• The recommended way to include CSS, JS and images is to create a minimal template and not a module.
• Create an empty template for the Map View with basic CSS/JS
• Create a custom content page with the policy
• Port the existing app into Drupal
• Integrate the policy selection in the map with the REST API

What I need

• to speak to someone who has created modules with assets (Nao?)