Merge pull request openedx#692 from edx/carol/doc/BR_restructureDOC2432

DOC: B&R Guide restructuring 2
xuyeli2002 · Nov 20, 2015 · 58c915f · 58c915f
2 parents 0322c14 + f2375dc
commit 58c915f
Show file tree

Hide file tree

Showing 735 changed files with 1,500 additions and 3,188 deletions.
diff --git a/en_us/course_authors/source/building_course/course_files.rst b/en_us/course_authors/source/building_course/course_files.rst
diff --git a/en_us/course_authors/source/building_course/course_rerun.rst b/en_us/course_authors/source/building_course/course_rerun.rst
diff --git a/en_us/course_authors/source/building_course/establish_grading_policy.rst b/en_us/course_authors/source/building_course/establish_grading_policy.rst
diff --git a/en_us/course_authors/source/building_course/export_import_course.rst b/en_us/course_authors/source/building_course/export_import_course.rst
diff --git a/en_us/course_authors/source/building_course/handouts_updates.rst b/en_us/course_authors/source/building_course/handouts_updates.rst
diff --git a/en_us/course_authors/source/building_course/pages.rst b/en_us/course_authors/source/building_course/pages.rst
diff --git a/en_us/course_authors/source/building_course/textbooks.rst b/en_us/course_authors/source/building_course/textbooks.rst
diff --git a/en_us/course_authors/source/cohorts/cohort_config.rst b/en_us/course_authors/source/cohorts/cohort_config.rst
diff --git a/en_us/course_authors/source/cohorts/cohorted_courseware.rst b/en_us/course_authors/source/cohorts/cohorted_courseware.rst
diff --git a/en_us/course_authors/source/cohorts/cohorts_manage_discussions.rst b/en_us/course_authors/source/cohorts/cohorts_manage_discussions.rst
diff --git a/en_us/course_authors/source/cohorts/cohorts_overview.rst b/en_us/course_authors/source/cohorts/cohorts_overview.rst
diff --git a/en_us/course_authors/source/cohorts/cohorts_setup_discussions.rst b/en_us/course_authors/source/cohorts/cohorts_setup_discussions.rst
diff --git a/en_us/course_authors/source/content_experiments/content_experiments_add.rst b/en_us/course_authors/source/content_experiments/content_experiments_add.rst
diff --git a/en_us/course_authors/source/content_experiments/content_experiments_configure.rst b/en_us/course_authors/source/content_experiments/content_experiments_configure.rst
diff --git a/en_us/course_authors/source/content_experiments/content_experiments_overview.rst b/en_us/course_authors/source/content_experiments/content_experiments_overview.rst
diff --git a/en_us/course_authors/source/content_experiments/content_experiments_view.rst b/en_us/course_authors/source/content_experiments/content_experiments_view.rst
diff --git a/en_us/course_authors/source/course_assets/course_files.rst b/en_us/course_authors/source/course_assets/course_files.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_assets/course_files.rst
diff --git a/en_us/course_authors/source/course_assets/course_wiki.rst b/en_us/course_authors/source/course_assets/course_wiki.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_assets/course_wiki.rst
diff --git a/en_us/course_authors/source/course_assets/handouts_updates.rst b/en_us/course_authors/source/course_assets/handouts_updates.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_assets/handouts_updates.rst
diff --git a/..._authors/source/building_course/index.rst → ...se_authors/source/course_assets/index.rst b/..._authors/source/building_course/index.rst → ...se_authors/source/course_assets/index.rst
@@ -1,10 +1,10 @@
-.. _Building Your Course Index:
+.. _Course Assets Index:
 
 ##########################
-Building Your Course
+Course Assets
 ##########################
 
-Use the topics in this section to build your course.
+Use the topics in this section to learn about managing assets in your course.
 
 For information on how to develop your course content in the Studio Outline,
 see :ref:`Developing Your Course Index`.
@@ -16,7 +16,4 @@ see :ref:`Developing Your Course Index`.
    handouts_updates
    pages
    textbooks
