Merge pull request #381 from edx/ahodges/sections

Adds section heads to the include directive, rather than the included file
openedx · Jun 9, 2015 · b8ca0b9 · b8ca0b9
2 parents bda102c + 32f8497
commit b8ca0b9
Show file tree

Hide file tree

Showing 23 changed files with 64 additions and 84 deletions.
diff --git a/en_us/course_authors/source/building_course/search_course.rst b/en_us/course_authors/source/building_course/search_course.rst
diff --git a/en_us/course_authors/source/front_matter/change_log.rst b/en_us/course_authors/source/front_matter/change_log.rst
@@ -2,19 +2,6 @@
 Change Log
 ############
 
-****************
-June 2015
-****************
-
-.. list-table::
-   :widths: 10 70
-   :header-rows: 1
-
-   * - Date
-     - Change
-   * - 8 Jun 2015
-     - Added :ref:`Manage Course Fees`.
-
 ****************
 May 2015
 ****************

diff --git a/en_us/olx/source/problem-xml/create_problem.rst b/en_us/olx/source/problem-xml/create_problem.rst
@@ -573,6 +573,6 @@ Create Randomized Problems
          </randomize>
        </vertical>
 
-.. include:: ../../../shared/exercises_tools/adding_tooltip.rst       
+.. include:: ../../../shared/exercises_tools/adding_tooltip.rst
 
 .. include:: ../links.rst
diff --git a/en_us/open_edx_course_authors/source/exercises_tools/index.rst b/en_us/open_edx_course_authors/source/exercises_tools/index.rst
@@ -50,7 +50,6 @@ Course Content Index`.
    protein_builder
    randomized_content_blocks
    recommenderXBlock
-   student_notes
    text_input
    word_cloud
    custom_python

diff --git a/en_us/open_edx_course_authors/source/front_matter/change_log.rst b/en_us/open_edx_course_authors/source/front_matter/change_log.rst
@@ -16,9 +16,11 @@ June 2015
      - Updated the :ref:`Add a Course Update` section to include information
        about sending notifications to the edX mobile applications.
    * - 
-     - Added the list of :ref:`Mobile-Ready Problem Types`.
+     - Added the list of `Mobile-Ready Problem Types <http://edx.readthedocs.org/projects/open-edx-building-and-running-a-course/en/latest/exercises_tools/create_exercises_and_tools.html#mobile-ready-problem-types>`_.
    * - 
-     - Added the :ref:`Setting Up Course Certificates` section.  
+     - Added the :ref:`Setting Up Course Certificates` section.
+   * - 
+     - Added :ref:`Manage Course Fees`.
 
 *****************
 May 2015

diff --git a/en_us/open_edx_students/source/index.rst b/en_us/open_edx_students/source/index.rst
@@ -15,6 +15,7 @@ Open edX Learner's Guide
    SFD_introduction
    sfd_dashboard_profile/index
    SFD_licensing
+   SFD_course_search
    SFD_video_player
    SFD_bookmarks
    SFD_notes

diff --git a/en_us/shared/building_and_running_chapters/building_course/search_course.rst b/en_us/shared/building_and_running_chapters/building_course/search_course.rst
@@ -26,10 +26,7 @@ When the search engine returns results, either for an individual course or
 across all courses, learners can select any search result to view that result
 in the courseware.
 
-For more information about the student experience, see `Searching the Course
-<http://draft-sfd-search.readthedocs.org/en/latest/SFD_course_search.html>`_.
-
-.. Replace above URL when feature is released
+For more information about the student experience, see `Searching the Course <http://edx.readthedocs.org/projects/open-edx-learner-guide/en/latest/SFD_course_search.html>`_.
 
 .. note:: Studio does not index course exercises and problems, including 
  homework and exam problems. Studio also does not index course discussions.

diff --git a/.../shared/building_and_running_chapters/running_course/Section_course_student.rst b/.../shared/building_and_running_chapters/running_course/Section_course_student.rst
@@ -1,9 +1,5 @@
 .. _Using the Learner Engagement Report:
 
-*************************************
-Using the Learner Engagement Report
-*************************************
-
 With the learner engagement report, you can monitor what individual learners
 are doing in your course. The report contains a row for each enrolled learner,
 and has columns that quantify overall course activity and engagement with

diff --git a/...building_and_running_chapters/running_course/Section_track_student_activity.rst b/...building_and_running_chapters/running_course/Section_track_student_activity.rst
@@ -1,16 +1,12 @@
 .. _Track Student Activity:
 
-***********************
-Track Student Activity
-***********************
-
 To monitor student activity during your course, you can review the number of
 students who, each week, interacted with your course. To be considered active,
 students must visit pages, play videos, add to discussions, submit answers to
 problems, or complete other course activities. The active student count is
 updated weekly.
 
-To display the number of active students:
+To display the number of active students, follow these steps.
 
 #. View the live version of your course.
 

