Documentation around Segmentation

Aperta
#630 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
php
Ambito
documentation

Direzione di ricerca

Inizia con la guida esistente dimensions#segmentation e la pagina guides/segments per determinare dove collocare questo materiale. Documenta Dimension::configureSegments, i metodi di Piwik\Plugin\Segment elencati e gli hook Segment.addSegments e Segment.filterSegment. Il lavoro è completo quando la documentazione spiega questi punti di estensione e come supportano segmenti complessi o definiti esternamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Documentation

Our documentation currently leaks some details around Segmentation. There is only https://developer.matomo.org/guides/dimensions#segmentation, which mentions how new segments can be defined for a dimension.

We should add at least some documentation around Dimension::configureSegments and the special methods of Piwik\Plugin\Segment that can be used to define more complex segments. Like setSqlFilter, setSqlFilterValue or setUnionOfSegments.

In addition we should also mention that segments can be manipulated outside of dimensions by using the hooks of Piwik\Segment\SegmentsList: Segment.addSegments and Segment.filterSegment

Not sure where to add that, maybe https://developer.matomo.org/guides/segments would be the correct place. We could add a new section like How to provide new Segments or similar.

follow-up to https://github.com/matomo-org/matomo/pull/18953

Lingua principale
PHP
Stelle
58
Fork
88
Merge medio
2g 10h
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di matomo-org/developer-documentation

Tutte le issue di matomo-org/developer-documentation

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.