Skip to content
Snippets Groups Projects
Commit af78cb42 authored by Carina Antunes's avatar Carina Antunes
Browse files

Merge branch 'no-customizations' into 'master'

Update documentation with No Customization on Drupal

See merge request drupal/paas/drupal-documentation!38
parents 95833d04 83868bef
No related branches found
No related tags found
No related merge requests found
# Dependencies
/node_modules
docs/node_modules
# Production
/build
docs/build
# Generated files
.docusaurus
......@@ -14,9 +14,10 @@
.env.development.local
.env.test.local
.env.production.local
.idea
npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json
\ No newline at end of file
package-lock.json
......@@ -2,26 +2,21 @@
slug: /modules
---
# Introduction to Modules
In the context of Drupal, a module is a software package which provides functionality not offered through Drupal itself.
At CERN, this could be integration with CDS (https://cds.cern.ch/) to host media or Indico (https://indico.cern.ch/) to import and display events.
By default, all CERN websites include a collection of CERN-specific modules through the centrally managed CERN Drupal Distribution.
In addition to official CERN modules developed and maintained by the Web Team, the distribution also includes a collection of carefully cuarated community contributed modules, ensuring that the most common use-cases are accommodated out-of-the-box.
While we always recommend websites to stick with what is included in the CERN Drupal Distribution, it is possible to install any number of modules made available to the wider Drupal community via https://www.drupal.org/project/project_module if such functionality is absolutely necessary.
Kindly note, however, that installing community contributed modules in this manner requires website owners to assume responsibility of continued compatibility and maintenance in the event that the project becomes incompatible or otherwise discontinued.
In addition to official CERN modules developed and maintained by the Web Team, the distribution also includes a collection of carefully curated community contributed modules, ensuring that the most common use-cases are accommodated out-of-the-box.
:::info
We differentiate between three types of modules:
1. CERN-official modules;
2. Community-contributed modules included in the CERN Drupal Distribution; and
3. Community-contributed modules installed by the website owner.
This section will cover **CERN-official modules only**.
If you require information about community-contributed, or custom, modules, click [here](/development/custom-modules)
:::
Included in the CERN Drupal Distribution are the following CERN-official modules:
......@@ -110,7 +105,6 @@ As of November 2022, centrally provided modules include:
- [drupal/jquery_ui_datepicker](https://www.drupal.org/project/jquery_ui_datepicker)
- [drupal/jquery_ui_draggable](https://www.drupal.org/project/jquery_ui_draggable)
- [drupal/jquery_ui_droppable](https://www.drupal.org/project/jquery_ui_droppable)
- [drupal/ludwig](https://www.drupal.org/project/ludwig)
- [drupal/mailsystem](https://www.drupal.org/project/mailsystem)
- [drupal/matomo](https://www.drupal.org/project/matomo)
- [drupal/memcache](https://www.drupal.org/project/memcache)
......
......@@ -2,7 +2,14 @@
slug: /themes/cern-override-theme
---
# CERN Override Theme
# [LEGACY] CERN Override Theme
:::warning Deprecated
As of 10th of April 2024, the Drupal service no longer supports the installation of community-contributed, or custom modules and themes for **new** websites. See [OTG0149420](https://cern.service-now.com/service-portal?id=outage&n=OTG0149420) for more details.
The existing documentation is kept solely to assist for websites existing before 10 April 2024.
:::
---
We strongly recommend only using the default `CERN Theme`.
Indeed, this theme includes functionality designed specifically to fit the needs of most CERN websites.
......
......@@ -2,7 +2,14 @@
slug: /development/custom-modules
---
# Install Custom Modules
# [LEGACY] Install Custom Modules
:::danger Deprecated
As of 10th of April 2024, the Drupal service no longer supports the installation of community-contributed, or custom modules and themes for **new** websites. See [OTG0149420](https://cern.service-now.com/service-portal?id=outage&n=OTG0149420) for more details.
The existing documentation is kept solely to assist for websites existing before 10 April 2024.
:::
---
In the event that the modules provided via the [CERN Drupal Distribution](https://gitlab.cern.ch/drupal/paas/cern-drupal-distribution/-/blob/v9.4-1/composer.json#L103)) are not sufficient for your needs, you may:
......@@ -47,7 +54,7 @@ Please see [this guide](https://drupal.docs.cern.ch/development/oc/) for how to
The following steps require an understanding of how git works. If you are wholly unfamiliar with git, Gitlab, and repositories, please either refer to [this guide](https://learn.microsoft.com/en-us/training/modules/intro-to-git/), or skip to the WebDAV section. If you have any questions about the below steps, please create a thread on the [CERN Drupal Community Forums](https://drupal-community.web.cern.ch/).
:::
:::danger
:::warning
It you lock the version(s) of the module(s) in your custom `composer.json`, it is **your responsibility** to ensure these are updated as necessary for both compatibility and security reasons. Additionally, if you choose to include specific versions of modules otherwise included in the CERN Drupal Distribution, it is your responsibility to ensure continued compatibility with other centralised modules. We strongly recommend not overriding what is included centrally and not locking modules to a specific minor version.
:::
......
......@@ -2,7 +2,14 @@
slug: /development/update-custom-modules
---
# Update Custom Modules
# [LEGACY] Update Custom Modules
:::danger Deprecated
As of 10th of April 2024, the Drupal service no longer supports the installation of community-contributed, or custom modules and themes for **new** websites. See [OTG0149420](https://cern.service-now.com/service-portal?id=outage&n=OTG0149420) for more details.
The existing documentation is kept solely to assist for websites existing before 10 April 2024.
:::
---
In the event that the modules provided via the [CERN Drupal Distribution](https://gitlab.cern.ch/drupal/paas/cern-drupal-distribution/-/blob/v9.4-1/composer.json#L103)) are not sufficient for your needs, you may:
......
......@@ -2,8 +2,14 @@
slug: /development/uninstall-custom-modules
---
# Uninstall Custom Modules
# [LEGACY] Uninstall Custom Modules
:::danger Deprecated
As of 10th of April 2024, the Drupal service no longer supports the installation of community-contributed, or custom modules and themes for **new** websites. See [OTG0149420](https://cern.service-now.com/service-portal?id=outage&n=OTG0149420) for more details.
The existing documentation is kept solely to assist for websites existing before 10 April 2024.
:::
---
In the event that the modules provided via the [CERN Drupal Distribution](https://gitlab.cern.ch/drupal/paas/cern-drupal-distribution/-/blob/v9.4-1/composer.json#L103)) are not sufficient for your needs, you may:
- post on the [CERN Drupal Community Forums](https://drupal-community.web.cern.ch/) to see whether others have already achieved what you are looking for;
......
......@@ -10,6 +10,15 @@ module.exports = {
organizationName: "Drupal",
projectName: "https://gitlab.cern.ch/drupal/paas/drupal-documentation",
themeConfig: {
announcementBar: {
id: 'customisation_block',
content:
'As of 10th of April of 2024, the Drupal service no longer supports installation of custom modules for new websites.\n' +
'The existing documentation regarding customisation is kept solely for existing instances.',
backgroundColor: '#f3a07a',
textColor: '#fff',
isCloseable: false,
},
navbar: {
title: "Drupal Documentation",
logo: {
......
......@@ -39,4 +39,11 @@
font-style: italic;
color: light-grey;
margin-top: -30px;
}
\ No newline at end of file
}
/* Announcement banner */
div[class^="announcementBarContent"], div[class*=' announcementBarContent'] {
font-size: 1rem;
font-weight: bold !important;
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment