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

docs: Remove references to the Insights product #489

Merged
merged 3 commits into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions source/developers/references/developer_guide/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,6 @@

.. _Coming Soon Programs Page: https://open.edx.org/announcements/coming-soon-xseries-programs-page

.. _Using edX Insights: http://edx.readthedocs.io/projects/edx-insights/en/latest/

.. _Review Answers to Graded Problems: http://edx.readthedocs.io/projects/edx-insights/en/latest/performance/Performance_Answers.html#review-answers-to-graded-problems

.. _Review Answers to Ungraded Problems: http://edx.readthedocs.io/projects/edx-insights/en/latest/performance/Performance_Ungraded.html#review-answers-to-ungraded-problems

.. _Open edX Analytics wiki: https://openedx.atlassian.net/wiki/spaces/COMM/pages/979927117/Open+edX+Analytics

.. _openedx-analytics: http://groups.google.com/forum/#!forum/openedx-analytics

.. _Entity Relationship Diagram for ORA Data: https://openedx.atlassian.net/wiki/display/AN/Entity+Relationship+Diagram+for+ORA+Data

.. _edX Enrollment API: http://edx.readthedocs.io/projects/edx-platform-api/en/latest/enrollment/index.html
Expand Down Expand Up @@ -96,8 +86,6 @@

.. _edx-documentation/shared: https://github.com/openedx/edx-documentation/blob/master/shared/conf.py

.. _edx-analytics-configuration: https://github.com/openedx/edx-analytics-configuration

.. _edx-documentation: https://github.com/openedx/edx-documentation

.. _edx-tools wiki: https://github.com/openedx/edx-tools/wiki
Expand Down Expand Up @@ -162,8 +150,6 @@

.. _Developing on Devstack: https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Devstack

.. _Getting Started on Analytics: https://github.com/openedx/devstack/blob/master/docs/analytics.rst

.. _forum migration described on the Open edX wiki: https://openedx.atlassian.net/wiki/display/TNL/Migrating+the+Discussion+Forums+to+Support+Teams+Discussion+Filtering

.. _Google Drive XBlock: https://github.com/openedx/xblock-google-drive
Expand All @@ -174,8 +160,6 @@

.. _S3.py: https://github.com/openedx/edx-ora2/blob/a4ce7bb00190d7baff60fc90fb613229565ca7ef/openassessment/fileupload/backends/s3.py

.. _edX Analytics Installation: https://openedx.atlassian.net/wiki/display/OpenOPS/edX+Analytics+Installation

.. _ux.edx.org: http://ux.edx.org/

.. _ui-toolkit.edx.org: http://ui-toolkit.edx.org/
Expand Down Expand Up @@ -438,8 +422,6 @@
.. _GitHub Flow: https://github.com/blog/1557-github-flow-in-the-browser
.. _RST: http://docutils.sourceforge.net/rst.html

.. _edX Insights: https://insights.edx.org

.. _edX Status: http://status.edx.org/

.. _docs.edx.org: http://docs.edx.org
Expand Down
4 changes: 2 additions & 2 deletions source/developers/references/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Glossary
This text is referred to as the accessible label because screen readers read
all of the text that you supply for the problem and then repeat the text that
is identified with this formatting immediately before reading the answer
choices for the problem. This text is also used by reports and Insights to
identify each problem.
choices for the problem. This text is also used by reporting and analytics
systems to identify each problem.

All problems require accessible labels.

Expand Down
2 changes: 1 addition & 1 deletion source/educators/how-tos/reusable_content/add_video.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
.. note::
:class: dropdown

This name appears as a heading above the video in the LMS, and it identifies the video for you in Insights. If you do not enter a display name, the platform specifies “video” for you.
This name appears as a heading above the video in the LMS, and it identifies the video for you in reports and analytics. If you do not enter a display name, the platform specifies “video” for you.

#. Paste the video URL in the default Video URL field, and then enter the location of your video. This is the URL that was created when you uploaded the video to the hosting site.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -432,21 +432,6 @@ tools available in Studio. For more information, see
sections in an image that can be enlarged.
- Not supported

******************************************
Analyzing Learner Performance on Problems
******************************************

For the following problem types in your course, you can use edX Insights to
review aggregated learner performance data and examine the submitted answers.
For more information, see `Using edX Insights`_ .

* :ref:`Dropdown`
* :ref:`Math Expression Input`
* :ref:`Multi-select`
* :ref:`Numerical Input`
* :ref:`Single Select`
* :ref:`Text Input`

.. _Mobile-Ready Problem Types:

*********************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,6 @@ problem follows.
</formularesponse>
</problem>

========================================================
Analyzing Performance on Math Expression Input Problems
========================================================

For the math expression input problems in your course, you can use edX Insights
to review aggregated learner performance data and examine submitted answers.
For more information, see `Using edX Insights`_.