-   establish_grading_policy
-   course_rerun
-   export_import_course
-
+   course_wiki
diff --git a/en_us/course_authors/source/course_assets/pages.rst b/en_us/course_authors/source/course_assets/pages.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_assets/pages.rst
diff --git a/en_us/course_authors/source/course_assets/textbooks.rst b/en_us/course_authors/source/course_assets/textbooks.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_assets/textbooks.rst
diff --git a/en_us/course_authors/source/course_components/create_discussion.rst b/en_us/course_authors/source/course_components/create_discussion.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_components/create_discussion.rst
diff --git a/en_us/course_authors/source/course_components/create_html_component.rst b/en_us/course_authors/source/course_components/create_html_component.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_components/create_html_component.rst
diff --git a/en_us/course_authors/source/course_components/create_problem.rst b/en_us/course_authors/source/course_components/create_problem.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_components/create_problem.rst
diff --git a/en_us/course_authors/source/course_components/create_video.rst b/en_us/course_authors/source/course_components/create_video.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_components/create_video.rst
diff --git a/...authors/source/creating_content/index.rst → ...uthors/source/course_components/index.rst b/...authors/source/creating_content/index.rst → ...uthors/source/course_components/index.rst
@@ -1,10 +1,10 @@
-.. _Creating Course Content Index:
+.. _Course Components Index:
 
 ############################
-Creating Course Content
+Adding Course Components
 ############################
 
-Use the sections in this part to understand how to create course content.
+Use the topics in this section to understand how to create course content.
 
 For information on creating exercises and tools, see :ref:`Exercises and Tools
 Index`.
@@ -17,7 +17,7 @@ Outline page, see :ref:`Developing Your Course Index`.
 
 .. toctree::
    :maxdepth: 2
-   
+
    create_html_component
    create_video
    create_discussion

diff --git a/en_us/course_authors/source/course_components/libraries.rst b/en_us/course_authors/source/course_components/libraries.rst
@@ -0,0 +1,2 @@
+.. include:: ../../../shared/course_components/libraries.rst
+
diff --git a/en_us/course_authors/source/course_features/cohorts/cohort_config.rst b/en_us/course_authors/source/course_features/cohorts/cohort_config.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/cohorts/cohort_config.rst
diff --git a/en_us/course_authors/source/course_features/cohorts/cohorted_courseware.rst b/en_us/course_authors/source/course_features/cohorts/cohorted_courseware.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/cohorts/cohorted_courseware.rst
diff --git a/en_us/course_authors/source/course_features/cohorts/cohorts_manage_discussions.rst b/en_us/course_authors/source/course_features/cohorts/cohorts_manage_discussions.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/cohorts/cohorts_manage_discussions.rst
diff --git a/en_us/course_authors/source/course_features/cohorts/cohorts_overview.rst b/en_us/course_authors/source/course_features/cohorts/cohorts_overview.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/cohorts/cohorts_overview.rst
diff --git a/en_us/course_authors/source/course_features/cohorts/cohorts_setup_discussions.rst b/en_us/course_authors/source/course_features/cohorts/cohorts_setup_discussions.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/cohorts/cohorts_setup_discussions.rst
diff --git a/...s/course_authors/source/cohorts/index.rst → .../source/course_features/cohorts/index.rst b/...s/course_authors/source/cohorts/index.rst → .../source/course_features/cohorts/index.rst
diff --git a/..._authors/source/course_features/content_experiments/content_experiments_add.rst b/..._authors/source/course_features/content_experiments/content_experiments_add.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/content_experiments/content_experiments_add.rst
diff --git a/...rs/source/course_features/content_experiments/content_experiments_configure.rst b/...rs/source/course_features/content_experiments/content_experiments_configure.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/course_features/content_experiments/content_experiments_configure.rst
diff --git a/...ors/source/course_features/content_experiments/content_experiments_overview.rst b/...ors/source/course_features/content_experiments/content_experiments_overview.rst
@@ -0,0 +1,3 @@
+.. reference shared file used by CA and OLX
+
+.. include:: ../../../../shared/course_features/content_experiments/content_experiments_overview.rst
diff --git a/...authors/source/course_features/content_experiments/content_experiments_view.rst b/...authors/source/course_features/content_experiments/content_experiments_view.rst
@@ -0,0 +1,3 @@
+.. reference shared file used by CA and OLX
+
+.. include:: ../../../../shared/course_features/content_experiments/content_experiments_test.rst
diff --git a/...hors/source/content_experiments/index.rst → ...se_features/content_experiments/index.rst b/...hors/source/content_experiments/index.rst → ...se_features/content_experiments/index.rst
diff --git a/..._course/credit_courses/credit_courses.rst → ...eatures/credit_courses/credit_courses.rst b/..._course/credit_courses/credit_courses.rst → ...eatures/credit_courses/credit_courses.rst
diff --git a/...edit_courses/in_course_reverification.rst → ...edit_courses/in_course_reverification.rst b/...edit_courses/in_course_reverification.rst → ...edit_courses/in_course_reverification.rst
@@ -8,7 +8,7 @@ To use in-course identity reverification, you must enable reverification in
 your course, create specific verification checkpoints, and then set
 assessments to require verification.
 
