diff --git a/docs/en_us/release_notes/source/05-20-2014.rst b/docs/en_us/release_notes/source/05-20-2014.rst new file mode 100644 index 0000000000..6e5df7a87c --- /dev/null +++ b/docs/en_us/release_notes/source/05-20-2014.rst @@ -0,0 +1,101 @@ +################################### +May 20, 2014 +################################### + +The following information reflects what is new in the edX Platform as of May 20, 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. + + +************* +edX Studio +************* + +* This release introduces context-sensitive online help to Studio. You can click + **Help** in the upper-right corner to get more information about the + Studio page you are viewing. You can also click links that appear in the right + panel on some pages. + + .. image:: /images/help.png + :alt: Online help links in Studio + + A page in edX's continuously updated documentation that is related to the Studio page you are viewing opens in a new browser tab or window: + + .. image:: /images/help_page.png + :alt: A Studio online help page + + + You can also expand the panel at the bottom of the Studio user interface and + use the links to access a PDF file of edX course staff documentation, edX + Studio Author Support, and edX101. + + .. image:: /images/sock_help.png + :alt: Other help resources at the bottom of the Studio UI + + +* A problem that caused the video transcript download button to not work for + students is fixed. If this was a problem in your course, you must re-import + the course in Studio. (BLD-1014) + +* A problem that prevented users with only course staff privileges from + importing courses is resolved. (STUD-1595) + + +************************** +edX Documentation +************************** + + +The following documentation is available: + +* `Building and Running an edX Course`_ + + Click the Help buttons 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: + + Updated `Working with Video Components`_ to reflect UI changes. + + +* `edX Data Documentation`_ + + Recent changes include: + + * Added an `event list`_, an alphabetical list of events with links to the + `Tracking Logs`_ chapter. + + * Updated the `Tracking Logs`_ chapter to provide a standardized structure + for delivering information about events and address problems with table + formatting. + + +* `edX Platform Developer Documentation`_ + + Recent changes include: + + Updated the `Analytics`_ section to include information on documenting and + debugging events. + +* `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/conf.py b/docs/en_us/release_notes/source/conf.py index e18f036263..403f5fa690 100644 --- a/docs/en_us/release_notes/source/conf.py +++ b/docs/en_us/release_notes/source/conf.py @@ -28,7 +28,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # General information about the project. -project = u'Release Notes for edX Course Staff' +project = u'edX Course Staff Release Notes' copyright = u'2014, edX' # The short X.Y version. diff --git a/docs/en_us/release_notes/source/images/help.png b/docs/en_us/release_notes/source/images/help.png new file mode 100644 index 0000000000..8d016c72bd Binary files /dev/null and b/docs/en_us/release_notes/source/images/help.png differ diff --git a/docs/en_us/release_notes/source/images/help_page.png b/docs/en_us/release_notes/source/images/help_page.png new file mode 100644 index 0000000000..983a746347 Binary files /dev/null and b/docs/en_us/release_notes/source/images/help_page.png differ diff --git a/docs/en_us/release_notes/source/images/sock_help.png b/docs/en_us/release_notes/source/images/sock_help.png new file mode 100644 index 0000000000..40f5a6869c Binary files /dev/null and b/docs/en_us/release_notes/source/images/sock_help.png differ diff --git a/docs/en_us/release_notes/source/index.rst b/docs/en_us/release_notes/source/index.rst index f00cde5a41..3bea7e47c9 100755 --- a/docs/en_us/release_notes/source/index.rst +++ b/docs/en_us/release_notes/source/index.rst @@ -19,6 +19,7 @@ There is a page in this document for each update to the edX system on `edx.org`_ :maxdepth: 1 read_me + 05-20-2014 05-15-2014 05-12-2014 04-29-2014 diff --git a/docs/en_us/release_notes/source/links.rst b/docs/en_us/release_notes/source/links.rst index 82ab96e16c..1f7db8c188 100644 --- a/docs/en_us/release_notes/source/links.rst +++ b/docs/en_us/release_notes/source/links.rst @@ -1,6 +1,8 @@ .. Links +.. _edX Release Announcements mailing list: http://eepurl.com/U84tj + .. _edX Edge: https://edge.edx.org .. _edx.org: http://edx.org @@ -14,148 +16,148 @@ .. _edX roadmap: https://edx-wiki.atlassian.net/wiki/display/OPENPROD/Open+EdX+Public+Product+Roadmap -.. _Building and Running an edX Course: http://edx.readthedocs.org/projects/ca/en/latest/ +.. _Building and Running an edX Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/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/ -.. _Testing Your Course: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/view_course_content.html#testing-your-course +.. _Testing Your Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/view_course_content.html#testing-your-course -.. _Switch Between Studio and Your Live Course: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/view_course_content.html#view-your-live-course +.. _Switch Between Studio and Your Live Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/view_course_content.html#view-your-live-course -.. _Transcripts in Additional Languages: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_video.html#transcripts-in-additional-languages +.. _Transcripts in Additional Languages: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_video.html#transcripts-in-additional-languages -.. _Working with Video Components: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_video.html +.. _Working with Video Components: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_video.html -.. _Bulk Email: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/course_launching.html#bulk-email +.. _Bulk Email: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/course_launching.html#bulk-email .. _Enrollment: http://ca.readthedocs.org/en/latest/running_course/course_enrollment.html#enrollment -.. _Shuffle Answers in a Multiple Choice Problem: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/multiple_choice.html#shuffle-answers-in-a-multiple-choice-problem +.. _Shuffle Answers in a Multiple Choice Problem: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/multiple_choice.html#shuffle-answers-in-a-multiple-choice-problem -.. _Targeted Feedback in a Multiple Choice Problem: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/multiple_choice.html#targeted-feedback-in-a-multiple-choice-problem +.. _Targeted Feedback in a Multiple Choice Problem: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/multiple_choice.html#targeted-feedback-in-a-multiple-choice-problem -.. _Answer Pools in a Multiple Choice Problem: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/multiple_choice.html#answer-pools-in-a-multiple-choice-problem +.. _Answer Pools in a Multiple Choice Problem: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/multiple_choice.html#answer-pools-in-a-multiple-choice-problem -.. _Grade and Answer Data: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_grades.html#grades +.. _Grade and Answer Data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_grades.html#grades -.. _Multiple Choice: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/multiple_choice.html +.. _Multiple Choice: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/multiple_choice.html -.. _Course Data: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_data.html#course-data +.. _Course Data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_data.html#course-data -.. _Staffing: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_staffing.html#course-staffing +.. _Staffing: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_staffing.html#course-staffing -.. _Working with HTML Components: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_html_component.html +.. _Working with HTML Components: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_html_component.html .. _Custom JavaScript Applications: http://edx.readthedocs.org/projects/userdocs/en/latest/extending_platform/javascript.html -.. _Go to Studio from Your Live Course: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/view_course_content.html#go-to-studio-from-your-live-course +.. _Go to Studio from Your Live Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/view_course_content.html#go-to-studio-from-your-live-course -.. _Student Answer Distribution: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_grades.html#review-answers +.. _Student Answer Distribution: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_grades.html#review-answers .. _Releasing Your Course: http://ca.readthedocs.org/en/latest/releasing_course/index.html#releasing-your-course-index .. _Course Launching Activities: http://ca.readthedocs.org/en/latest/releasing_course/course_launching.html#launch -.. _Adding Pages to a Course: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/pages.html#adding-pages-to-a-course +.. _Adding Pages to a Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/pages.html#adding-pages-to-a-course -.. _Show or Hide the Course Wiki Page: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/pages.html#show-or-hide-the-course-wiki-page +.. _Show or Hide the Course Wiki Page: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/pages.html#show-or-hide-the-course-wiki-page -.. _Building a Course: http://edx.readthedocs.org/projects/ca/en/latest/building_course/index.html#building-a-course-index +.. _Building a Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/index.html#building-a-course-index -.. _Creating Course Content: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/index.html#creating-course-content-index +.. _Creating Course Content: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/index.html#creating-course-content-index -.. _Beta Testing a Course: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/beta_testing.html#beta-testing +.. _Beta Testing a Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/beta_testing.html#beta-testing -.. _Student Data: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_student.html#student-data +.. _Student Data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_student.html#student-data -.. _Add the Beta Testers: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/beta_testing.html#add-testers +.. _Add the Beta Testers: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/beta_testing.html#add-testers -.. _Getting Started: http://edx.readthedocs.org/projects/ca/en/latest/getting_started/index.html#getting-started-index +.. _Getting Started: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/getting_started/index.html#getting-started-index -.. _Building a Course: http://edx.readthedocs.org/projects/ca/en/latest/building_course/index.html#building-a-course-index +.. _Building a Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/index.html#building-a-course-index -.. _Creating Exercises and Tools: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/index.html +.. _Creating Exercises and Tools: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/index.html -.. _Running Your Course: http://edx.readthedocs.org/projects/ca/en/latest/running_course/index.html#running-your-course-index +.. _Running Your Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/index.html#running-your-course-index -.. _Information for Your Students: http://edx.readthedocs.org/projects/ca/en/latest/students/index.html#information-for-your-students-index +.. _Information for Your Students: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/students/index.html#information-for-your-students-index -.. _The Course Start Date: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#the-course-start-date +.. _The Course Start Date: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#the-course-start-date -.. _The Course End Date: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#the-course-end-date +.. _The Course End Date: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#the-course-end-date -.. _Add a Course Image: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#add-a-course-image +.. _Add a Course Image: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#add-a-course-image -.. _Add a Course Introduction Video: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#add-a-course-video +.. _Add a Course Introduction Video: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#add-a-course-video -.. _Describe Your Course: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#describe-your-course +.. _Describe Your Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#describe-your-course -.. _Create or Obtain a Video Transcript: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_video.html#create-transcript +.. _Create or Obtain a Video Transcript: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_video.html#create-transcript -.. _Staff Debug Info: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/staff_debug_info.html +.. _Staff Debug Info: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/staff_debug_info.html -.. _Add Files to a Course: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/course_files.html +.. _Add Files to a Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/course_files.html -.. _Import LaTeX Code into an HTML Component: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_html_component.html#import-latex-code +.. _Import LaTeX Code into an HTML Component: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_html_component.html#import-latex-code -.. _Establishing a Grading Policy: http://edx.readthedocs.org/projects/ca/en/latest/building_course/establish_grading_policy.html +.. _Establishing a Grading Policy: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/establish_grading_policy.html -.. _Additional transcripts: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_video.html#additional-transcripts +.. _Additional transcripts: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_video.html#additional-transcripts -.. _Staffing data: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_staffing.html +.. _Staffing data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_staffing.html -.. _Enrollment data: http://edx.readthedocs.org/projects/ca/en/latest/running_course/course_enrollment.html +.. _Enrollment data: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/course_enrollment.html -.. _Gene Explorer: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/gene_explorer.html +.. _Gene Explorer: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/gene_explorer.html -.. _Problem Written in LaTeX: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/problem_in_latex.html +.. _Problem Written in LaTeX: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/problem_in_latex.html -.. _Working with Problem Components: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_problem.html +.. _Working with Problem Components: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_problem.html -.. _Set the Advertised Start Date: http://edx.readthedocs.org/projects/ca/en/latest/building_course/setting_up_student_view.html#set-the-advertised-start-date +.. _Set the Advertised Start Date: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/building_course/setting_up_student_view.html#set-the-advertised-start-date -.. _Full Screen Image: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/full_screen_image.html +.. _Full Screen Image: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/full_screen_image.html -.. _Google Instant Hangout Tool: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/google_hangouts.html +.. _Google Instant Hangout Tool: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/google_hangouts.html -.. _Multiple Choice and Numerical Input Problem: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/mult_choice_num_input.html +.. _Multiple Choice and Numerical Input Problem: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/mult_choice_num_input.html -.. _Components: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/organizing_course.html#components +.. _Components: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/organizing_course.html#components -.. _Discussions: http://edx.readthedocs.org/projects/ca/en/latest/running_course/discussions.html +.. _Discussions: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/discussions.html -.. _Guidance for Discussion Moderators: http://edx.readthedocs.org/projects/ca/en/latest/running_course/discussion_guidance_moderators.html +.. _Guidance for Discussion Moderators: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/discussion_guidance_moderators.html -.. _External Graders: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/external_graders.html +.. _External Graders: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/external_graders.html -.. _duplicating components: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/organizing_course.html#duplicate-a-component +.. _duplicating components: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/organizing_course.html#duplicate-a-component -.. _Video Advanced Options: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/create_video.html#advanced-options +.. _Video Advanced Options: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/create_video.html#advanced-options -.. _Organizaing Your Course Content: http://edx.readthedocs.org/projects/ca/en/latest/creating_content/organizing_course.html +.. _Organizaing Your Course Content: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/creating_content/organizing_course.html -.. _Custom JavaScript Problem: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/custom_javascript.html +.. _Custom JavaScript Problem: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/custom_javascript.html -.. _Zooming Image Tool: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/zooming_image.html +.. _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/ca/en/latest/exercises_tools/problem_with_hint.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/ca/en/latest/exercises_tools/iframe.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 -.. _Assign Discussion Administration Roles: http://edx.readthedocs.org/projects/ca/en/latest/running_course/discussions.html#assigning-discussion-roles +.. _Assign Discussion Administration Roles: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/running_course/discussions.html#assigning-discussion-roles -.. _LTI Component: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/lti_component.html +.. _LTI Component: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html -.. _VitalSource E-Reader Tool: http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/vitalsource.html +.. _VitalSource E-Reader Tool: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/exercises_tools/vitalsource.html .. DATA DOCUMENTATION @@ -171,10 +173,12 @@ .. _Discussion Forum Data: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/discussion_data.html#discussion-forums-data -.. _Release Dates: http://edx.readthedocs.org/projects/ca/en/latest/releasing_course/set_content_releasedates.html#release-dates +.. _Release Dates: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/releasing_course/set_content_releasedates.html#release-dates .. _Data Czar/Data Team Selection and Responsibilities: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/data_czar.html +.. _event list: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/event_list.html#event-list + .. Developer Doc .. _Contributing to Open edX: http://edx.readthedocs.org/projects/userdocs/en/latest/process/index.html