***************************************
Adding a Math Expression Input Problem
***************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,6 @@ your course starts follow.
working. See :ref:`Working with Video Components`.
* Check all assignments for completeness and verify their due dates. See
:ref:`Working with Problem Components`.
* Use edX Insights to review the answers that beta testers submitted for
problems, and to proofread your display names, accessible labels, and answer
text.
* Review feedback from the course team and beta testers to be sure that the
content has been thoroughly reviewed and tested.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -525,11 +525,6 @@ interpret this message, note that:
recipients you selected who were enrolled in the course (and had activated
their user accounts) when you sent the email message.

Note that the **Total number of enrollees** shown in enrollment data in
Insights includes all currently enrolled learners, regardless of account
activation status, and as a result can be different than this "out of"
number.

If the "recipients" and "out of" numbers are the same, the message reads
"Message successfully emailed for 13457 recipients" instead.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,4 @@ To view this course data, follow these steps.
more information, see :ref:`Set the Grade Range`.

Additional data about the course and its learners is available from other pages
in the instructor dashboard, and from Insights.

To access the data visualizations, metrics, and reports that are available in
Insights from the instructor dashboard, select the link in the banner at the
top of each page. For more information, see `Using edX Insights`_.

in the instructor dashboard.
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,13 @@ learners.
:local:
:depth: 1

.. Feature availability on the instructor dash applies to open edX installations only.
.. DOC-2218 A. Hodges 24 Aug 2015

.. only:: Open_edX

Data about course enrollment is available in the LMS, by selecting
**Instructor** to access the instructor dashboard and from Insights. For more
**Instructor** to access the instructor dashboard. For more
information, see :ref:`Report Learners Not Yet Enrolled`.

.. Feature has been turned off for edx.org and Edge (the data is available in Insights instead).
.. DOC-2218 A. Hodges 24 Aug 2015

.. only:: Partners

Data about course enrollment is available from edX Insights. You can access
Insights for your course from the LMS: after you select **Instructor** to
access the instructor dashboard, follow the link in the banner at the top of
each page. For more information, see `Using edX Insights`_.

.. _view_enrollment_count:

Expand All @@ -50,8 +39,8 @@ enrolled in it. Note the following information about how this count is
computed.

* In addition to learners, the enrollment count includes all course team
members, including Admins and Staff. (To work with a course in Studio, the
LMS, or Insights, you must be enrolled in that course.)
members, including Admins and Staff. (To work with a course in Studio or the
LMS you must be enrolled in that course.)

* The enrollment count displays the number of currently enrolled learners and
course team members. It is not a historical count of everyone who has ever
Expand Down Expand Up @@ -96,7 +85,7 @@ Course creators, Admins, and Staff, however, can enroll learners in a course
either before or after the learners register their user accounts.

.. important:: Course team members are not automatically enrolled in courses,
although they can access content in Studio, the LMS, and Insights. To work
although they can access content in Studio, and the LMS. To work
on a course, every course team member must register, activate a user
account, and enroll in the course.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ download an answer distribution report for course problems.
:local:
:depth: 1

Learner answer distribution data, including both charts and reports, is also
available from edX Insights. For more information, see `Using edX Insights`_.

.. _Student_Answer_Submission:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,6 @@ any time after you create the course.
:local:
:depth: 2

To supplement the learner data that is available from the instructor dashboard
in the LMS, you can use the charts and reports that are available from edX
Insights. With Insights, you can review demographic and geographic
distributions for enrolled learners. You can also monitor learner activity and
review the number of learners who, each week, interacted with your course. For
more information, see `Using edX Insights`_.

.. _PII:

***************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Other edX Resources
####################

.. Doc team! Be sure that when you make any changes to this file that you also make them to the mirrored files in these other locations.
.. edx-analytics-dashboard/docs/en_us/dashboard/source/front_matter
.. edx-platform/docs/en_us/shared
.. Alison 19 Aug 14

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ Documentation for course teams is available from the docs.edx.org web page.
You can access this guide by selecting **Help** in Studio or from the
instructor dashboard in the LMS.

* `Using edX Insights`_ describes the metrics, visualizations, and downloadable
.csv files that course teams can use to gain information about student
background and activity.

These guides open in your web browser. The left side of each page includes a
**Search docs** field and links to the contents of that guide. To open or save
a PDF version, select **v: latest** at the lower right of the page, then select
Expand All @@ -81,7 +77,7 @@ Email
To receive and share information by email, course team members can:

* Subscribe to announcements and other new topics in the edX Partner
Portal or the Open edX Portal. For information about how to subscribe, see
Portal or the Open edX Portal. For information about how to subscribe, see
the :doc:`Release Announcements through the Open edX Portal <edx_site>`

* Join the `openedx-studio`_ Google group to ask questions and participate in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ and localizing the code for the edX platform.
Documentation
=============

Documentation for developers is available from the `edX Developer Documentation`_
landing page.
Documentation for developers is available from the
`Open edX Developer Documentation`_ landing page.

======
GitHub
Expand All @@ -22,8 +22,6 @@ These are the main edX repositories on GitHub.

* The `edx/edx-platform`_ repo contains the code for the edX platform.

* The `edx/edx-analytics-dashboard`_ repo contains the code for edX Insights.

* The `edx/configuration`_ repo contains scripts to set up and operate the edX
platform.

