Page MenuHomePhabricator

Swift Metrics Platform Documentation
Closed, ResolvedPublic

Description

User Story:

As a front-end engineer at WMF, I want to have access to clear, concise tutorials and how-to guides on the use of the Swift client library, so that I can quickly get up to speed and start using it in my projects.

Acceptance Criteria:
  • The tutorial should cover the basics of using the Swift client library, including the installation process and any necessary configuration steps.
  • The tutorial should provide clear, step-by-step instructions on how to start using the library to track metrics and gather data.
  • The tutorial should be written in a clear, concise, and easy-to-understand manner, with code samples and screenshots to help illustrate the process.
  • The tutorial should be accessible to iOS engineers at the foundation.
  • The how-to guide should provide a quick reference to the key steps involved in using the Swift client library, and should be written in a concise and easy-to-understand manner.

Event Timeline

DMartin-WMF changed the task status from Open to In Progress.Aug 17 2023, 9:41 PM

We have a "mono-howto" at Metrics_Platform/Creating_An_Instrument, which will cover all 4 of the supported languages (but Swift is not currently covered).

Given the overall simplicity of use of Metrics Platform, this combined document works well and still manages to be readable and not too long. It references other MP documentation pages as needed, especially regarding installation and more advanced info about differences in how the languages are supported. In my opinion, given the simplicity of MP use, this "mono-howto" serves well as both tutorial and how-to guide.

We still need to insert Swift-specific content.

Note: Metrics_Platform/Creating_An_Instrument was somewhat modeled after Event_Platform/Instrumentation_How_To.

I'm unassigning myself because I reached a good stopping point and I think the readability and usability of the current wikitech pages is acceptable for the initial "monoschema" version of Metrics Platform. Other folks will be updating the documentation for the subsequent "multischema" versions; I'm not so well-qualified to do that.

phuedx claimed this task.
phuedx subscribed.

Per the above. Data Products are planning on working on the documentation in the not-too-distant future but that will be tracked in other tasks.