Currently, the API docs for the four Metrics Platform clients are combined onto a [[ https://wikitech.wikimedia.org/wiki/Metrics_Platform/Implementations | single page. ]] To avoid a really long page and to create a better experience for users who are only interested in one client at a time, I propose splitting the API docs into these pages:
- Metrics Platform/API (disambiguation)
- Metrics Platform/JavaScript API
- Metrics Platform/PHP API
- Metrics Platform/Java API
- Metrics Platform/Swift API
Alternatively, we could create the API pages at Metrics Platform/API/[Language]. However, wiki page titles are primarily used by humans, and I don't think the additional structure outweighs the less readable page titles.
## To do
- [x] Create:
- [x] Metrics Platform/API (disambiguation)
- [x] Metrics Platform/JavaScript API
- [x] Metrics Platform/PHP API
- [x] Metrics Platform/Java API
- [x] Metrics Platform/Swift API
- [x] Redirect Metrics Platform/Implementations
- [x] Update links in tasks with pending docs to-dos
- [x] Update Metrics Platform landing page
- [ ] Identify code references for supported interaction data fields
- [ ] JS
- https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/blob/main/js/src/EventData.d.ts#L101 ?
- https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/blob/main/js/src/EventData.d.ts#L128 ?
- [ ] PHP
- [ ] Java
- [ ] Swift
- [ ] Investigate using existing tests for code samples
- JS integrate test code: https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/blob/main/js/test/integration/index.js#L36-52
- [ ] Write reference docs
- [ ] JS
- [ ] PHP
- [ ] Java
- [ ] Swift
- [ ] Finalize code samples
- [ ] JS
- [ ] PHP
- [ ] Java
- [ ] Swift
- [ ] Adjust organization to include instrument name and experiment membership in JS docs