Skip to content

[Idea]: migrate web API documentation to use matomo and instrument for better understanding user navigation behavior #22

@kgryte

Description

@kgryte

Idea

Currently, the stdlib web-based API docs use GA for analytics and have only minimal integration. E.g., the API docs application is a SPA which uses React and the app does not record changes in page views; we only record first hits.

The goal of this idea is to migrate to using matomo and take advantage of its privacy features. The work will involve instrumenting the API documentation application and integrating with matomo. A potential stretch goal would be to setup dashboards for reporting so that we can better understand user behavior and continue to improve project documentation.

Expected Outcomes

All user interaction data is logged to matomo and stored in a hosted database.

Involved Software

No other software is necessary.

Prerequisite Knowledge

JavaScript, Node.js, HTML/CSS, JSX/React.

Difficulty

Intermediate.

Project Length

350 hours. Can be adjusted depending on skill and ability.

Potential Mentors

@kgryte @Planeshifter @steff456

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty: 3Likely to be challenging but manageable.ideaPotential GSoC project idea.priority: lowLow priority.tech: html/cssInvolves using HTML and CSS.tech: javascriptInvolves programming in JavaScript.tech: jsx/reactInvolves programming with React JSX.tech: nodejsRequires developing with Node.js.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions