Skip to content

docs: 'how to' view in-context metrics#1304

Merged
sarina merged 2 commits intomainfrom
saraburns1-patch-1
Oct 22, 2025
Merged

docs: 'how to' view in-context metrics#1304
sarina merged 2 commits intomainfrom
saraburns1-patch-1

Conversation

@saraburns1
Copy link
Contributor

@saraburns1 saraburns1 commented Oct 20, 2025

Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll also need to add this page to a toctree, https://github.com/openedx/docs.openedx.org/blob/main/source/educators/navigation/data_analytics.rst, probably under Learner Data?

Instance Operators wanting to learn more about how to set up
In-Context Analytics for their instance should see :ref:`openedx-aspects:production_configuration`.

1. After enabling, users will see a new Analytics button at the top of the page on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Please use #. so it's more robust to changes

1. After enabling, users will see a new Analytics button at the top of the page on
Course Outline and Unit pages.

.. image:: /_images/release_notes/teak/in-context-analyticsbutton.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. image:: /_images/release_notes/teak/in-context-problemcomponent.png
:alt: A screenshot of the unit level analytics sidebar, showing the percentage of correct attempts and correct first attempts for a text input component

Note
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


For more detailed information about each of the charts and tables provided
out-of-the-box, please visit
:ref:`openedx-aspects:In-Context Dashboards`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a "See Also" section with related links, as well as a review chart (see any other how-to page)

@sarina
Copy link
Contributor

sarina commented Oct 20, 2025

Build errors:

/home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/1304/source/educators/how-tos/data/view_in_context_metrics.rst:65: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

  | /home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/1304/source/educators/how-tos/data/view_in_context_metrics.rst:67: WARNING: Literal block expected; none found. [docutils]
  | /home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/1304/source/educators/how-tos/data/view_in_context_metrics.rst:78: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
  | looking for now-outdated files... /home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/1304/source/educators/how-tos/data/view_in_context_metrics.rst:80: WARNING: Literal block expected; none found. [docutils]

@saraburns1 saraburns1 requested a review from sarina October 21, 2025 17:40
@sarina sarina merged commit da2b324 into main Oct 22, 2025
2 checks passed
@sarina sarina deleted the saraburns1-patch-1 branch October 22, 2025 13:42
ayub02 pushed a commit to ayub02/docs.openedx.org that referenced this pull request Dec 11, 2025
* docs: 'how to' view in-context metrics

* docs: add Ulmo to release review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Required: Drill into Video and Problem Analytics from Unit Sidebar and Navigate Back

2 participants