Add Product Release Notes for Olive (#536)

* Add New Studio Editor product note * Add New Discussions in Olive Post * Add Moderator and Author Discussions Changes post * Add 3rd Party Discussions Olive post
openedx · Jul 19, 2024 · 600ad4b · 600ad4b
1 parent 35639ea
commit 600ad4b
Show file tree

Hide file tree

Showing 45 changed files with 667 additions and 1 deletion.
diff --git a/source/_images/release_notes/olive/close_post.gif b/source/_images/release_notes/olive/close_post.gif
diff --git a/source/_images/release_notes/olive/discussA1.png b/source/_images/release_notes/olive/discussA1.png
diff --git a/source/_images/release_notes/olive/discussA2.png b/source/_images/release_notes/olive/discussA2.png
diff --git a/source/_images/release_notes/olive/discussA3.png b/source/_images/release_notes/olive/discussA3.png
diff --git a/source/_images/release_notes/olive/discussA4.png b/source/_images/release_notes/olive/discussA4.png
diff --git a/source/_images/release_notes/olive/discussB1.png b/source/_images/release_notes/olive/discussB1.png
diff --git a/source/_images/release_notes/olive/discussB2.png b/source/_images/release_notes/olive/discussB2.png
diff --git a/source/_images/release_notes/olive/discussB3.png b/source/_images/release_notes/olive/discussB3.png
diff --git a/source/_images/release_notes/olive/discussB4.png b/source/_images/release_notes/olive/discussB4.png
diff --git a/source/_images/release_notes/olive/discussB5.png b/source/_images/release_notes/olive/discussB5.png
diff --git a/source/_images/release_notes/olive/discussB6.png b/source/_images/release_notes/olive/discussB6.png
diff --git a/source/_images/release_notes/olive/discussB7.png b/source/_images/release_notes/olive/discussB7.png
diff --git a/source/_images/release_notes/olive/discussB8.png b/source/_images/release_notes/olive/discussB8.png
diff --git a/source/_images/release_notes/olive/discussC1.png b/source/_images/release_notes/olive/discussC1.png
diff --git a/source/_images/release_notes/olive/discussC2.png b/source/_images/release_notes/olive/discussC2.png
diff --git a/source/_images/release_notes/olive/discussC3.png b/source/_images/release_notes/olive/discussC3.png
diff --git a/source/_images/release_notes/olive/discussC4.png b/source/_images/release_notes/olive/discussC4.png
diff --git a/source/_images/release_notes/olive/discussC5.png b/source/_images/release_notes/olive/discussC5.png
diff --git a/source/_images/release_notes/olive/discussC6.png b/source/_images/release_notes/olive/discussC6.png
diff --git a/source/_images/release_notes/olive/discussC7.png b/source/_images/release_notes/olive/discussC7.png
diff --git a/source/_images/release_notes/olive/edit_post_reasons.gif b/source/_images/release_notes/olive/edit_post_reasons.gif
diff --git a/source/_images/release_notes/olive/editor1.png b/source/_images/release_notes/olive/editor1.png
diff --git a/source/_images/release_notes/olive/editor2.png b/source/_images/release_notes/olive/editor2.png
diff --git a/source/_images/release_notes/olive/editor3.png b/source/_images/release_notes/olive/editor3.png
diff --git a/source/_images/release_notes/olive/editor4.png b/source/_images/release_notes/olive/editor4.png
diff --git a/source/_images/release_notes/olive/editor5.png b/source/_images/release_notes/olive/editor5.png
diff --git a/source/_images/release_notes/olive/editor6.png b/source/_images/release_notes/olive/editor6.png
diff --git a/source/_images/release_notes/olive/editor7.png b/source/_images/release_notes/olive/editor7.png
diff --git a/source/_images/release_notes/olive/editor8.png b/source/_images/release_notes/olive/editor8.png
diff --git a/source/_images/release_notes/olive/enable_discussion_studio.gif b/source/_images/release_notes/olive/enable_discussion_studio.gif
diff --git a/source/_images/release_notes/olive/new_filter_ui.gif b/source/_images/release_notes/olive/new_filter_ui.gif
diff --git a/source/_images/release_notes/olive/roundup1.png b/source/_images/release_notes/olive/roundup1.png
diff --git a/source/_images/release_notes/olive/roundup2.png b/source/_images/release_notes/olive/roundup2.png
diff --git a/source/_images/release_notes/olive/roundup3.png b/source/_images/release_notes/olive/roundup3.png
diff --git a/source/_images/release_notes/olive/roundup4.png b/source/_images/release_notes/olive/roundup4.png
diff --git a/source/_images/release_notes/olive/roundup5.png b/source/_images/release_notes/olive/roundup5.png
diff --git a/source/_images/release_notes/olive/roundup6.png b/source/_images/release_notes/olive/roundup6.png
diff --git a/source/community/release_notes/old_releases.rst b/source/community/release_notes/old_releases.rst
@@ -13,7 +13,7 @@ fixes and features. These older releases will not receive any of those.
 
    quince-landing
    palm-landing
-   olive
+   olive-landing
    nutmeg
    maple
    lilac

diff --git a/source/community/release_notes/olive-landing.rst b/source/community/release_notes/olive-landing.rst
@@ -0,0 +1,14 @@
+Open edX Olive Release
+######################
+
+These are the release notes for the Palm release, the 16th community release
+of the Open edX Platform, released in June 2023. You can also review details
+about :doc:`index` or learn more about the `Open edX Platform`_.
+
+.. toctree::
+   :maxdepth: 2
+
+   olive/feature_release_notes
+   olive
+
+.. _Open edX Platform: https://openedx.org
diff --git a/source/community/release_notes/olive/feature_release_notes.rst b/source/community/release_notes/olive/feature_release_notes.rst
@@ -0,0 +1,19 @@
+Open edX Olive Release - Feature-Based Notes
+############################################
+
+.. toctree::
+   :maxdepth: 1
+
+   olive_studio_editor
+   olive_discussions
+   olive_discussions_mods
+   olive_3rd_party_discussions
+
+.. toctree::
+   :maxdepth: 2
+
+   feature_roundup
+
+Information for site operators and developers, including information on how to
+enable and/or configure new features that require additional work, can be found
+in the :doc:`../palm`.
diff --git a/source/community/release_notes/olive/feature_roundup.rst b/source/community/release_notes/olive/feature_roundup.rst
@@ -0,0 +1,141 @@
+Olive Feature Roundup
+#####################
+
+The Olive release contains many features, enhancements, and improvements. Some
+are the subject of their own blog posts: :doc:`olive_discussions` and :doc:`olive_studio_editor`.
+In this post we'll run through a number of other interesting
+additions to the platform, with brief descriptions of what they are.
+
+.. contents::
+  :local:
+  :depth: 1
+
+Resets for Randomized Content Blocks
+************************************
+
+Randomized content blocks now have a “Reset” option, allowing learners to
+prepare themselves for exams by answering a series of questions at random from a
+predetermined problem bank (similar to flashcards). `This video demo of the
+feature <https://www.loom.com/share/91b7224cb8a74cf2891a240b6e4fb8c6>`_ shows
+the learner experience of being able to answer some questions within the Open
+edX LMS and then clicking a “Reset” option to get a new set of unanswered
+questions.
+
+      .. image:: /_images/release_notes/olive/roundup1.png
+
+
+To enable this feature, create a Randomized Content Block in Studio and set the
+:guilabel:`Show Reset Button`` option to True.
+
+      .. image:: /_images/release_notes/olive/roundup2.png
+
+
+Note: before you can add randomized content blocks to your course, you must add
+a Content Library in Studio. Once you've done that, you can add the randomized
+content block by clicking the “Library Content” button when adding a new
+Component to a Unit. See the next section for instructions on how to get a test
+library.
+
+Open edX Test Course & Test Library
+***********************************
+
+The Open edX project now provides a `testing course & testing library
+<https://github.com/openedx/openedx-test-course/tree/master/dist>`_ with the aim
+of exposing as many Open edX Studio & courseware features as possible. The test
+course provides example usages of various block types and by enabling various
+features through Advanced Settings, and also exposes usage of the test Content
+Library. You are free to use these in your installation; it is useful both to
+see how a problem type behaves in the LMS as well as how to set it up in Studio.
+
+      .. image:: /_images/release_notes/olive/roundup3.png
+
+
+Install the course or library by creating a new, blank course or library in
+Studio. Then, from the Tools menu, select :guilabel:`Import`. Upload the correct file
+(``test-course.tar.gz`` or ``test-problem-bank.tar.gz``), and you will be all set.
+
+This course is new as of the Maple (June 2022) release, and is tested to work on
+both Maple and Nutmeg; it's a bit sparse at the moment, but will be continually
+updated over time. Currently, the test course contains at least one usage of all
+advanced block types that come pre-installed in the Open edX release. Some of
+the block usages aren't yet configured; for example, the LTI Consumer block
+usage exists with instructions on how to use it, but it isn't actually set up to
+consume an LTI tool yet.
+
+We are looking for contributions to make this course better! If you're
+interested in contributing, here are some things we're looking for:
+
+* Actual tool launches for various configurations of lti and lti_consumer blocks.
+* Use of content groups for units and sequences. Currently, content groups are only tested at the component (sub-unit) level.
+* Use of custom Python in Advanced LONCAPA problems. 
+* Examples usages of start/end dates, beta-released content, etc.
+* Handouts, static tabs, and other advanced uses of the Course Home.
+
+If you want to help out but don't know where to start, visit us on the
+`Discussion Forums <http://discuss.openedx.org>`_. Instructions for contributing
+are also available `on GitHub <https://github.com/openedx/openedx-test-course#contributing>`_.
+
+Pages and Resources View
+************************
+
+Olive contains a new micro front-end (MFE) called course authoring, which
+enables an overhaul of the Pages and Resources view. This is a page within your
+course's configuration in Studio that allows you to easily turn features on and
+off; applications and tools that previously required fiddling with advanced
+course settings can now be set up in a few clicks using the Course Authoring
+MFE.
+
+      .. image:: /_images/release_notes/olive/roundup4.png
+
+
+Clicking the gear icon on “Progress”, “Wiki”, and “Calculator” creates a pop-up
+that allows you to quickly enable or disable the feature for the course. We'll
+cover the various options available when choosing the Discussion option in a
+future post.
+
+Authentication Micro-frontend (MFE)
+***********************************
+
+A new MFE has been added in this release, known as the `Authentication (or
+“Authn”) MFE <https://github.com/openedx/frontend-app-authn/>`_. This provides a
+streamlined registration, sign in, and Forgot Password experience. During the
+registration process, a set of available usernames are suggested, based on the
+full name entered.
+
+      .. image:: /_images/release_notes/olive/roundup5.png
+
+If an entered username already exists, the user is notified and given some similar, available suggestions.
+
+      .. image:: /_images/release_notes/olive/roundup6.png
+
+
+Some brief operator notes: you can set the `LOGO_URL MFE setting
+<https://github.com/openedx/frontend-app-authn/blob/master/src/base-component/AuthLargeLayout.jsx#L14>`_
+(which you should be able to do `via dynamic configuration
+<https://github.com/openedx/edx-platform/blob/open-release/olive.master/lms/djangoapps/mfe_config_api/docs/decisions/0001-mfe-config-api.rst>`_
+in Olive) to add your logo to this page. There are also instructions for
+installing a custom brand package in an MFE in the `tutor-mfe README
+<https://github.com/overhangio/tutor-mfe#customising-mfes>`_. If you'd like to
+revert to the legacy experience, running ``tutor config save --set
+MFE_AUTHN_MFE_APP=null`` would be the simplest possible way, as instructed in
+the `tutor-mfe README
+<https://github.com/overhangio/tutor-mfe#customising-mfes>`_.
+
+Other Small/Operational Changes
+*******************************
+
+* The `Molecular Structure Problem type
+  <https://github.com/openedx/public-engineering/issues/14>`_ was removed.
+* The Learning Micro front-end is now required and the legacy learner view has
+  been deprecated. This means that if your instance hasn't been using the
+  Learning MFE, it will now, and you may notice some slight visual changes.
+* Grades are now persistent, meaning that they are stored in MySQL database
+  tables for fast access and improved performance anywhere grades information
+  exists. This has been optional since Hawthorn but is now required. For
+  technical information about the upgrade, `visit this wiki page
+  <https://openedx.atlassian.net/wiki/spaces/AC/pages/755171487/Migrating+to+Persistent+Grading>`_.
+* Android app support is currently limited to `Release 3.0.2
+  <https://github.com/openedx/edx-app-android/releases/tag/release%2F3.0.2https://github.com/openedx/edx-app-android/releases/tag/release%2F3.0.2>`_
+  of the ``edx-android-app`` codebase. The only noticeable impact here is that
+  there may be new features in the iOS app that are not in the older version of
+  the Android release.
diff --git a/source/community/release_notes/olive/olive_3rd_party_discussions.rst b/source/community/release_notes/olive/olive_3rd_party_discussions.rst
@@ -0,0 +1,152 @@
+Configuring 3rd Party Discussion Experiences (Olive)
+####################################################
+
+The Olive release includes the ability to configure a 3rd party discussion
+provider for your course's discussion experience. This configuration is done
+within Studio. Read on for more details.
+
+.. contents::
+  :local:
+  :depth: 2
+
+Setup Discussions Prior to Course Start
+***************************************
+
+The Olive release includes the ability to configure a 3rd party discussion
+provider for your course's discussion experience. This must be done prior to a
+course's start date. To do this, first navigate to the Pages and Resources view:
+
+      .. image:: /_images/release_notes/olive/discussC1.png
+
+
+Clicking on the “Discussion” gear icon brings you to a landing page where you
+can pick from various discussion provider options for your course:
+
+      .. image:: /_images/release_notes/olive/discussC2.png
+
+
+The options include descriptions, and a checklist below the options compare the
+benefits of the various types of providers. Note that only the “edX” option is
+included with the Olive release. Configuring one of the other providers
+(Yellowdig, InScribe, Piazza, or Ed Discussion) requires you to have a
+subscription at that site. These external providers may charge for their
+services.
+
+Enabling a Third-Party Discussions Provider
+*******************************************
+
+Your instance administrator will help you configure the new discussions provider
+for your course. Note that you'll need your course to allow PII sharing with the
+discussions provider. You should ensure you understand the implications of this,
+which may include sending learner usernames, email addresses, and/or full names
+to the third party provider, and may not be allowed in your jurisdiction.
+
+First, reach out to your chosen provider and get a course set up. You will need
+them to send you the following LTI launch info: Consumer Key, Consumer Secret,
+and Launch URL. Once you have that, your instance administrator will take the
+following steps:
+
+#. To turn on PII sharing, your instance administrator will visit the admin page
+   for PII sharing at
+   ``[your-site-url]/admin/lti_consumer/courseallowpiisharinginltiflag`` and
+   enable the option using your course's course key.
+
+#. Once that is done, the instance administrator will be able to set up the LTI
+   integration by visiting the course's Pages & Resources view in Studio,
+   clicking on the preferred discussion provider, and filling in the LTI launch
+   info:
+
+         .. image:: /_images/release_notes/olive/discussC3.png
+
+
+
+We'll now take a short look at the four available discussion providers and let
+you know how to get started with each of them.
+
+Ed Discussion
+=============
+
+`Ed Discussion <https://edstem.org/>`_ helps scale class communication in an
+intuitive interface to facilitate Q&A and quality discussion, provide course
+information and more. Moderation tools are robust, and instructors can access an
+analytics page which shows trends in participation, views, answers, and top
+contributors across a variety of metrics. Functionality includes automation,
+advanced LaTeX, image annotation, live interpreters to help learners write and
+execute code directly, and much more for STEM, CS, business and many other
+disciplines.
+
+Complementing Ed Discussion are `Ed Lessons <https://edstem.org/lessons>`_ and
+`Ed Workspaces <https://edstem.org/workspaces>`_ for interactive content to
+learn and practice skills like programming, bash scripts, HTML pages,
+collaborative JuPyter notebooks, and much more.
+
+      .. image:: /_images/release_notes/olive/discussC4.png
+
+For more information or to get started with Ed Discussion visit `edstem.org
+<edstem.org>`_ or contact [email protected].
+
+*Note: the above screenshot was provided by edX. The tCRIL team has been unable
+to confirm that the iframe view of Ed Discussions works in Olive; for us, Ed
+Discussions opened full screen rather than embedded in the LMS.*
+
+Yellowdig
+=========
+
+`Yellowdig <https://www.yellowdig.co/>`_ is a community-focused platform aiming
+to turn your course into an active learning community through its
+research-driven, hyper-interactive, Yellowdig Engage platform. This platform was
+built upon principles of Agency, Mastery, and Connectedness. Yellowdig is unique
+in providing a graded discussions experience which is cumulative over the span
+of your course, encouraging repeated and active participation in the discussions
+forums.
+
+      .. image:: /_images/release_notes/olive/discussC5.png
+
+
+
+To learn more about Yellowdig, check out their `Resources page
+<https://www.yellowdig.co/resources>`_, take their `introductory instructor and
+design courses <https://learn.yellowdig.co/>`_, or email
+[email protected].
+
+Note: In the Olive release, the grade passback functionality is not implemented
+in the Discussions MFE integration. To enable grades from Yellowdig in your
+platform, we recommend that you `manually export grades from Yellowdig
+<https://help.yellowdig.co/kb/en/article/exporting-grades-manual-grade-passback>`_
+and input the scores directly into your course.
+
+InScribe
+========
+
+InScribe is a learning support tool built on a community model. With InScribe,
+learners and moderators can create conversations that can be collaboratively
+answered and endorsed by moderators.Conversations are organized into topics,
+which make it easier to navigate content. You can also copy your term into a new
+course, to preserve useful content for future learners.
+
+      .. image:: /_images/release_notes/olive/discussC6.png
+
+
+
+To get a peek into how a community can be used as a knowledge repository as well
+as a place to get accurate information, ask questions, and connect with peers,
+visit `InScribe's Get to Know Us Page
+<https://inscribe.education/main/inscribe/6754110229500853/compositions/6749461749594201>`_
+and their `tips for a thriving community
+<https://inscribe.education/main/inscribe/6754110229500853/compositions/6749461749594195>`_.
+To get started with InScribe, reach out to [email protected].
+
+Piazza
+======
+
+`Piazza <https://piazza.com/>`_ is an engaging question and answer tool that
+focuses on features such as wiki-style collaborative answers to questions,
+support for mathematical-based courses in LaTeX, real-time updating, and
+effective moderation tools such as instructor-endorsed answers. Instructors can
+view engagement reports that give insight into individual participation levels
+and allow you to pinpoint when your class is asking the highest volume of
+questions.
+
+      .. image:: /_images/release_notes/olive/discussC7.png
+
+To get started with Piazza, reach out to [email protected].