-.. contents:: 
+.. contents::
  :local:
  :depth: 1
 
@@ -26,7 +26,7 @@ steps.
    brackets (``[ ]``), and then add ``"edx-reverification-block"``. Make sure
    to include the quotation marks.
 
-   .. note:: If the **Advanced Module List** field already contains one or 
+   .. note:: If the **Advanced Module List** field already contains one or
     more items, add a comma after the closing quotation mark for the last
     item, and then add ``"edx-reverification-block"``. You do not have to
     include a space between the items. The field should resemble the following
@@ -55,7 +55,7 @@ reverification.
    If the subsection already contains one or more units, move the new unit so
    that it is the first unit in the subsection.
 
-#. In the new unit, locate **Add New Component**, and then select **Advanced**. 
+#. In the new unit, locate **Add New Component**, and then select **Advanced**.
 
 #. Select **Verification Checkpoint**, and then select **Edit**.
 
@@ -83,7 +83,7 @@ Set an Assessment to Require Verification
 *********************************************************
 
 After you create a verification checkpoint in an assessment, you set the
-components and units in that assessment to require verification. 
+components and units in that assessment to require verification.
 
 When a component or unit requires verification, the content in that component
 or unit is invisible to learners until the learners pass the verification
@@ -107,7 +107,7 @@ following information in mind.
   that unit are visible by default. However, you can set individual components
   to require verification.
 
-.. important:: Do not set the unit that contains the verification 
+.. important:: Do not set the unit that contains the verification
  checkpoint component, or the verification component itself, to require
  verification. If you do this, learners cannot access the verification
  checkpoint.
@@ -126,7 +126,7 @@ To set a component to require verification, access the component visibility
 settings for the component, and then select the verification checkpoint that
 you want from the list.
 
-.. important:: Do not set the verification checkpoint component itself 
+.. important:: Do not set the verification checkpoint component itself
  to require verification. If you do this, learners cannot access the
  verification checkpoint.
 
@@ -137,7 +137,7 @@ you want from the list.
 #. Under **Make visible to**, select **Specific Content Groups**, and then
    select the verification checkpoint that you want.
 
-   .. image:: ../Images/ICRV_CompSettings.png
+   .. image:: ../../../../shared/Images/ICRV_CompSettings.png
     :width: 250
     :alt: The settings editor for a component, showing the list of
       verification checkpoints.
@@ -153,7 +153,7 @@ Require Verification for a Unit
 To set a unit to require verification, access the unit settings, and then
 select the verification checkpoint that you want from the list.
 
-.. important:: Do not set the unit that contains the verification 
+.. important:: Do not set the unit that contains the verification
  checkpoint to require verification. If you do this, learners cannot access
  any of the content in the unit, including the verification checkpoint.
 
@@ -164,7 +164,7 @@ select the verification checkpoint that you want from the list.
 #. Under **Verification Checkpoint**, select the name of the verification
    checkpoint that you want.
 
-   .. image:: ../Images/ICRV_UnitSettings.png
+   .. image:: ../../../../shared/Images/ICRV_UnitSettings.png
     :width: 250
     :alt: The settings editor for a unit, showing the list of verification
       checkpoints.
@@ -198,7 +198,7 @@ To create this assessment, you would follow these steps.
 
 #. Create a new unit. Do not change the unit settings.
 #. Create one component for the introductory text, and enter your text in the
-   component. 
+   component.
 #. Below the introductory text component, create the verification checkpoint
    component.
 #. Below the verification checkpoint component, create a component for the
@@ -218,15 +218,15 @@ When learners arrive at the assessment in the courseware, the introductory
 text and the verification checkpoint are visible. The assessment content in
 the third component in the unit is not visible.
 
