matomo-org / matomo-org/developer-documentation

Hide @deprecated events from the Events reference page?

Open
#47 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently deprecated events such as the [Menu events](http://developer.piwik.org/api-reference/events#menuadminadditems) or Widgets, [Tasks](http://developer.piwik.org/api-reference/events#taskschedulergetscheduledtasks) are displayed in the documentation.

Maybe these events could be removed from documentation? I guess I like the idea of having a smaller list of events, slowly removing some that are useless (Convention over Configuration ftw) and refactoring code to need less events.

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

Start with the Events reference page and the linked Menu and Tasks entries. Determine which listed events are deprecated and whether the intended result is to remove them from the documentation; the issue does not name source files, tests, or a documentation preview process.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.