README

TL;DR

启动时，请确保使用此存储库中提供的默认配置，以“minimal”安装配置文件引导您的站点

drush si minimal --existing-config

好吧，但请告诉我更多。

Drupal 10 版本

这是一个示例 Drupal 站点存储库。它包含所有基本内容，可帮助您开始使用基于 UN-OCHA Common Design 主题的新 Drupal 10 站点。

查看 https://humanitarian.atlassian.net/browse/OPS-7611

克隆后使用 composer create-project 安装，或 composer create-project unocha/starterkit

然后运行 scripts/setup.sh（请参阅下文 需要更改什么？）。

Drupal 9 版本位于 D9 分支。

需要更改什么？

需要更改几个文件以将 starterkit 替换为您的项目名称等。

您可以使用 scripts/setup.sh 脚本来自动完成此操作。

./scripts/setup.sh "site.prod.url" "Site Name" "project-name"

例如，对于 Common Design 网站

./scripts/setup.sh "web.brand.unocha.org" "Common Design" "common-design-site"

设置脚本还会将 github 动作复制到 develop、feature 和 main 分支，用于构建 Docker 镜像。

README

显然，这个 README 文件需要更新，以包含与您的项目相关的信息。

Github 工作流程

编辑以下文件，将 starterkit 替换为您的项目名称（例如：my-website）

• .github/workflows/docker-build-image.yml

Docker

编辑以下文件

• docker/Dockerfile --> 将 starterkit.prod 替换为您的 生产 网站URL。
• Makefile --> 将 starterkit 替换为您的项目名称（例如：my-website）。

Composer

使用您的项目名称、作者等信息编辑 composer.json 文件。

使用 composer require package 和 composer remove package 来添加/删除包（例如：drupal/group）。

• composer.json

测试

编辑以下文件，将 starterkit 替换为您的项目名称（例如：my-website）

• .travis.yml
• phpunit.xml
• tests/docker-compose.yml
• tests/settings/settings.test.php
• tests/test.sh

站点配置

编辑 Drupal 站点配置以设置站点名称（也可以通过 Drupal UI 完成）。

• config/system.site.yml

本地栈

请参阅下文 运行站点 部分。

• local/docker-compose.yml
• local/install.sh
• local/shared/settings/settings.local.php

推荐模块

以下是 UN-OCHA 网站中常用模块的列表。

组件

与 Common Design 主题一起使用。

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

社交认证人道主义 ID

用于通过 HID 登录

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

管理员拒绝

防止以用户 1 登录

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

ImageMagick

更快的内存高效的图像处理

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

Pathauto

更好的 URL

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

GMT 纸板

• https://github.com/UN-OCHA/gtm_barebones

用户过期

自动“阻止”不活跃用户

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

用户名枚举预防

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

段落

许多联合国人道主义事务协调办公室（OCHA）的网站使用paragraphs模块和相关模块来结构化网站内容。

• https://www.drupal.org/project/paragraphs
• https://www.drupal.org/project/layout_paragraphs

自2023年1月19日起默认启用。

布局段落为段落提供更好的编辑器用户体验。

使用这些表单显示设置为每个添加到网站的段落字段

• 预览视图模式：预览
• 最大嵌套深度：0
• 要求在布局内添加段落：FALSE（未选中）
• 字段为空时的占位符消息：[空字符串]

XML 站点地图

为了帮助搜索引擎索引您的网站，xmlsitemap可以帮助生成和提交您内容站点地图。

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

自2023年1月19日起默认启用，但没有配置站点地图。

注意：您可能需要编辑assets/robots.txt.append文件以指示您的站点地图的URL

# Sitemap
Sitemap: https://my-website-domain/sitemap.xml

组

group和相关模块有助于创建具有特定访问控制权限的内容和用户集合。

• https://www.drupal.org/project/group
• https://www.drupal.org/project/subgroup

主题切换器

theme_switcher模块有助于控制哪些页面使用哪些主题。

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

字段组

field_group模块有助于在表单中组织字段。

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

补丁

有关 Drupal 10 兼容性补丁等的说明，请参阅patches/notes.md。

运行站点

您应该创建一个合适的标准环境堆栈来运行您的网站。

但在此同时，local目录包含快速创建用于本地运行网站的容器所需的一切。

运行./local/install.sh -h以查看脚本选项。

更新此存储库

1. 在composer.json文件中更新依赖项等。
2. 通过运行./local/install.sh -m -i -c创建本地实例
3. 登录此新实例并启用/禁用/配置模块和网站
4. 导出配置（例如：docker exec -it starterkit-local-site drush cex）
5. 创建带有更改的拉取请求
6. 通过./local/install.sh -x -v停止并删除容器

注意：不要忘记设置您的本地代理以管理starterkit-local.test域名。