-.. image:: ../Images/ICRV_Checkpoint.png
+.. image:: ../../../../shared/Images/ICRV_Checkpoint.png
  :width: 500
  :alt: A verification checkpoint showing a message that the learner must
      perform identity verification.
 
 After learners pass the checkpoint, a message indicates that they can now
 access assessment content, and the assessment content is visible.
 
-.. image:: ../Images/ICRV_Checkpoint_Passed.png
+.. image:: ../../../../shared/Images/ICRV_Checkpoint_Passed.png
  :width: 500
  :alt: A verification checkpoint showing a message that the learner can
      continue to the assessment.
@@ -240,7 +240,7 @@ Additionally, learners who must complete in-course reverification see the
 verification checkpoints for their course in the list of course credit
 requirements on their **Progress** pages.
 
-.. image:: ../Images/SFD_Credit_ReqList.png
+.. image:: ../../../../shared/Images/SFD_Credit_ReqList.png
  :width: 350
  :alt: Learner's Progress page with a list of credit requirements below the
      progress graph.

diff --git a/.../building_course/credit_courses/index.rst → .../course_features/credit_courses/index.rst b/.../building_course/credit_courses/index.rst → .../course_features/credit_courses/index.rst
diff --git a/...rses/online_proctoring_rules_students.rst → ...rses/online_proctoring_rules_students.rst b/...rses/online_proctoring_rules_students.rst → ...rses/online_proctoring_rules_students.rst
diff --git a/...course/credit_courses/proctored_exams.rst → ...atures/credit_courses/proctored_exams.rst b/...course/credit_courses/proctored_exams.rst → ...atures/credit_courses/proctored_exams.rst
@@ -265,7 +265,7 @@ To enable proctored exams in your course, follow these steps.
 
 #. Change the value of the setting to ``true``.
 
-   .. image:: ../../../../shared/building_and_running_chapters/Images/Proctoring_AdvancedSetting.png
+   .. image:: ../../../../shared/Images/Proctoring_AdvancedSetting.png
       :alt: The "Enable Timed and Proctored Exams" advanced setting with a value of "true".
       :width: 500
 
@@ -299,7 +299,7 @@ To create an exam that includes online proctoring, follow these steps.
 
 #. Specify the allotted time for the exam in hours and minutes.
 
-   .. image:: ../../../../shared/building_and_running_chapters/Images/Proctoring_StudioSetProctoredExam.png
+   .. image:: ../../../../shared/Images/Proctoring_StudioSetProctoredExam.png
      :alt: The Studio subsection settings dialog showing selections for a timed
          and proctored final exam.
      :width: 600
@@ -358,7 +358,7 @@ To create a practice exam, follow these steps.
    duration that is appropriate for the number of example problems you
    include.
 
-   .. image:: ../../../../shared/building_and_running_chapters/Images/Proctoring_StudioSetPracticeExam.png
+   .. image:: ../../../../shared/Images/Proctoring_StudioSetPracticeExam.png
      :alt: The Studio subsection settings dialog, showing settings for an ungraded practice proctored exam.
      :width: 600
 
@@ -542,7 +542,7 @@ steps.
 
 #. Select **Generate Proctored Exam Results Report**.
 
-   .. image:: ../../../../shared/building_and_running_chapters/Images/Proctoring_GenerateCSVExamResults.png
+   .. image:: ../../../../shared/Images/Proctoring_GenerateCSVExamResults.png
      :alt: The "Generate Proctored Exam Results Report" button in the LMS.
      :width: 400
 
@@ -562,7 +562,7 @@ steps.
 #. To open or save a report file, locate and click the link for the report you
    requested.
 
-   .. image:: ../../../../shared/building_and_running_chapters/Images/Proctoring_CSVExamResultsLink.png
+   .. image:: ../../../../shared/Images/Proctoring_CSVExamResultsLink.png
      :alt: The link for a generated proctored exam results report in the instructor dashboard.
      :width: 600
 

