Proposal
Currently, the API docs for the four Metrics Platform clients are combined onto a 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
- Create:
- Metrics Platform/API (disambiguation)
- Metrics Platform/JavaScript API
- Metrics Platform/PHP API
- Metrics Platform/Java API
- Metrics Platform/Swift API
- Redirect Metrics Platform/Implementations
- Update links in tasks with pending docs to-dos
- Update Metrics Platform landing page
- Identify code references for supported interaction data fields
- JS
- PHP
- Java
- Investigate using existing tests for code samples
- JS integration test code: https://gitlab.wikimedia.org/repos/data-engineering/metrics-platform/-/blob/main/js/test/integration/index.js#L36-52
- PHP
- Write reference docs
- JS
- PHP
- Java
Swift