跳转到主要内容

Plone的项目评审

项目描述

https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336:target:https://pycqa.github.io/isort/

vdz.plone.projectreview

Plone插件由德国波鸿的visaplan GmbH开发,为德国杜塞尔多夫的VDZ Technology gGmbH评估项目。

示例

此插件目前正在开发中,尚未在公共互联网网站上使用。

文档

抱歉,我们还没有真正的用户文档。

安装

以下说明假设您有权访问服务器,该服务器将运行您的Plone实例并使用shell技能进行管理。

安装Plone

vdz.plone.projectreview软件包是开源内容管理系统Plone的插件,而Plone本身基于Web应用程序服务器Zope

目前,vdz.plone.projectreview仍然需要Plone 4.3;参见问题1,“Plone 5支持”

如果您还没有合适的Plone安装,您可以使用统一安装程序。安装最近的4.3版本。

在撰写本文时,通过统一安装程序提供的最新版本是4.3.19,但4.3.20已经软发布,可用于生产使用。

我们需要对您的buildout脚本进行一些小改动,通常命名为buildout.cfg;因此,不要立即运行buildout(除非您想重复执行)。

请注意

由于它包含损坏的 main_template.pt,普莱恩 4.3.19 很可能无法使用。因此,如果您在尝试访问网络界面 (或仅获取最新版本) 时遇到一个关于编译错误的丑陋的错误文本,请升级到普莱恩 4.3.20(预计将是最后一个 4.3 版本),例如通过替换:

[buildout]
...
extends =
    ...
    versions.cfg

[buildout]
...
extends =
    ...
    https://dist.plone.org/release/4.3.20/versions.cfg

如果您已经运行了普莱恩 4.3.19,您可能已经使用了替代的 main_template.pt(我们也将这样做,使用 plonetheme.bootstrap),并且可以继续这样做。

当然,您被鼓励进行更新,但对于 vdz.plone.projectreview 来说,没有技术要求必须这样做。

使用现有的普莱恩 4 安装

如果您有一个现有的普莱恩 4 安装,您可能能够使用它。有一些事情需要考虑

  • 由于我们使用 plonetheme.bootstrap,全局 main_template 被覆盖。如果您依赖于另一个 main_template,这可能无法使用。

  • 我们使用 Bootstrap 3 样式。

  • 我们使用 jQuery 1.11(或更高版本)。如果您有与旧版本不兼容的自定义 JavaScript(例如使用已从 jQuery 1.9+ 中删除的旧 .live.die API),则需要安装兼容层或 更新您的脚本

规则是

  • 如果您对 vdz.plone.projectreview 所需的产品激活和包版本满意,您可以使用现有的普莱恩实例。

  • 如果我们的产品激活不符合您的需求,但包版本可以(例如,您可以使用 plone.app.jquery 为 v1.11.2 和 4.3.* 的 Products.CMFPlone 版本),您应该能够使用现有的 Zope 安装,并在其中创建一个具有您选择的新 ID 的新普莱恩站点。

请在专门的测试环境中测试 您的当前站点与 vdz.plone.projectreview 的共存性!

添加 vdz.plone.projectreview

首先,vdz.plone.projectreview 包必须添加到 eggs 值中;统一安装程序将其放在 [buildout] 部分

[buildout]

...

eggs =
    Plone
    vdz.plone.projectreview

由于我们使用关系数据库,您还需要数据库驱动程序。我们的包本身拉取 SQLAlchemy(通过 zope.sqlalchemy),但您需要为您的数据库特定的驱动程序。对于 PostgreSQL,这可能 psycopg2

eggs =
    ...
    vdz.plone.projectreview
    psycopg2

版本锁定

由于我们使用 Bootstrap 3,我们需要 jQuery 1.11+。由于历史原因,普莱恩 4.3 默认仍使用 jQuery 1.7。

您的 buildout.cfg 脚本 extends 其他脚本,其中包含版本锁定。在 buildout.cfg 中找到或创建 [versions] 部分,并覆盖 1.7.* 值

[versions]
...
plone.app.jquery_ = 1.11.2

产品配置

在 buildout 中执行了两个配置设置

  1. 数据库的 数据源名称,指定关系数据库;

  2. 文件附件的目录路径。

对于这些,我们将为您 Zope 实例的部分创建额外的 zope.conf 文件。

您可能希望将这些设置放在一个专门的 settings.cfg 文件中,并将其添加到 extends 列表中。统一安装程序使用 [buildout] 部分

[buildout]
zope-conf-additional =
    <product-config projectreview>
    data-dir ${buildout:directory}/var/myattachmentsdir
    </product-config>
    <product-config reldb>
    dsn      postgresql+psycopg2://127.0.0.1/mydb
    </product-config>

在这种情况下,您需要确保此值用于您的实例部分,例如在 base.cfg

[instance_base]
...
zope-conf-additional = ${buildout:zope-conf-additional}

构建和启动

在所有组件到位后,运行 bin/buildout

如果您没有指定自己的管理密码,请确保在 buildout 中有它,或者将其记录下来;您将需要它来登录到您的新 Zope 实例并创建“真正的”用户。

启动实例(取决于您的安装类型),例如:

bin/instance fg

数据库初始化

(待办事项;需要脚本)

产品安装

在您的实例的 prefs_install_products_form 视图中,我们将激活以下扩展(如果尚未完成)

  • vdz.plone.projectreview

  • Bootstrap 主题

  • jQuery DataTables

  • jQuery UI

我们将禁用

  • 经典 Plone 设计

更新到 Plone 5

最后,关于 Plone 5 的几点说明。

大部分组件已经为 Plone-5 和 Python-3 准备就绪,所以可能很快会有更新。

但是,所有 项目数据 都存储在关系型数据库中,因此应该可以在全新的安装中使用,而无需进行任何必要的数据迁移,只需使用相同的数据源名称 data source name

唯一需要迁移的(在标准情况下)是用户和组信息;这超出了本文件的范畴。在大多数情况下,涉及的用户账户和组很少,可以很容易地手动完成。

依赖项

  • Products.CMFPlone:

    这是我们使用的“Plone”。

    • 目前我们要求 4.3 版本。

    • 版本 4.3.19 在包含的 main_template.pt 皮肤层模板方面存在 问题;因此,纯 Plone 4.3.19(例如,用于全新安装)可能无法正常工作。由于此模板经常被覆盖,这不是一个硬性要求;在出现问题时,请按照上述说明升级到 4.3.20 版本。

  • Python 2.7

    因为 Plone 4.3 需要 Python 2.7,所以我们(目前)也是如此。我们的 Python 代码应该已经支持 Python 3,使用 six 库。

使用的软件

通用
更具体,或为此项目开发

包含的软件

此包包含以下 JavaScript 库,我们没有找到现成的 Plone 集成来使用

贡献

支持

如果您遇到问题,请告诉我们;请使用上述提到的 问题跟踪器

许可证

  • 本项目许可协议为 GPLv2。

  • 以下组件的许可协议为 MIT 协议

贡献者

变更日志

1.0.0(未发布)

  • 初始发布。[tobiasherp]

由以下组织支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面