diff --git a/en_us/course_authors/source/course_features/index.rst b/en_us/course_authors/source/course_features/index.rst
@@ -0,0 +1,18 @@
+.. _Course Features Index:
+
+#################################
+Choosing Features For Your Course
+#################################
+
+Use the topics in this section to learn about features you can use in your course.
+
+For information on how to develop your course content in the Studio Outline,
+see :ref:`Developing Your Course Index`.
+
+.. toctree::
+   :maxdepth: 2
+
+   cohorts/index
+   content_experiments/index
+   credit_courses/index
+   timed_exams
diff --git a/en_us/course_authors/source/course_features/timed_exams.rst b/en_us/course_authors/source/course_features/timed_exams.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/course_features/timed_exams.rst
diff --git a/en_us/course_authors/source/creating_content/create_discussion.rst b/en_us/course_authors/source/creating_content/create_discussion.rst
diff --git a/en_us/course_authors/source/creating_content/create_html_component.rst b/en_us/course_authors/source/creating_content/create_html_component.rst
diff --git a/en_us/course_authors/source/creating_content/create_problem.rst b/en_us/course_authors/source/creating_content/create_problem.rst
diff --git a/en_us/course_authors/source/creating_content/create_video.rst b/en_us/course_authors/source/creating_content/create_video.rst
diff --git a/en_us/course_authors/source/creating_content/libraries.rst b/en_us/course_authors/source/creating_content/libraries.rst
diff --git a/en_us/course_authors/source/developing_course/controlling_content_visibility.rst b/en_us/course_authors/source/developing_course/controlling_content_visibility.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/controlling_content_visibility.rst
+.. include:: ../../../shared/developing_course/controlling_content_visibility.rst
diff --git a/en_us/course_authors/source/developing_course/course_components.rst b/en_us/course_authors/source/developing_course/course_components.rst
@@ -1,2 +1,2 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/course_components.rst
+.. include:: ../../../shared/developing_course/course_components.rst
 
diff --git a/en_us/course_authors/source/developing_course/course_outline.rst b/en_us/course_authors/source/developing_course/course_outline.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/course_outline.rst
+.. include:: ../../../shared/developing_course/course_outline.rst
diff --git a/en_us/course_authors/source/developing_course/course_sections.rst b/en_us/course_authors/source/developing_course/course_sections.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/course_sections.rst
+.. include:: ../../../shared/developing_course/course_sections.rst
diff --git a/en_us/course_authors/source/developing_course/course_subsections.rst b/en_us/course_authors/source/developing_course/course_subsections.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/course_subsections.rst
+.. include:: ../../../shared/developing_course/course_subsections.rst
diff --git a/en_us/course_authors/source/developing_course/course_units.rst b/en_us/course_authors/source/developing_course/course_units.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/course_units.rst
+.. include:: ../../../shared/developing_course/course_units.rst
diff --git a/en_us/course_authors/source/developing_course/index.rst b/en_us/course_authors/source/developing_course/index.rst
@@ -4,7 +4,7 @@
 Developing Your Course
 ##########################
 
-Use the chapters in this section to understand how to develop your course
+Use the topics in this section to understand how to develop your course
 content in the Studio Outline page.
 
 For information on building specific course component types, see :ref:`Creating
@@ -18,13 +18,12 @@ content for randomized assigments, see :ref:`Content Libraries`.
 
 .. toctree::
    :maxdepth: 2
-   
+
    workflow
    course_outline
    course_sections
    course_subsections
-   timed_exams
    course_units
    course_components
    controlling_content_visibility
-   testing_courseware
+   testing_courseware
diff --git a/en_us/course_authors/source/developing_course/testing_courseware.rst b/en_us/course_authors/source/developing_course/testing_courseware.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/testing_courseware.rst
+.. include:: ../../../shared/developing_course/testing_courseware.rst
diff --git a/en_us/course_authors/source/developing_course/timed_exams.rst b/en_us/course_authors/source/developing_course/timed_exams.rst
diff --git a/en_us/course_authors/source/developing_course/workflow.rst b/en_us/course_authors/source/developing_course/workflow.rst
@@ -1 +1 @@
-.. include:: ../../../shared/building_and_running_chapters/developing_course/workflow.rst
+.. include:: ../../../shared/developing_course/workflow.rst
diff --git a/en_us/course_authors/source/edit_course/export_import_course.rst b/en_us/course_authors/source/edit_course/export_import_course.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/edit_course/export_import_course.rst
diff --git a/en_us/course_authors/source/edit_course/index.rst b/en_us/course_authors/source/edit_course/index.rst
@@ -0,0 +1,15 @@
+.. _Edit Course Index:
+
+##########################
+Editing Your Course
+##########################
+
+Use the topics in this section to learn about editing your course.
+
+For information on how to develop your course content in the Studio Outline,
+see :ref:`Developing Your Course Index`.
+
+.. toctree::
+   :maxdepth: 2
+
+   export_import_course