diff --git a/en_us/shared/building_and_running_chapters/running_course/course_student.rst b/en_us/shared/building_and_running_chapters/running_course/course_student.rst
@@ -183,10 +183,18 @@ the ``{course_id}_student_profile_info_{date}.csv`` file of student data or the
 
 .. only:: Open_edX
 
+    *************************************
+    Using the Learner Engagement Report
+    *************************************
+
     .. include:: ../../../shared/building_and_running_chapters/running_course/Section_course_student.rst
 
 .. only:: Partners
 
+    ***********************
+    Track Student Activity
+    ***********************
+
     .. include:: ../../../shared/building_and_running_chapters/running_course/Section_track_student_activity.rst
 
 .. _Using edX Insights: http://edx-insights.readthedocs.org/en/latest/

diff --git a/en_us/shared/building_and_running_chapters/running_course/course_wiki.rst b/en_us/shared/building_and_running_chapters/running_course/course_wiki.rst
@@ -13,8 +13,7 @@ wiki<Seeding the Wiki>` with specific content, by explaining how you want it to
 be used at the beginning of the course, and by providing clear instructions and
 guidelines for its use.
 
-Common uses for the course wiki might
-be:
+Common uses for the course wiki might include the following activities.
 
 * Sharing answers to course FAQs and collecting new FAQs.
 * Sharing editable course information, such as download and installation

diff --git a/en_us/shared/exercises_tools/Section_mobile_problems.rst b/en_us/shared/exercises_tools/Section_mobile_problems.rst
@@ -1,10 +1,7 @@
-.. _Mobile-Ready Problem Types
+.. _Mobile-Ready Problem Types:
 
-*********************************
-Mobile-Ready Problem Types
-*********************************
-
-Learners can read and submit answers for the following types of problems while they use the edX mobile app. 
+Learners can read and submit answers for the following types of problems while
+they use the edX mobile app.
 
 * :ref:`Checkbox`
 * :ref:`Dropdown`

diff --git a/en_us/shared/exercises_tools/adding_tooltip.rst b/en_us/shared/exercises_tools/adding_tooltip.rst
@@ -1,8 +1,8 @@
 .. _Adding Tooltips to a Problem:
 
-====================================
+==============================
 Adding Tooltips to a Problem
-====================================
+==============================
 
 You can add inline tooltips to a problem, so that learners can hover over the
 tooltip icon and see text that you write to help them understand the problem.

diff --git a/en_us/shared/exercises_tools/create_exercises_and_tools.rst b/en_us/shared/exercises_tools/create_exercises_and_tools.rst
@@ -363,4 +363,8 @@ STEM Exercises and Tools
 
 .. only:: Open_edX
 
+  *********************************
+  Mobile-Ready Problem Types
+  *********************************
+
   .. include:: ../../../shared/exercises_tools/Section_mobile_problems.rst
diff --git a/en_us/shared/exercises_tools/notes.rst b/en_us/shared/exercises_tools/notes.rst
@@ -28,5 +28,5 @@ of the notes in the courseware.
   :alt: The Notes page listing all the notes a learner has made in the
       course.
 
-For detailed information about the ways learners can use notes, see
-`Notes <http://edx-guide-for-students.readthedocs.org/en/latest/SFD_notes.html>`_.
+For detailed information about the ways learners can use notes, see `Notes 
+<http://edx.readthedocs.org/projects/open-edx-learner-guide/en/latest/SFD_notes.html>`_.
diff --git a/en_us/shared/running_course/wiki_tasks.rst b/en_us/shared/running_course/wiki_tasks.rst
@@ -2,17 +2,17 @@
 
 .. _Adding a Wiki Article:
 
-********************************
+*********************************
 Adding a Wiki Article
-********************************
-
+*********************************
+  
 When you add an article to the wiki, be aware of what level you are currently
 viewing, to make sure that you add your new article to the correct level in the
 course wiki.
 
 To move down a level in the wiki, click the **See all children** link; to move
-up, click the appropriate level in the wiki breadcrumb trail links at the top of
-the page.
+up, click the appropriate level in the wiki breadcrumb trail links at the top
+of the page.
 
 ===============================
 Add Articles at the Same Level

diff --git a/en_us/shared/students/SFD_mobile.rst b/en_us/shared/students/SFD_mobile.rst
@@ -38,13 +38,21 @@ The edX mobile app is currently available for Android smartphones and iPhones.
 
 .. only:: Partners
 
+    *************************
+    General Questions
+    *************************
+
     .. include:: ../../shared/students/Section_mobile_general.rst
 
 .. The following getting started Q&A applies to the edX mobile app for partners/edx.org only
 .. Alison, DOC-1840, June 2015
 
 .. only:: Partners
 
+    *************************
+    Getting Started
+    *************************
+
     .. include:: ../../shared/students/Section_mobile_gettingstarted.rst
 
 .. _Courseware Questions:
