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

Move analytics related documentation to the new site #20

Closed
1 of 4 tasks
Tracked by #39 ...
bmtcril opened this issue Oct 14, 2022 · 4 comments
Closed
1 of 4 tasks
Tracked by #39 ...

Move analytics related documentation to the new site #20

bmtcril opened this issue Oct 14, 2022 · 4 comments
Assignees
Labels
help wanted Ready to be picked up by anyone in the community

Comments

@bmtcril
Copy link

bmtcril commented Oct 14, 2022

A lot of good information on our event system exists in various places. Notably:

https://edx.readthedocs.io/projects/devdata/en/stable/internal_data_formats/tracking_logs.html
https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0026-arch-realtime-events.html
https://event-routing-backends.readthedocs.io/en/latest/

as well as several Confluence pages.

This task is to create a new space in docs.openedx.org for data and analytics documentation and begin moving old pages there, and creating pointers to existing docs from a centralized location.

Documentation should include things like:

  • Move existing documentation of events from the openedx space
  • How to capture tracking log data on disk and in Mongo
  • Pointers to Insights existing docs
  • How to use xAPI to collect and report events
@bmtcril bmtcril moved this from Backlog to Doing in Data Working Group Oct 26, 2022
@bmtcril bmtcril self-assigned this Oct 26, 2022
@bmtcril bmtcril changed the title Move event related documentation to the new site Move analytics related documentation to the new site Nov 1, 2022
@jmakowski1123
Copy link

part of event documentation milestone

@jmakowski1123 jmakowski1123 mentioned this issue Jan 9, 2023
5 tasks
@bmtcril bmtcril moved this from Doing to Ready for Work in Data Working Group Feb 9, 2023
@bmtcril bmtcril removed their assignment Feb 9, 2023
@bmtcril bmtcril added the help wanted Ready to be picked up by anyone in the community label Feb 9, 2023
@Ian2012
Copy link

Ian2012 commented Apr 18, 2023

Is there already a section for data and analytics in https://docs.openedx.org/en/latest/?

@bmtcril
Copy link
Author

bmtcril commented Apr 18, 2023

Most of this is developer documentation, so would end up under there. We can also document things in other repos and link them back to the main docs site as we did with openedx-oars, so in general if the documentation is specific to a repository it's best to create it there and then link back to it from the docs repo.

@saraburns1 saraburns1 self-assigned this Nov 12, 2024
@saraburns1 saraburns1 moved this from Backlog to Done in Data Working Group Nov 12, 2024
@saraburns1
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Ready to be picked up by anyone in the community
Projects
Development

No branches or pull requests

4 participants