matomo-org / matomo-org/developer-documentation

Add more information to the Menu guide

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
PHP
Stars
58
Forks
88
Avg merge
6d 3h
Merged PRs (30d)
13

Description

- 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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Menu guide, including the Admin and User menu screens, and trace the mentioned Menu class configure method plus the Pages/Controllers and translation-search references. Update the guide to cover permissions, related pages, renaming and deleting items, translation-key discovery, and the purpose of menus; done means each requested topic is documented and the relevant links are present.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.