From 382251495a0c8306e38ad459b79e60fbbee66d12 Mon Sep 17 00:00:00 2001 From: Mark Hoeber Date: Mon, 26 May 2014 13:33:21 -0400 Subject: [PATCH 1/2] Release notes for 5/28/14 --- .../en_us/release_notes/source/06-10-2014.rst | 169 ++++++++++++++++++ docs/en_us/release_notes/source/index.rst | 1 + docs/en_us/release_notes/source/links.rst | 22 ++- 3 files changed, 189 insertions(+), 3 deletions(-) create mode 100644 docs/en_us/release_notes/source/06-10-2014.rst diff --git a/docs/en_us/release_notes/source/06-10-2014.rst b/docs/en_us/release_notes/source/06-10-2014.rst new file mode 100644 index 0000000000..172739ab35 --- /dev/null +++ b/docs/en_us/release_notes/source/06-10-2014.rst @@ -0,0 +1,169 @@ +################################### +June 10, 2014 +################################### + +The following information reflects what is new in the edX Platform as of June 10, +2014. See previous pages in this document for a history of changes. + +**************************************** +edX Release Announcements Mailing List +**************************************** + +These edX Course Staff Release Notes are always available and are updated with +each release of the edX Platform on `edx.org`_ and `edX Edge`_. + +In addition, you can sign up for the new `edX Release Announcements mailing +list`_ to get an email message when we have updated the edX Course Staff Release +Notes. + + +*************************************** +The New Key Introspection API +*************************************** + +This release implements a change in the edX Platform software architecture. The +Key Introspection API is now used to uniquely identify Xblocks, the building +blocks for edX courses. This change simplifies the way that the application +identifies the course content internally. This change does not affect how you +author content. + +In edX Studio, URL formats have changed for all courses. If you previously bookmarked a page in Studio, that bookmark will no longer work. You must update the URL. + +Following is a sample of this format change: + +* Old URL: ``https://studio.edx.org/course/OrganizationX.Econ101.2014_T1/branch/draft/block/2014_T1`` + +* New URL: ``https://studio.edx.org/course/slashes:OrganizationX+Econ101+2014_T1`` + +This change does not affect student-visible URLs. + +In the edX LMS, the only change is that to reset attempts or rescore student +responses in the **Student Admin** tab on the Instructor Dashboard, you must now +specify the complete location identifier of the problem. The `Student Grades and +Grading`_ section is updated with this revised requirement. + +For additional technical detail about this architectural change and the opportunities it creates, see `Opaque Keys`_ on the GitHub wiki. + +*************************************** +edX Learning Management System +*************************************** + +* A problem with the **Register** button on `edX Edge`_ is fixed. If you are not + logged in to edX Edge, you are redirected to the login page, from which new + users can register. + +* If a student's browser does not support HTML5 videos, and the course video is + only available in HTML5, the following error message is now displayed to the + student: ``This browser cannot play .mp4, .ogg, or .webm files. Try using a + different browser, such as Google Chrome.`` (BLD-638) + +* Video transcripts are now displayed correctly on iPads. (BLD-1033) + +=========================== +Accessibility Improvements +=========================== + +* Drag and drop problems are updated to improve accessibility for screen + readers: + + * User interface elements that receive focus now have a visual focus + indicated. (LMS-1940) + + * Each user interface element now exposes its name, state, role, and value to + assistive technologies. (LMS-1904) + + * The target image now has an ``alt`` attribute. (LMS-1699) + + +************************** +edX Documentation +************************** + + +The following documentation is available: + +* `Building and Running an edX Course`_ + + Click **Help** button in the upper-right corner of any page in the edX Studio + user interface to access relevant sections in this guide. You can also + download the entire guide as a PDF. + + Recent changes include: + + * Added a description of email task workflow states to the `Course Launching + Activities`_ section. + + * Added `Review Grades for Enrolled Students (Small Courses)`_ to the `Student + Grades and Grading`_ section. + + * Updated `Working with Video Components`_ to include recommendations to use + .mp4 and .webm video formats for browser compatibility. + + * Revised the `Student Grades and Grading`_ section based on the new + requirement to specify the complete location identifier of a problem to + adjust student grades. + + * Updated the `Problem with Adaptive Hint`_ section to reflect formatting + requirements for the Python script and the ``correct_answer`` attribute. + + * Reorganized, updated, and streamlined these sections in the `Running Your + Course`_ chapter: + + * Divided "Grade and Answer Data" into separate sections for `Student Grades + and Grading`_ and `Answer Data`_. + + * Moved information about the student Progress page from the "Checking + Student Progress and Issuing Certificates" section to `Student Grades and + Grading`_. + + * Renamed the "Checking Student Progress and + Issuing Certificates" section to `Assign Final Grades and Issue + Certificates`_. + + +* `Creating Peer Assessments`_ + + This is a new document that covers using Open Response Assessments 2.0. + + +* `edX Data Documentation`_ + + Recent changes include: + + Added descriptions of the following events to the `Tracking Logs`_ chapter: + + * ``edx.course.enrollment.upgrade.clicked`` + * ``edx.course.enrollment.upgrade.succeeded`` + * ``edx.forum.searched`` + * ``load_video`` + * ``hide_transcript`` + * ``show_transcript`` + * ``problem_reset`` + * ``problem_graded`` + + +* `Installing, Configuring, and Running the edX Platform`_ + + This is a new document that covers installing and running Devstack. + + +* `edX Platform Developer Documentation`_ + + + +* `edX XBlock Documentation`_ + + + +************************** +Other edX Resources +************************** + +You can access the `edX Status`_ page to get an up-to-date status for all +services on edx.org and edX Edge. The page also includes the Twitter feed for +@edXstatus, which the edX Operations team uses to post updates. + +You can access the public `edX roadmap`_ for +details about the currently planned product direction. + +.. include:: links.rst \ No newline at end of file diff --git a/docs/en_us/release_notes/source/index.rst b/docs/en_us/release_notes/source/index.rst index e5997757ec..77e7a4f65b 100755 --- a/docs/en_us/release_notes/source/index.rst +++ b/docs/en_us/release_notes/source/index.rst @@ -30,6 +30,7 @@ email message when we have updated the edX Course Staff Release Notes. :maxdepth: 1 read_me + 06-10-2014 05-20-2014 05-15-2014 05-12-2014 diff --git a/docs/en_us/release_notes/source/links.rst b/docs/en_us/release_notes/source/links.rst index 1f7db8c188..648350eb07 100644 --- a/docs/en_us/release_notes/source/links.rst +++ b/docs/en_us/release_notes/source/links.rst @@ -18,6 +18,10 @@ .. _Building and Running an edX Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/ +.. _Installing, Configuring, and Running the edX Platform: http://edx.readthedocs.org/projects/edx-installing-configuring-and-running/en/latest/ + +.. _Creating Peer Assessments: http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/ + .. _edX Data Documentation: http://edx.readthedocs.org/projects/devdata/en/latest/ .. _edX Platform Developer Documentation: http://edx.readthedocs.org/projects/userdocs/en/latest/ @@ -146,8 +150,6 @@ .. _Zooming Image Tool: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/zooming_image.html -.. _Problem with Adaptive Hint: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/problem_with_hint.html - .. _IFrame Tool: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/iframe.html .. _Drag and Drop Problem: http://ca.readthedocs.org/en/latest/exercises_tools/drag_and_drop.html @@ -159,6 +161,18 @@ .. _VitalSource E-Reader Tool: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/vitalsource.html +.. _Problem with Adaptive Hint: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/problem_with_hint.html#problem-with-adaptive-hint + + +.. _Student Grades and Grading: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_grades.html#grades + +.. _Answer Data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_answers.html#review-answers + +.. _Assign Final Grades and Issue Certificates: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/checking_student_progress.html#checking-student-progress-and-issuing-certificates + + +.. _Review Grades for Enrolled Students (Small Courses): http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_grades.html#gradebook + .. DATA DOCUMENTATION .. _Student Info and Progress Data: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/sql_schema.html#student-info @@ -185,4 +199,6 @@ .. _edX XBlock Documentation: http://edx.readthedocs.org/projects/xblock/en/latest/ -.. _Analytics: http://edx.readthedocs.org/projects/userdocs/en/latest/analytics.html \ No newline at end of file +.. _Analytics: http://edx.readthedocs.org/projects/userdocs/en/latest/analytics.html + +.. _Opaque Keys: https://github.com/edx/edx-platform/wiki/Opaque-Keys \ No newline at end of file From e6cb73de592294bc33afd9f260fa559c16956599 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Tue, 10 Jun 2014 15:01:54 -0400 Subject: [PATCH 2/2] Change log now lists one section for June --- docs/en_us/course_authors/source/change_log.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/en_us/course_authors/source/change_log.rst b/docs/en_us/course_authors/source/change_log.rst index e4f9af5e6f..1474a9458d 100644 --- a/docs/en_us/course_authors/source/change_log.rst +++ b/docs/en_us/course_authors/source/change_log.rst @@ -2,6 +2,23 @@ Change Log ############ +*********** +June, 2014 +*********** + +.. list-table:: + :widths: 10 70 + :header-rows: 1 + + * - Date + - Change + * - 06/06/14 + - Added a description of email task workflow states to the :ref:`Launch` + section. + * - 06/03/14 + - Added :ref:`gradebook` to the :ref:`Grades` section. + + *********** May, 2014 ***********