Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kgryte opened this issue Jan 12, 2023 · 0 comments
Labels
difficulty: 3 Likely to be challenging but manageable. idea Potential GSoC project idea. priority: normal Normal priority. tech: html/css Involves using HTML and CSS. tech: javascript Involves programming in JavaScript. tech: jsx/react Involves programming with React JSX. tech: nodejs Requires developing with Node.js.

Comments

@kgryte
Copy link
Member

kgryte commented Jan 12, 2023

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

@kgryte kgryte added idea Potential GSoC project idea. priority: normal Normal priority. difficulty: 3 Likely to be challenging but manageable. tech: javascript Involves programming in JavaScript. tech: nodejs Requires developing with Node.js. tech: html/css Involves using HTML and CSS. tech: jsx/react Involves programming with React JSX. labels Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: 3 Likely to be challenging but manageable. idea Potential GSoC project idea. priority: normal Normal priority. tech: html/css Involves using HTML and CSS. tech: javascript Involves programming in JavaScript. tech: jsx/react Involves programming with React JSX. tech: nodejs Requires developing with Node.js.
Projects
None yet
Development

No branches or pull requests

1 participant