diff --git a/docs/.gitignore b/.gitignore similarity index 80% rename from docs/.gitignore rename to .gitignore index bcf1e57c09acfc51d3faaaadd90270dd6eb72167..0c6024b33e5ce92dfe148ac5dce6272b014b7c6e 100644 --- a/docs/.gitignore +++ b/.gitignore @@ -1,8 +1,8 @@ # 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 diff --git a/docs/docs/2-CERN Modules/1-introduction.md b/docs/docs/2-CERN Modules/1-introduction.md index e087f38d209879e7b419591dee5b0e0eb0e8d08e..7a1f3aa0c3d223147862818720cb1261e02f38f7 100644 --- a/docs/docs/2-CERN Modules/1-introduction.md +++ b/docs/docs/2-CERN Modules/1-introduction.md @@ -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) diff --git a/docs/docs/3-CERN Themes/5-cern-override.md b/docs/docs/3-CERN Themes/5-cern-override.md index 60c4e797a0c32bf063b6b42f97d6a78dd207554c..4fa3f8d32c4ff6c8aba069dd24297c7ac119d016 100644 --- a/docs/docs/3-CERN Themes/5-cern-override.md +++ b/docs/docs/3-CERN Themes/5-cern-override.md @@ -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. diff --git a/docs/docs/5-Development/6-0-custom-modules.md b/docs/docs/5-Development/6-0-custom-modules.md index 8c8776d8b9bef91996f25082ee91750c886e91f2..d33d9ebe064939548599667ccaf49bd7aec92dd8 100644 --- a/docs/docs/5-Development/6-0-custom-modules.md +++ b/docs/docs/5-Development/6-0-custom-modules.md @@ -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. ::: diff --git a/docs/docs/5-Development/6-1-update-custom-modules.md b/docs/docs/5-Development/6-1-update-custom-modules.md index 9bb856957f4461794a3d8fc9bd9040a687183b7f..40de4c531155cbcd0bca6c9152217b0547fd322d 100644 --- a/docs/docs/5-Development/6-1-update-custom-modules.md +++ b/docs/docs/5-Development/6-1-update-custom-modules.md @@ -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: diff --git a/docs/docs/5-Development/6-2-uninstall-custom-modules.md b/docs/docs/5-Development/6-2-uninstall-custom-modules.md index 65d31d9b10abec5008b286779d873c1b14fc9ee5..c5a5199a607f5935e8975f1fa5a425397fe55bbd 100644 --- a/docs/docs/5-Development/6-2-uninstall-custom-modules.md +++ b/docs/docs/5-Development/6-2-uninstall-custom-modules.md @@ -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; diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index fd8ae6c17e78fd4d5359503040db72dea803f189..df07045b5b820164a274c2db4ba9aceb7c5d1594 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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: { diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 1194ca2219bf5460c005b417418d0a16a8cd88b2..d6a1da4c1753f6708a8ce614aad9aca0e0e6c6d4 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -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; +}