@@ -207,13 +215,21 @@ How do I delete downloaded videos?
 
 .. only:: Open_edX
 
+    **************************
+    Notification Questions
+    **************************
+
     .. include:: ../../shared/students/Section_notification_questions.rst
 
 .. The following section describes the assessment types that appear on devices with the edX mobile app installed
 .. Alison, DOC-1840, June 2015
 
 .. only:: Open_edX
 
+    **************************
+    Completing Assignments
+    **************************
+
     .. include:: ../../shared/students/Section_mobile_assessments.rst
 
 .. _Troubleshooting:

diff --git a/en_us/shared/students/SFD_wiki.rst b/en_us/shared/students/SFD_wiki.rst
@@ -4,11 +4,10 @@
 The Course Wiki
 ########################
 
-Some courses include a wiki, which provides a public forum for both students and
-course staff to access, share, and collaboratively edit information about the
-course. If your course includes a wiki, you access it by selecting the **Wiki**
-tab at the top of any page. (If your course does not include a wiki, you don't
-see this tab.)
+Some courses include a wiki, which provides a public forum for both students
+and course staff to access, share, and collaboratively edit information about
+the course. If your course includes a wiki, you access it by selecting the
+**Wiki** tab at the top of any page. (If your course does not include a wiki, this tab is not present.)
 
 Your course instructor may use the wiki for the following purposes, among
 others:
@@ -30,11 +29,12 @@ that the instructor has set:
   the right side of the page. Note that only course staff can delete articles
   completely.
 * :ref:`Search for wiki articles<Searching for Wiki Articles>`.
-* :ref:`Manage versions of a wiki article<Managing Versions of a Wiki Article>`.
+* :ref:`Manage versions of a wiki article<Managing Versions of a Wiki
+  Article>`.
 
 .. include:: ../../shared/running_course/wiki_tasks.rst 
 
-The wiki for each course is a "child" wiki of the edX-wide wiki. From within any
-course wiki, clicking the top level **Wiki** link in the breadcrumb trail in the
-upper-left corner of the page takes you to the edX-wide wiki. To get back to
-your course wiki, click the **Wiki** tab at the top of the page.
+The wiki for each course is a "child" wiki of the edX-wide wiki. From within
+any course wiki, clicking the top level **Wiki** link in the breadcrumb trail
+in the upper-left corner of the page takes you to the edX-wide wiki. To get
+back to your course wiki, click the **Wiki** tab at the top of the page.
diff --git a/en_us/shared/students/Section_mobile_assessments.rst b/en_us/shared/students/Section_mobile_assessments.rst
@@ -1,9 +1,5 @@
 .. _Assessment Questions:
 
-**************************
-Completing Assignments
-**************************
-
 ==================================================================
 Can I use the edX mobile app to do my homework?
 ==================================================================

diff --git a/en_us/shared/students/Section_mobile_general.rst b/en_us/shared/students/Section_mobile_general.rst
@@ -1,9 +1,5 @@
 .. _General Questions:
 
-*************************
-General Questions
-*************************
-
 ================================
 How do I get the mobile app?
 ================================

diff --git a/en_us/shared/students/Section_mobile_gettingstarted.rst b/en_us/shared/students/Section_mobile_gettingstarted.rst
@@ -1,9 +1,5 @@
 .. _Getting Started:
 
-*************************
-Getting Started
-*************************
-
 ======================================
 Do I need an edX account?
 ======================================

diff --git a/en_us/shared/students/Section_notification_questions.rst b/en_us/shared/students/Section_notification_questions.rst
@@ -1,9 +1,5 @@
 .. _Notification Questions:
 
-**************************
-Notification Questions
-**************************
-
 =========================================================
 Will I get notified about upcoming due dates and exams?
 =========================================================

diff --git a/en_us/students/source/front_matter/change_log.rst b/en_us/students/source/front_matter/change_log.rst
@@ -24,7 +24,11 @@ Change Log
        edX Partner Portal` and the :ref:`The Open edX Portal`.
    * - 20 Jan 15
      - Added iPhone information to :ref:`SFD Mobile`.
-
+   * - 20 Jan 2015
+     - Added iPhone information to :ref:`SFD Mobile`.
+   * - 14 Jan 2015
+     - Added the :ref:`Google Drive` section.
+
 
 **********************
 2014
@@ -36,15 +40,6 @@ Change Log
 
    * - Date
      - Change
-   * - 4 Mar 2015
-     - Updated the :ref:`Preface` to include information about the :ref:`The
-       edX Partner Portal` and the :ref:`The Open edX Portal`.
-   * - 1/27/15
-     - Added :ref:`SFD Search` section.
-   * - 1/20/14
-     - Added iPhone information to :ref:`SFD Mobile`.
-   * - 1/14/15
-     - Added the :ref:`Google Drive` section.
    * - 12/12/14
      - Added :ref:`SFD Mobile` topic.
    * - 8 Dec 14