Add more information to the Menu guide

未关闭
#83 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
php
领域
documentation

调研方向

审查 Menu 指南,包括 Admin 和 User 菜单屏幕,并追踪提到的 Menu 类 configure 方法,以及对 Pages/Controllers 和翻译搜索的引用。更新指南,以涵盖权限、相关页面、重命名和删除项目、翻译键的查找方式以及菜单的用途;完成标准是每个要求的主题都已记录,并且相关链接均已存在。

由索引模型根据 Issue 内容生成。

描述

Documentation
  • Mention how to check for permissions and that they need to check for permissions in Menu and for example in the Controller as well as it would be otherwise still possible to execute the controller via URL
  • Menus are often needed in combination with Pages therefore we should mention Pages (Controllers) and link to them
  • How to rename Menu items
  • How to delete Menu items (I think for both delete & rename there is a configure method in the Menu class otherwise we need to explain the events)
  • Explain that they need to find the translation key to rename/delete menu items and how they can find it (switch language to Development or under Admin => Translation search)
  • Update Admin and User menu screen
  • Explain at the beginning what Menus are good for (restrict items to certain users / user-groups etc, remove unneeded items etc) refs #80
主要语言
PHP
星标
58
派生
88
平均合并
2 天 13 小时
30 天内合并 PR
2

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

matomo-org/developer-documentation 的其他 Issue

查看 matomo-org/developer-documentation 的全部 Issue

相似的 Issue

更多 PHP Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。