evpp/evpp_utdk3_customizations

UT Drupal Kit站点系列中执行副总裁和教务长办公室的定制

安装: 226

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

类型:drupal-custom-module

1.0.1 2021-06-11 13:01 UTC

This package is auto-updated.

Last update: 2024-09-06 01:06:49 UTC


README

此Composer包为基于UT Drupal Kit版本3的EVPP站点提供一组通用的配置和定制功能。

内容

设置

  1. 通过以下命令将此软件包添加到任何UT Drupal Kit 3站点:
composer require evpp/evpp_utdk3_customizations

此软件包将安装到web/modules/custom/目录,但不应该提交到单个站点的版本控制中(默认的.gitignore应该忽略它)。

  1. 在站点安装后,启用evpp_utdk3_customizations模块。

当前功能

随着时间的推移,此软件包的功能将不断扩大。本节列出了其当前功能。

  1. 企业登录集成(还要求向ITS提出请求)。

添加新功能

基本模块evpp_utdk3_customizations本身不提供功能。每个额外的功能特性应作为子模块添加,并在新站点和现有站点上安装。以下是一个示例。

示例:添加新的内容类型,“数据可视化”

  1. 启动一个使用此包的本地EVPP站点实例。
  2. 用来自企业Github的“源”版本的此包替换基于github.com的“dist”版本(例如,删除目录,然后git clone git@github.austin.utexas.edu:evpp-web/evpp_utdk3_customizations.git
  3. 为新的功能创建一个新的Git分支。
  4. 在代码库中,在此存储库的modules目录中添加一个新的子模块,命名为evpp_content_type_data_visualization,并带有标准的.info.yml文件,没有其他内容。
  5. 启用裸模块(drush en evpp_content_type_data_visualization),以便在Drupal系统中注册。
  6. 使用Drupal UI创建内容类型及其字段。字段机名应以前缀evpp开头,以防止命名冲突。例如,可视化元数据字段可以机命名为field_evpp_viz_metadata
  7. 如果尚未启用,启用features_ui,转到/admin/config/development/features,然后单击“创建新功能”。
  8. 将功能命名为“内容类型:数据可视化”,机器名为evpp_content_type_data_visualization
  9. 选择捆绑包“EVPP Customizations”
  10. 设置配置写入的路径为modules/custom/evpp_utdk3_customizations/evpp_content_type_data_visualization
  11. 从右侧的选择面板中选择您创建的节点类型。您可能还需要显式选择与内容类型相关的“字段存储”配置。
  12. 通过按“写入”导出配置(验证它位于新子模块的config/install目录中)。
  13. 通过向模块本身添加任何所需的模板、库和资产来构建内容类型。
  14. evpp_utdk3_customizations.install中,添加逻辑以在新的和现有的站点上自动启用新模块(即在hook_install()实现中启用它,并在新的hook_update()函数中启用它)。
  15. 通过拉取站点的实时数据库(实际上擦除了您在本地阶段的变化)并运行drush updb来测试工作流程。这应该启用新子模块,它将安装新内容类型。
  16. 将更改提交到分支,并使用所需的内部审查流程(例如,拉取请求)将其推送到企业Github。
  17. 一旦合并到Enterprise Github上的默认分支,创建一个新的标签(例如,1.1.0),并将其推送到https://github.com/ut-evpp/evpp_utdk3_customizations 。这应会自动更新Packagist上的信息。

部署站点更新

  1. 对于所有使用此仓库的网站,您现在可以通过Composer接收待更新的版本。假设网站托管在Pantheon上,请转到每个网站的仪表板并点击“检查更新”。这应该会检测到evpp/evpp_utdk3_customizations的新版本,您可以通过仪表板应用该版本并将更新部署到生产环境(更新钩子负责部署实际功能)。