Expand Down Expand Up @@ -51,4 +49,4 @@ provides insights into the plans, projects, and questions that the edX Open
Source team is working on with the community.

The `edx-tools`_ wiki lists publicly shared tools for working with the edX
platform, including scripts and helper utilities.
platform, including scripts and helper utilities.
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,3 @@ then select **PDF**.
.. note:: If you use the Safari browser, be aware that it does not support the
search feature for the HTML versions of the edX guides. This is a known
limitation.

==============================
Discussion Forums and Email
==============================

Researchers, edX data czars, and members of the global edX data and analytics
community can post and discuss questions in our public research forum: the
`openedx-analytics`_ Google group.

The edX partner portal also offers community `forums`_, including a Research
and Analytics topic, for discussions among edX partners.

.. important:: Please do not post sensitive data to public forums.

Data czars who have questions that involve sensitive data, or that are
institution specific, can send them by email to [email protected]
with a copy to your edX partner manager.

======
Wikis
======

The edX Analytics team maintains the `Open edX Analytics`_ wiki, which includes
links to periodic release notes and other resources for researchers.

The `edx-tools`_ wiki lists publicly shared tools for working with the edX
platform, including scripts for data analysis and reporting.
2 changes: 1 addition & 1 deletion source/educators/migration_wip/20_glossary/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ A
This text is referred to as the accessible label because screen readers read
all of the text that you supply for the problem and then repeat the text that
is identified with this formatting immediately before reading the answer
choices for the problem. This text is also used by reports and Insights to
choices for the problem. This text is also used by reporting systems to
identify each problem.

All problems require accessible labels.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ Additionally, biographies can optionally include the following information.
Course Team Roles
*****************

To give team members access to Studio, the instructor dashboard in the LMS, and
Insights, you assign one of these course team roles to them.
To give team members access to Studio, and the instructor dashboard in the LMS
you assign one of these course team roles to them.

* Staff

Expand All @@ -71,9 +71,9 @@ Insights, you assign one of these course team roles to them.
* Admin

You can assign these privileged roles when you work in either the LMS or
Studio. The people who have these roles can work on your course in Studio, the
LMS, and Insights. For more information about assigning roles to team members
in Studio, see :ref:`Add Course Team Members <Add Course Team Members>`.
Studio. The people who have these roles can work on your course in Studio and
the LMS. For more information about assigning roles to team members in Studio,
see :ref:`Add Course Team Members <Add Course Team Members>`.

You can also designate teams of people to beta test your course or to moderate
and manage its discussions by assigning other roles in the LMS. Beta testers
Expand All @@ -94,7 +94,7 @@ To provide access to features on the instructor dashboard in the LMS, you
can assign the Staff role or the Admin role to course team members.

Team members who have either of these roles can work on your course in Studio
immediately, and can also use the LMS and Insights. For more information about
immediately, and can also use the LMS. For more information about
assigning roles while you run your course, see :ref:`Course_Staffing <Course_Staffing>`.

You can also designate teams of people to beta test your course and to
Expand Down Expand Up @@ -159,4 +159,4 @@ complete the following tasks.
.. note:: To moderate course discussions, team members must explicitly be
added to a discussion moderation role in addition to having the course
team Staff or Admin role. For more information, see
:ref:`Assigning_discussion_roles <Assigning_discussion_roles>`.
:ref:`Assigning_discussion_roles <Assigning_discussion_roles>`.
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,13 @@ Set the Display Name for a Component

The display name identifies the component. This name appears as a heading
above the component in the LMS, and it identifies the component for you in
Insights.
reporting and analytics systems.

The following illustration shows the display name of a problem in Studio, in
the LMS, and in Insights.
The following illustration shows the display name of a problem in Studio and in
the LMS.

.. image:: ../images/display_names_problem.png
:alt: The identifying display name for a problem in Studio, the LMS, and
Insights.
:alt: The identifying display name for a problem in Studio, and the LMS.
:width: 800

Unique, descriptive display names help you and your learners identify
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ To create a new section, follow these steps.

#. Enter the name for the new section. A descriptive name can help learners
locate content in the course. It can also help you select content when
you analyze performance in edX Insights.
you analyze performance in reporting or analytics systems.

#. :ref:`Add subsections<Create a Subsection>` to the new section as needed.

Expand Down Expand Up @@ -416,4 +416,4 @@ To delete a section, follow these steps.
:width: 500

2. When you receive the confirmation prompt, select **Yes, delete this
section**.
section**.
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ To create a new subsection, follow these steps.
selected.
#. Enter the name for the new subsection. A descriptive name can help learners
locate content in the course. It can also help you select content when you
analyze performance in edX Insights.
analyze performance in reporting and analytics systems.
#. :ref:`Add units<Create a Unit>` to the new subsection as needed.

It is recommended that you :ref:`test course content <Testing Your Course
Expand Down Expand Up @@ -510,4 +510,4 @@ To delete a subsection, follow these steps.
circled.

#. When the confirmation prompt appears, select **Yes, delete this
subsection**.
subsection**.
Loading