django cms 3.5.x Documentation

### Django CMS 3.5.x 文档总结 #### 1. 代码格式与工具 - **代码格式**：统一使用四个空格代替制表符。 - **前端工具**：引入 `gulp.js` 用于代码检查、压缩和打包。 - **Sass 改变**：使用 `LibSass` 替代 `Compass`，并采用 `CSSComb` 以统一代码风格。 - **代码风格文件**：新增 `.editorconfig` 文件，提供统一的代码风格配置。 #### 2. 文档改进 - **拼写检查**：文档新增拼写检查功能，可通过 `make spelling` 命令进行检查，Travis CI 也支持该功能。 - **文档结构**：文档分为教程、指南、参考和社区发展等主要部分，内容涵盖从入门到高级开发的知识。 - **文档编写规范**：使用 Sphinx 和 reStructuredText 格式编写，要求字符限制在 100 以内，使用 British English，并附带技术参考资料。 #### 3. 用户界面改进 - **结构板优化**：结构板改为树状显示，用户可选择启用旧版本（`CMS_TOOLBAR_SIMPLE_STRUCTURE_MODE` 设置）。 - **侧边栏更新**：侧边栏被替换为更简洁的叠加层，API 文档中仍使用“侧边栏”术语。 #### 4. 开发流程与贡献 - **Pull Request 流程**：提交代码前需运行 `make spelling` 和 `make html` 检查拼写和文档。 - **文档贡献**：文档贡献被视为重要工作，鼓励非技术人员参与，使用简单易懂的英语编写。 - **讨论与提案**：新功能和重大变更需在 `django CMS developers` 邮件列表中讨论，避免闭门造车。 #### 5. 版本与兼容性 - **LTS 版本**：3.4 版本为首个 LTS 版本，支持 24 个月，仅提供安全更新和关键修复。 - **兼容性表格**：详细列出 Django 和 Python 的兼容版本，确保用户了解支持范围。 #### 6. 升级指南 - **升级步骤**：从 3.4 升级到 3.5 需运行 `migrate` 和 `cms fix-tree`，并检查自定义代码。 - **新项目创建**：支持通过 Divio Cloud 和 django CMS Installer 创建新项目。 #### 7. 其他 - **发布说明**：提供详细的版本更新日志，帮助用户了解各版本的变更和注意事项。 - **分支管理**：从 `master` 分支改为使用 `release` 分支，便于维护和版本管理。 #### 8. 总结 Django CMS 3.5.x 版本在代码格式、工具链、文档质量和用户体验方面均有显著改进，旨在提升开发效率和用户体验。开发者需注意兼容性问题、更新流程和文档规范，以确保项目顺利进行。