diff --git a/en_us/open_edx_course_authors/Makefile b/en_us/open_edx_course_authors/Makefile new file mode 100644 index 0000000000..7a4baa06c4 --- /dev/null +++ b/en_us/open_edx_course_authors/Makefile @@ -0,0 +1,183 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= +BUILDDIR ?= build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +Q_FLAG = + +ifeq ($(quiet), true) +Q_FLAG = -Q +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/en_us/open_edx_course_authors/__init__.py b/en_us/open_edx_course_authors/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/en_us/open_edx_course_authors/source/Format Cheat Sheet.rstnouse b/en_us/open_edx_course_authors/source/Format Cheat Sheet.rstnouse new file mode 100644 index 0000000000..f49b1a73bd --- /dev/null +++ b/en_us/open_edx_course_authors/source/Format Cheat Sheet.rstnouse @@ -0,0 +1,152 @@ +################## +Format cheat sheet +################## + +Title: # above and below (as lines 1 and 3 above) + +********* +Heading 1 +********* + +========= +Heading 2 +========= + +Heading 3 +********* + +Heading 4 +========= + +Heading 5 +^^^^^^^^^ + +************ +Image Format +************ + +Image format, uses images as a reference from the soure/image file + + .. image:: images/image029.png + : width: 800 + + .. image:: images/image009.png + :width: 800 + +**************** +Code Formatting +**************** + +To set text in a "Code format" + :: +-or- + +.. code-block:: xml + +(text in code-block:: xml is in different colors) + +**************** +Table Formatting +**************** + +With a header row + +.. list-table:: + :widths: 15 15 70 + :header-rows: 1 + + * - First Name + - Last Name + - Residence + * - Elizabeth + - Bennett + - Longbourne + * - Fitzwilliam + - Darcy + - Pemberley + +-- or -- + +With a bolded first column + +.. list-table:: + :widths: 15 15 70 + :stub-columns: 1 + + * - First Name + - Elizabeth + - Fitzwilliam + * - Last Name + - Bennett + - Darcy + * - Residence + - Longboure + - Pemberley + +******************* +Cross-References +******************* + +For references to edX101 pages: + + `Writing Exercises `_ has more in-depth discussion about problem types, and some general pedagogical considerations for adapting to the online format and a `Gallery of Response Types `_ + +To cross reference between sections of a document + +At the paragraph you are cross referencing: + + . _Set-Grade-Brackets: + +To make the cross reference in text: + + see :ref:`Set Grade Brackets` + +To cross-reference a topic, but use your own text instead of the topic title, +use the :ref: directive, but enter your own text followed by the topic anchor in +angle brackets: + + If you want to add a graded tool or exercise, add the tool as a + :ref:`custom JavaScript problem` or an :ref:`LTI + component`. + + (In this sentence, the text appears as "custom JavaScript problem" and + "LTI component", and the linked-to topic titles are "Custom JavaScript + Problem" and "LTI Component".) + +External page reference + + see `Create a Problem `_ + + +******* +Tables +******* + +Example of a table with a cell that includes a bulleted list. The balnk lines before and after are critical. + +.. list-table:: + :widths: 15 15 60 + :header-rows: 1 + + * - Field + - Type + - Details + * - ``correct_map`` + - dict + - For each problem ID value listed by ``answers``, provides: + + * ``correctness``: string; 'correct', 'incorrect' + * ``hint``: string; Gives optional hint. Nulls allowed. + * ``hintmode``: string; None, 'on_request', 'always'. Nulls allowed. + * ``msg``: string; Gives extra message response. + * ``npoints``: integer; Points awarded for this ``answer_id``. Nulls allowed. + * ``queuestate``: dict; None when not queued, else ``{key:'', time:''}`` + where ``key`` is a secret string dump of a DateTime object in the form + '%Y%m%d%H%M%S'. Nulls allowed. + + * - ``grade`` + - integer + - Current grade value. + * - ``max_grade`` + - integer + - Maximum possible grade value. \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/building_course/course_files.rst b/en_us/open_edx_course_authors/source/building_course/course_files.rst new file mode 100644 index 0000000000..490e3956d9 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/course_files.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/course_files.rst diff --git a/en_us/open_edx_course_authors/source/building_course/course_rerun.rst b/en_us/open_edx_course_authors/source/building_course/course_rerun.rst new file mode 100644 index 0000000000..5eaadf4cf3 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/course_rerun.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/course_rerun.rst diff --git a/en_us/open_edx_course_authors/source/building_course/creating_new_course.rst b/en_us/open_edx_course_authors/source/building_course/creating_new_course.rst new file mode 100644 index 0000000000..d9f584001b --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/creating_new_course.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/creating_new_course.rst diff --git a/en_us/open_edx_course_authors/source/building_course/establish_grading_policy.rst b/en_us/open_edx_course_authors/source/building_course/establish_grading_policy.rst new file mode 100644 index 0000000000..d45a1c54f6 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/establish_grading_policy.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/establish_grading_policy.rst diff --git a/en_us/open_edx_course_authors/source/building_course/export_import_course.rst b/en_us/open_edx_course_authors/source/building_course/export_import_course.rst new file mode 100644 index 0000000000..8dd2dc5772 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/export_import_course.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/export_import_course.rst diff --git a/en_us/open_edx_course_authors/source/building_course/handouts_updates.rst b/en_us/open_edx_course_authors/source/building_course/handouts_updates.rst new file mode 100644 index 0000000000..2dcf8be121 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/handouts_updates.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/handouts_updates.rst diff --git a/en_us/open_edx_course_authors/source/building_course/index.rst b/en_us/open_edx_course_authors/source/building_course/index.rst new file mode 100644 index 0000000000..6488b3fd3a --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/index.rst @@ -0,0 +1,23 @@ +.. _Setting up Your Course Index: + +########################## +Setting up Your Course +########################## + +Use the chapters in this section to create and build your course. + +For information on how to develop your course content in the Studio Outline +page, see :ref:`Developing Your Course Index`. + +.. toctree:: + :maxdepth: 2 + + creating_new_course + provide_overview + course_files + handouts_updates + pages + textbooks + establish_grading_policy + course_rerun + export_import_course diff --git a/en_us/open_edx_course_authors/source/building_course/pages.rst b/en_us/open_edx_course_authors/source/building_course/pages.rst new file mode 100644 index 0000000000..bf636a2119 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/pages.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/pages.rst diff --git a/en_us/open_edx_course_authors/source/building_course/provide_overview.rst b/en_us/open_edx_course_authors/source/building_course/provide_overview.rst new file mode 100644 index 0000000000..d0fc363f70 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/provide_overview.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/provide_overview.rst diff --git a/en_us/open_edx_course_authors/source/building_course/textbooks.rst b/en_us/open_edx_course_authors/source/building_course/textbooks.rst new file mode 100644 index 0000000000..fa4324d528 --- /dev/null +++ b/en_us/open_edx_course_authors/source/building_course/textbooks.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/building_course/textbooks.rst diff --git a/en_us/open_edx_course_authors/source/change_log.rst b/en_us/open_edx_course_authors/source/change_log.rst new file mode 100644 index 0000000000..c8e5279bdf --- /dev/null +++ b/en_us/open_edx_course_authors/source/change_log.rst @@ -0,0 +1,17 @@ +############ +Change Log +############ + +***************** +February 2015 +***************** + +.. list-table:: + :widths: 10 70 + :header-rows: 1 + + * - Date + - Change + * - 24 Feb 2015 + - Initial release of document for the Open edX Birch release. + \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/cohorts/cohort_config.rst b/en_us/open_edx_course_authors/source/cohorts/cohort_config.rst new file mode 100644 index 0000000000..223e7be4eb --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/cohort_config.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/cohorts/cohort_config.rst diff --git a/en_us/open_edx_course_authors/source/cohorts/cohorted_courseware.rst b/en_us/open_edx_course_authors/source/cohorts/cohorted_courseware.rst new file mode 100644 index 0000000000..e357b841c2 --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/cohorted_courseware.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/cohorts/cohorted_courseware.rst diff --git a/en_us/open_edx_course_authors/source/cohorts/cohorts_manage_discussions.rst b/en_us/open_edx_course_authors/source/cohorts/cohorts_manage_discussions.rst new file mode 100644 index 0000000000..70e3039a18 --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/cohorts_manage_discussions.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/cohorts/cohorts_manage_discussions.rst diff --git a/en_us/open_edx_course_authors/source/cohorts/cohorts_overview.rst b/en_us/open_edx_course_authors/source/cohorts/cohorts_overview.rst new file mode 100644 index 0000000000..49dcfd07e9 --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/cohorts_overview.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/cohorts/cohorts_overview.rst diff --git a/en_us/open_edx_course_authors/source/cohorts/cohorts_setup_discussions.rst b/en_us/open_edx_course_authors/source/cohorts/cohorts_setup_discussions.rst new file mode 100644 index 0000000000..b98a12b80d --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/cohorts_setup_discussions.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/cohorts/cohorts_setup_discussions.rst diff --git a/en_us/open_edx_course_authors/source/cohorts/index.rst b/en_us/open_edx_course_authors/source/cohorts/index.rst new file mode 100644 index 0000000000..cb7fd73050 --- /dev/null +++ b/en_us/open_edx_course_authors/source/cohorts/index.rst @@ -0,0 +1,15 @@ +.. _Including Student Cohorts: + +############################# +Including Student Cohorts +############################# + +.. toctree:: + :maxdepth: 2 + + cohorts_overview + cohort_config + cohorted_courseware + cohorts_setup_discussions + cohorts_manage_discussions + \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/conf.py b/en_us/open_edx_course_authors/source/conf.py new file mode 100644 index 0000000000..9dd4716a69 --- /dev/null +++ b/en_us/open_edx_course_authors/source/conf.py @@ -0,0 +1,62 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +master_doc = 'index' + +# The suffix of source filenames. +source_suffix = '.rst' + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# Add any paths that contain templates here, relative to this directory. +#templates_path.append('source/_templates') + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path.append('source/_static') + + +# General information about the project. +project = u'Building and Running an Open edX Course' +copyright = u'2015, edX' + +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# html_theme = 'default' +html_theme = 'edx_theme' + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] +html_theme_path = ['../../_themes'] + +html_favicon = '../../_themes/edx_theme/static/css/favicon.ico' + +#html_use_smartypants = True +html_use_smartypants = True + +if on_rtd: + html_context = { + "on_rtd" : on_rtd, + "google_analytics_id" : '', + "disqus_shortname" : 'edx', + "github_base_account" : 'edx', + "github_project" : 'edx-documentation', + } \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/content_experiments/content_experiments_add.rst b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_add.rst new file mode 100644 index 0000000000..8a1d331caa --- /dev/null +++ b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_add.rst @@ -0,0 +1,149 @@ +.. _Add Content Experiments to Your Course: + +######################################### +Add Content Experiments to Your Course +######################################### + +After you :ref:`enable content experiments ` and +:ref:`set up group configurations in Studio `, you +can add content experiments to your course. See: + +* :ref:`Add a Content Experiment in Studio` +* :ref:`Add a Content Experiment in OLX` + +.. _Add a Content Experiment in Studio: + +******************************************** +Add a Content Experiment in Studio +******************************************** + +You can add a content experiment in a unit or container page. In Studio, you +create and view content for all groups in the content experiment in a container +page for the experiment, as shown in `Create Content for Groups in the Content +Experiment`_. + +When a student views the unit with the content experiment, she has no +indication there is a content experiment in the unit, and the content +experiment display name is not shown. She sees only the content that you +configure for the group she is assigned to. To the student, the unit with the +content experiment is no different than any other unit. + +To configure a content experiment in Studio, you: + +#. `Create the content experiment`_. +#. `Create content for groups in the content experiment`_. + +After you configure a content experiment, you can change its group +configuration. See `Change the Group Configuration for a Content Experiment`_. + +=============================== +Create the Content Experiment +=============================== + +#. In the unit page, under **Add New Component**, click **Advanced**. + +#. Select **Content Experiment**. + + A new content experiment is added to the unit: + + .. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_block.png + :width: 800 + :alt: The content experiment component in a unit page + + You can work with the content experiment as you can any other component. + See :ref:`Developing Course Components` for more information. + +#. Click either **Select a Group Configuration** or **Edit** to open the content + experiment component. + + .. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_editor.png + :alt: The content experiment editor + +#. Next to **Group Configuration**, select a group configuration. + +#. In the **Display Name** field, enter the name that the component will use in Studio. The + display name is only used in Studio; students do not see this value. + +#. Click **Save**. + +The content experiment is displayed as a component that contains other +components. See :ref:`Components that Contain Other Components` for more +information. + +.. note:: You cannot duplicate a content experiment. + +You can now create content for the groups in the experiment. + +===================================================== +Create Content for Groups in the Content Experiment +===================================================== + +After you select a group configuration, in the content experiment component, +click **View**. + +The content experiment page that opens automatically includes a container for +each group that is defined in the group configuration you selected. For +example, if you select a group configuration that defines Group A and Group B, +you see the following page: + +.. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_container.png + :alt: The content experiment page with two groups + +You add content for both groups as needed, just as you would add content to any +container page. See :ref:`Components that Contain Other Components` for more +information. + +For example, you can add an HTML component and a video to Group A: + +.. image:: ../../../shared/building_and_running_chapters/Images/a_b_test_child_expanded.png + :alt: Image of an expanded A/B test component + +.. note:: + It is valid, and can be useful, to have no content for a group in the + experiment. For example, if one group has a video and another group has no + content, you can analyze the effect of the video on student performance. + + +======================================================== +Change the Group Configuration for a Content Experiment +======================================================== + +You can change the group configuration for a content experiment. When you +change the group configuration, you must add components to any new groups that you create. You +can use the components from the previous groups, as well as create new +components. + +.. warning:: + Changing the group configuration of a student-visible experiment will affect + the experiment data. + +To change the group configuration: + +#. Open the unit page of the unit that contains the content experiment. + +#. In the content experiment component, click **Edit**. + + .. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_editor_group2.png + :alt: The content experiment editor with a group configuration selected + +#. Select a different group configuration. + +#. Click **Save**. + +#. You must now add components to the new groups in the experiment. Click + **View** to open the content experiment. + + You see that groups for the new configuration are empty, and any components + that you had added to groups in the previous configuration are now moved to + a section called **Inactive Groups**. + + .. image:: ../../../shared/building_and_running_chapters/Images/inactive_groups.png + :alt: Components in inactive groups + +#. Drag and drop components from the **Inactive Groups** section into the new + groups. You can also create new components in the new groups. + +.. import OLX-content experiment doc that's shared in OLX guide. + +.. include:: ../../../shared/subsections/content_experiments/content_experiments_OLX.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/content_experiments/content_experiments_configure.rst b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_configure.rst new file mode 100644 index 0000000000..ad12d34611 --- /dev/null +++ b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_configure.rst @@ -0,0 +1,266 @@ +.. _Configure Your Course for Content Experiments: + +##################################################### +Configure Your Course for Content Experiments +##################################################### + +This chapter describes how to configure your course so that you can use content +experiments. See: + +* :ref:`Enable Content Experiments` +* :ref:`Overview of Group Configurations` +* :ref:`Set up Group Configurations in edX Studio` +* :ref:`Guidelines for Modifying Group Configurations` +* :ref:`Set Up Group Configuration for OLX Courses` + +.. _Enable Content Experiments: + +**************************************** +Enable Content Experiments +**************************************** + +To enable content experiments in your course, you add ``split_test`` to the +**Advanced Modules List** in Advanced Settings. + +.. note:: + ``split_test`` is the internal edX Platform name for a content experiment. + +#. From the **Settings** menu, select **Advanced Settings**. + +#. On the **Advanced Settings** page, locate **Advanced Modules List**. + +#. In the **Advanced Modules List** field, add ``"split_test"``. Be sure that + you include the double quotation marks. + + If you have multiple values, ensure that they are separated by commas + (``,``). + + For example, the text in the **Advanced Modules List** field may resemble + the following: + + .. code-block:: json + + [ + "lti", + "word_cloud", + "split_test" + ] + +#. At the bottom of the page, click **Save Changes**. + +.. _Overview of Group Configurations: + +**************************************** +Overview of Group Configurations +**************************************** + +Before you can create content experiments, you must specify at least one group +configuration for your course. + +A group configuration defines how many groups of students are in an experiment. +You can have any number of group configurations in your course. When you create +a content experiment, you select the group configuration to use. + +For example, you may want to do two different experiments at different times +during your course. In one content experiment, students either see a video or +complete a reading assignment. You can then include problems so that you can +see which group learned the material more completely. For this content +experiment, you need a group configuration that assigns your students to two +experiment groups. + +In the other content experiment, you can present the same question using four +different types of problems. For this content experiment, you need a +group configuration that assigns your students to four experiment groups. + +======================================= +Assigning Students to Experiment Groups +======================================= + +The edX Platform assigns students to each experiment group in a group +configuration. + +Experiment group assignments are: + +* Dynamic + + The edX Platform assigns a student to an experiment group the first time he or + she views a content experiment that uses the group configuration. + +* Random + + You cannot control which students are assigned to which experiment group. + +* Evenly distributed + + The edX Platform keeps track of the size of experiment groups, and assigns new + students to groups evenly. For example, if you have two experiment groups in a + configuration, each group includes 50% of the students in the course; if you + have four experiment groups, each group includes 25% of the students. + +* Permanent + + Students remain in their assigned experiment groups regardless of how many + content experiments you set up that use the same group configuration. + + +.. _Set up Group Configurations in edX Studio: + +************************************************ +Set up Group Configurations in edX Studio +************************************************ + +.. note:: + You must :ref:`enable content experiments` before + you can set up group configurations. + +To set up group configurations, on the **Settings** menu, select **Group +Configurations**. The **Group Configurations** page opens. + +From this page you can :ref:`create`, +:ref:`edit`, and :ref:`delete` group configurations. You can also :ref:`view experiments that +use a group configuration`. + +.. _Create a Group Configuration: + +============================= +Create a Group Configuration +============================= + +You can create a group configuration at any time. + +#. On the **Group Configurations** page, under **Experiment Groups**, click + **New Experiment Group**. The following page opens: + + .. image:: ../../../shared/building_and_running_chapters/Images/create-group-config.png + :width: 800 + :alt: Create a New Group Configuration page + +2. Enter a name in the **Group Configuration Name** field. Use a meaningful +name, because you will select from group configuration names when you create +content experiments. Students do not see the group configuration name. + +#. Optionally, enter a description for the new group configuration. + +#. By default, a new configuration already contains two groups. Modify the + groups or add and delete groups as needed. A group configuration must have at + least one group. + + * Modify group names as needed. You see group names in the unit page in + Studio, but group names are not visible to students. + * Click **Add another group** to include another group as part of + the configuration. + * Click the **X** to the right of an existing group to remove it from the + configuration. A group configuration must have at least one group. + +5. Click **Create** to save the new group configuration. + +The group configuration is then listed in the page. You can see the number of +groups that the configuration contains, as well as whether the configuration is +in use in the course: + +.. image:: ../../../shared/building_and_running_chapters/Images/group_configurations_one_listed.png + :width: 800 + :alt: The Group Configurations page with one group configuration + + + +.. _Edit a Group Configuration: + +============================= +Edit a Group Configuration +============================= + +.. important:: You can change the name of a group configuration at any time. + However, before you modify any other characteristics of a group configuration + that is currently used in a running course, review `Guidelines for Modifying + Group Configurations`_. + +#. On the **Group Configurations** page, hover over the group configuration and + click **Edit**. + + .. image:: ../../../shared/building_and_running_chapters/Images/group_configurations_edit.png + :alt: The Group Configurations page with Edit button + + The following page opens: + + .. image:: ../../../shared/building_and_running_chapters/Images/save-group-config.png + :alt: Edit a Group Configuration page + +#. Modify the name and description as needed. + +#. Modify groups in the configuration as needed. See `Create a Group + Configuration`_ for details. + +#. Click **Save** to save your changes. + +.. _Delete a Group Configuration: + +============================= +Delete a Group Configuration +============================= + +.. note:: + You can only delete a group configuration that is not currently used in a + content experiment. You cannot delete a group configuration that is used in a + content experiment. + +#. On the **Group Configurations** page, hover over the group configuration and + click the Delete icon. + + .. image:: ../../../shared/building_and_running_chapters/Images/group-configuration-delete.png + :alt: Edit a Group Configuration page + +2. When prompted to confirm the deletion, click **Delete**. + + +.. _View Experiments that Use a Group Configuration: + +=============================================== +View Experiments that Use a Group Configuration +=============================================== + +You can view the experiments that use each of your group configurations. + +On the **Group Configurations** page, click the name of a group to see its +details. You see links to experiments that use the group configuration: + +.. image:: ../../../shared/building_and_running_chapters/Images/group_configurations_experiments.png + :alt: A group configuration with the experiments using it circled + +Click a link to go to the unit page that contains the experiment. + + +=============================================== +View a Group Configuration from an Experiment +=============================================== + +When working with a content experiment, you can view details about the group +configuration used by that experiment in two ways: + +* In a unit that contains a content experiment, in the content experiment block, + click the name of the group configuration. + +.. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_group_config_link.png + :alt: Content experiment in the unit page with the group configuration link + circled + +* At the top of the content experiment page, click the name of the group + configuration. + +.. image:: ../../../shared/building_and_running_chapters/Images/content_experiment_page_group_config_link.png + :alt: Content experiment page with the group configuration link circled + +In both cases, the group configuration opens: + +.. image:: ../../../shared/building_and_running_chapters/Images/group_configurations_experiments.png + :alt: A Group Configuration with the experiments using it circled + +You can use the link in the group configuration to return to the unit that +contains the content experiment. + +.. import OLX-content experiment doc that's shared in OLX guide. + +.. include:: ../../../shared/subsections/content_experiments/content_experiments_group_modify_guidelines.rst + +.. include:: ../../../shared/subsections/content_experiments/content_experiments_policies.rst diff --git a/en_us/open_edx_course_authors/source/content_experiments/content_experiments_overview.rst b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_overview.rst new file mode 100644 index 0000000000..a3dc20daac --- /dev/null +++ b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_overview.rst @@ -0,0 +1,3 @@ +.. reference shared file used by CA and OLX + +.. include:: ../../../shared/subsections/content_experiments/content_experiments_overview.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/content_experiments/content_experiments_view.rst b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_view.rst new file mode 100644 index 0000000000..7167ca5ad3 --- /dev/null +++ b/en_us/open_edx_course_authors/source/content_experiments/content_experiments_view.rst @@ -0,0 +1,3 @@ +.. reference shared file used by CA and OLX + +.. include:: ../../../shared/subsections/content_experiments/content_experiments_test.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/content_experiments/index.rst b/en_us/open_edx_course_authors/source/content_experiments/index.rst new file mode 100644 index 0000000000..1f8d8fc35e --- /dev/null +++ b/en_us/open_edx_course_authors/source/content_experiments/index.rst @@ -0,0 +1,14 @@ +.. _Creating Content Experiments: + +############################# +Creating Content Experiments +############################# + + +.. toctree:: + :maxdepth: 2 + + content_experiments_overview + content_experiments_configure + content_experiments_add + content_experiments_view \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/creating_content/create_discussion.rst b/en_us/open_edx_course_authors/source/creating_content/create_discussion.rst new file mode 100644 index 0000000000..a7c711117b --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/create_discussion.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/creating_content/create_discussion.rst diff --git a/en_us/open_edx_course_authors/source/creating_content/create_html_component.rst b/en_us/open_edx_course_authors/source/creating_content/create_html_component.rst new file mode 100644 index 0000000000..9b595d0fb6 --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/create_html_component.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/creating_content/create_html_component.rst diff --git a/en_us/open_edx_course_authors/source/creating_content/create_problem.rst b/en_us/open_edx_course_authors/source/creating_content/create_problem.rst new file mode 100644 index 0000000000..c0045e2c62 --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/create_problem.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/creating_content/create_problem.rst diff --git a/en_us/open_edx_course_authors/source/creating_content/create_video.rst b/en_us/open_edx_course_authors/source/creating_content/create_video.rst new file mode 100644 index 0000000000..af57432e15 --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/create_video.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/creating_content/create_video.rst diff --git a/en_us/open_edx_course_authors/source/creating_content/index.rst b/en_us/open_edx_course_authors/source/creating_content/index.rst new file mode 100644 index 0000000000..3e7c9ec88c --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/index.rst @@ -0,0 +1,25 @@ +.. _Creating Course Content Index: + +############################ +Creating Course Content +############################ + +Use the chapters in this section to understand how to create course content of +different types. + +For information on creating exercises and tools, see :ref:`Exercises and Tools +Index`. + +For information on how to develop your course content in the Studio Outline +page, see :ref:`Developing Your Course Index`. + + + +.. toctree:: + :maxdepth: 2 + + create_html_component + create_video + create_discussion + create_problem + libraries diff --git a/en_us/open_edx_course_authors/source/creating_content/libraries.rst b/en_us/open_edx_course_authors/source/creating_content/libraries.rst new file mode 100644 index 0000000000..4038cca253 --- /dev/null +++ b/en_us/open_edx_course_authors/source/creating_content/libraries.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/creating_content/libraries.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/controlling_content_visibility.rst b/en_us/open_edx_course_authors/source/developing_course/controlling_content_visibility.rst new file mode 100644 index 0000000000..1ffe7e7d2a --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/controlling_content_visibility.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/controlling_content_visibility.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/course_components.rst b/en_us/open_edx_course_authors/source/developing_course/course_components.rst new file mode 100644 index 0000000000..e198ae12fa --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/course_components.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/course_components.rst + diff --git a/en_us/open_edx_course_authors/source/developing_course/course_outline.rst b/en_us/open_edx_course_authors/source/developing_course/course_outline.rst new file mode 100644 index 0000000000..472ad6a5cf --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/course_outline.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/course_outline.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/course_sections.rst b/en_us/open_edx_course_authors/source/developing_course/course_sections.rst new file mode 100644 index 0000000000..67f709a37e --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/course_sections.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/course_sections.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/course_subsections.rst b/en_us/open_edx_course_authors/source/developing_course/course_subsections.rst new file mode 100644 index 0000000000..4a0b742937 --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/course_subsections.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/course_subsections.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/course_units.rst b/en_us/open_edx_course_authors/source/developing_course/course_units.rst new file mode 100644 index 0000000000..f72754b88e --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/course_units.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/course_units.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/index.rst b/en_us/open_edx_course_authors/source/developing_course/index.rst new file mode 100644 index 0000000000..c6ce27956f --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/index.rst @@ -0,0 +1,29 @@ +.. _Developing Your Course Index: + +########################## +Developing Your Course +########################## + +Use the chapters 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 +Course Content Index`. + +For information on creating exercises and tools, see :ref:`Exercises and Tools +Index`. + +For information on creating content libraries from which you can randomly draw +content for randomized assigments, see :ref:`Content Libraries`. + +.. toctree:: + :maxdepth: 2 + + workflow + course_outline + course_sections + course_subsections + course_units + course_components + controlling_content_visibility + testing_courseware \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/developing_course/testing_courseware.rst b/en_us/open_edx_course_authors/source/developing_course/testing_courseware.rst new file mode 100644 index 0000000000..539351c30b --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/testing_courseware.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/testing_courseware.rst diff --git a/en_us/open_edx_course_authors/source/developing_course/workflow.rst b/en_us/open_edx_course_authors/source/developing_course/workflow.rst new file mode 100644 index 0000000000..8a2fbacb00 --- /dev/null +++ b/en_us/open_edx_course_authors/source/developing_course/workflow.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/developing_course/workflow.rst diff --git a/en_us/open_edx_course_authors/source/exercises_tools/annotation.rst b/en_us/open_edx_course_authors/source/exercises_tools/annotation.rst new file mode 100644 index 0000000000..1b12d13415 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/annotation.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/annotation.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/checkbox.rst b/en_us/open_edx_course_authors/source/exercises_tools/checkbox.rst new file mode 100644 index 0000000000..a7834d27b5 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/checkbox.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/checkbox.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/chemical_equation.rst b/en_us/open_edx_course_authors/source/exercises_tools/chemical_equation.rst new file mode 100644 index 0000000000..57c97cfcc7 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/chemical_equation.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/chemical_equation.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/circuit_schematic_builder.rst b/en_us/open_edx_course_authors/source/exercises_tools/circuit_schematic_builder.rst new file mode 100644 index 0000000000..ba60f15ca4 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/circuit_schematic_builder.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/circuit_schematic_builder.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/conditional_module.rst b/en_us/open_edx_course_authors/source/exercises_tools/conditional_module.rst new file mode 100644 index 0000000000..66d16c3485 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/conditional_module.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/conditional_module.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/create_exercises_and_tools.rst b/en_us/open_edx_course_authors/source/exercises_tools/create_exercises_and_tools.rst new file mode 100644 index 0000000000..eac4e4cc55 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/create_exercises_and_tools.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/create_exercises_and_tools.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/custom_javascript.rst b/en_us/open_edx_course_authors/source/exercises_tools/custom_javascript.rst new file mode 100644 index 0000000000..8505fae2f5 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/custom_javascript.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/custom_javascript.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/custom_python.rst b/en_us/open_edx_course_authors/source/exercises_tools/custom_python.rst new file mode 100644 index 0000000000..8fc6ebdfb6 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/custom_python.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/custom_python.rst diff --git a/en_us/open_edx_course_authors/source/exercises_tools/drag_and_drop.rst b/en_us/open_edx_course_authors/source/exercises_tools/drag_and_drop.rst new file mode 100644 index 0000000000..b9e39d47a7 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/drag_and_drop.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/drag_and_drop.rst diff --git a/en_us/open_edx_course_authors/source/exercises_tools/dropdown.rst b/en_us/open_edx_course_authors/source/exercises_tools/dropdown.rst new file mode 100644 index 0000000000..238b31a4c1 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/dropdown.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/dropdown.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/external_graders.rst b/en_us/open_edx_course_authors/source/exercises_tools/external_graders.rst new file mode 100644 index 0000000000..de17bbaa03 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/external_graders.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/external_graders.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/full_screen_image.rst b/en_us/open_edx_course_authors/source/exercises_tools/full_screen_image.rst new file mode 100644 index 0000000000..a97913598a --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/full_screen_image.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/full_screen_image.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/gene_explorer.rst b/en_us/open_edx_course_authors/source/exercises_tools/gene_explorer.rst new file mode 100644 index 0000000000..66e2180708 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/gene_explorer.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/gene_explorer.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/google_calendar.rst b/en_us/open_edx_course_authors/source/exercises_tools/google_calendar.rst new file mode 100644 index 0000000000..d6e0800823 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/google_calendar.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/google_calendar.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/google_docs.rst b/en_us/open_edx_course_authors/source/exercises_tools/google_docs.rst new file mode 100644 index 0000000000..70662bbb32 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/google_docs.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/google_docs.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/google_hangouts.rst b/en_us/open_edx_course_authors/source/exercises_tools/google_hangouts.rst new file mode 100644 index 0000000000..d6433f7153 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/google_hangouts.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/google_hangouts.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/iframe.rst b/en_us/open_edx_course_authors/source/exercises_tools/iframe.rst new file mode 100644 index 0000000000..61af9d5428 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/iframe.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/iframe.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/image_mapped_input.rst b/en_us/open_edx_course_authors/source/exercises_tools/image_mapped_input.rst new file mode 100644 index 0000000000..fd92ea8c58 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/image_mapped_input.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/image_mapped_input.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 new file mode 100644 index 0000000000..56d611d3ab --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/index.rst @@ -0,0 +1,56 @@ +.. _Exercises and Tools Index: + +############################ +Creating Exercises and Tools +############################ + +Use the chapters in this section to understand how to create exercises and +tools in your course. + +For information on how to develop your course content in the Studio Outline +page, see :ref:`Developing Your Course Index`. + +For information on building specific course component types, see :ref:`Creating +Course Content Index`. + + +.. toctree:: + :maxdepth: 2 + + create_exercises_and_tools + annotation + checkbox + chemical_equation + circuit_schematic_builder + conditional_module + custom_javascript + drag_and_drop + dropdown + external_graders + full_screen_image + gene_explorer + google_calendar + google_docs + google_hangouts + iframe + image_mapped_input + lti_component + math_expression_input + molecule_editor + molecule_viewer + multiple_choice + mult_choice_num_input + numerical_input + open_response_assessments/index + periodic_table + poll + problem_with_hint + problem_in_latex + protein_builder + randomized_content_blocks + student_notes + text_input + word_cloud + custom_python + zooming_image + mathjax \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/lti_component.rst b/en_us/open_edx_course_authors/source/exercises_tools/lti_component.rst new file mode 100644 index 0000000000..ac29f52320 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/lti_component.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/lti_component.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/math_expression_input.rst b/en_us/open_edx_course_authors/source/exercises_tools/math_expression_input.rst new file mode 100644 index 0000000000..7d70c40186 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/math_expression_input.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/math_expression_input.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/mathjax.rst b/en_us/open_edx_course_authors/source/exercises_tools/mathjax.rst new file mode 100644 index 0000000000..fe6cbba43c --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/mathjax.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/mathjax.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/molecule_editor.rst b/en_us/open_edx_course_authors/source/exercises_tools/molecule_editor.rst new file mode 100644 index 0000000000..acef0143e3 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/molecule_editor.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/molecule_editor.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/molecule_viewer.rst b/en_us/open_edx_course_authors/source/exercises_tools/molecule_viewer.rst new file mode 100644 index 0000000000..946b7a59f7 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/molecule_viewer.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/molecule_viewer.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/mult_choice_num_input.rst b/en_us/open_edx_course_authors/source/exercises_tools/mult_choice_num_input.rst new file mode 100644 index 0000000000..61c58afb97 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/mult_choice_num_input.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/mult_choice_num_input.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/multiple_choice.rst b/en_us/open_edx_course_authors/source/exercises_tools/multiple_choice.rst new file mode 100644 index 0000000000..eedf132103 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/multiple_choice.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/multiple_choice.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/numerical_input.rst b/en_us/open_edx_course_authors/source/exercises_tools/numerical_input.rst new file mode 100644 index 0000000000..804214f369 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/numerical_input.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/numerical_input.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/Access_ORA_Info.rst b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/Access_ORA_Info.rst new file mode 100644 index 0000000000..7477cb1eb5 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/Access_ORA_Info.rst @@ -0,0 +1 @@ +.. include:: ../../../../shared/subsections/open_response_assessments/Access_ORA_Info.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/CreateORAAssignment.rst b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/CreateORAAssignment.rst new file mode 100644 index 0000000000..97ef271178 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/CreateORAAssignment.rst @@ -0,0 +1 @@ +.. include:: ../../../../shared/subsections/open_response_assessments/CreateORAAssignment.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/OpenResponseAssessments.rst b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/OpenResponseAssessments.rst new file mode 100644 index 0000000000..e01192f7ab --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/OpenResponseAssessments.rst @@ -0,0 +1 @@ +.. include:: ../../../../shared/subsections/open_response_assessments/OpenResponseAssessments.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/index.rst b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/index.rst new file mode 100755 index 0000000000..7600af944e --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/open_response_assessments/index.rst @@ -0,0 +1,16 @@ +.. Getting_Started documentation master file, created by + sphinx-quickstart on Tue Apr 16 11:19:12 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + +Open Response Assessments +========================= + +.. toctree:: + :numbered: + :maxdepth: 2 + + OpenResponseAssessments + CreateORAAssignment + Access_ORA_Info \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/periodic_table.rst b/en_us/open_edx_course_authors/source/exercises_tools/periodic_table.rst new file mode 100644 index 0000000000..2dad6a862a --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/periodic_table.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/periodic_table.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/poll.rst b/en_us/open_edx_course_authors/source/exercises_tools/poll.rst new file mode 100644 index 0000000000..7ec89efa11 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/poll.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/poll.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/problem_in_latex.rst b/en_us/open_edx_course_authors/source/exercises_tools/problem_in_latex.rst new file mode 100644 index 0000000000..9b49e09dc2 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/problem_in_latex.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/problem_in_latex.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/problem_with_hint.rst b/en_us/open_edx_course_authors/source/exercises_tools/problem_with_hint.rst new file mode 100644 index 0000000000..2e6263694c --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/problem_with_hint.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/problem_with_hint.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/protein_builder.rst b/en_us/open_edx_course_authors/source/exercises_tools/protein_builder.rst new file mode 100644 index 0000000000..ee1e76ad9d --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/protein_builder.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/protein_builder.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/randomized_content_blocks.rst b/en_us/open_edx_course_authors/source/exercises_tools/randomized_content_blocks.rst new file mode 100644 index 0000000000..74814c5e38 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/randomized_content_blocks.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/randomized_content_blocks.rst diff --git a/en_us/open_edx_course_authors/source/exercises_tools/student_notes.rst b/en_us/open_edx_course_authors/source/exercises_tools/student_notes.rst new file mode 100644 index 0000000000..e62417b6ca --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/student_notes.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/exercises_tools/student_notes.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/exercises_tools/text_input.rst b/en_us/open_edx_course_authors/source/exercises_tools/text_input.rst new file mode 100644 index 0000000000..d8580dbbbd --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/text_input.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/text_input.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/word_cloud.rst b/en_us/open_edx_course_authors/source/exercises_tools/word_cloud.rst new file mode 100644 index 0000000000..11ec1a53d6 --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/word_cloud.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/word_cloud.rst + diff --git a/en_us/open_edx_course_authors/source/exercises_tools/zooming_image.rst b/en_us/open_edx_course_authors/source/exercises_tools/zooming_image.rst new file mode 100644 index 0000000000..0980b687ee --- /dev/null +++ b/en_us/open_edx_course_authors/source/exercises_tools/zooming_image.rst @@ -0,0 +1,2 @@ +.. include:: ../../../shared/exercises_tools/zooming_image.rst + diff --git a/en_us/open_edx_course_authors/source/getting_started/accessibility.rst b/en_us/open_edx_course_authors/source/getting_started/accessibility.rst new file mode 100644 index 0000000000..75fe5adb4e --- /dev/null +++ b/en_us/open_edx_course_authors/source/getting_started/accessibility.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/accessibility/accessibility.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/getting_started/browsers.rst b/en_us/open_edx_course_authors/source/getting_started/browsers.rst new file mode 100644 index 0000000000..7f2a1b17db --- /dev/null +++ b/en_us/open_edx_course_authors/source/getting_started/browsers.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/browsers.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/getting_started/get_started.rst b/en_us/open_edx_course_authors/source/getting_started/get_started.rst new file mode 100644 index 0000000000..334e6fbd01 --- /dev/null +++ b/en_us/open_edx_course_authors/source/getting_started/get_started.rst @@ -0,0 +1,78 @@ +.. _Getting Started with Studio: + +########################### +Getting Started with Studio +########################### + +*************** +Overview +*************** + +This chapter describes the tools you use to build an edX course, and how to create your first course: + +* :ref:`What is Studio?` +* :ref:`Create Your First Course` + +.. _What is Studio?: + +*************** +What is Studio? +*************** + +Studio is the edX tool you use to build your courses. + +You use Studio to create course content, problems, videos, and other resources for students. + +With Studio, you can also manage your schedule and course team, set grading policies, publish your course, and more. + +You use Studio directly through your browser. You do not need any additional software. + + +.. _Create Your First Course: + +*************************** +Create Your First Course +*************************** + +When you receive notice that you can create courses, log in to Studio. + +You see the following page, which is your **My Courses** dashboard: + +.. image:: ../../../shared/building_and_running_chapters/Images/first_course.png + :width: 600 + :alt: Image of the Studio home page where you create your first course + +#. Click **Create Your First Course**. +#. Enter course information as needed and click **Create**. + + .. image:: ../../../shared/building_and_running_chapters/Images/new_course_info.png + :width: 600 + :alt: Image of the Create New Course page + + .. note:: + Enter new course information carefully. This information becomes part of + the URL for your course. Because this information becomes part of your + course URL, the total number of characters in the following three fields + must be 65 or fewer. + + * For **Course Name**, enter the title of your course. For example, the name + may be “Sets, Maps and Symmetry Groups". Use title capitalization for the + course title. + + * For **Organization**, enter the name of your institution. Do not include + whitespace or special characters. + + * For **Course Number**, enter both a subject abbreviation and a number. For + example, for public health course number 207, enter **PH207**. For math + course 101x, enter **Math101x**. Do not include whitespace or special + characters in the course number. + +3. Click **Save.** + +Your new course opens to the **Course Outline** page. Because you haven't +created any content yet, this page is empty. + +In your browser’s address bar, notice that the URL of your course includes the +course organization, number, and course run. + +The rest of this documentation describes how you now build and run your course. diff --git a/en_us/open_edx_course_authors/source/getting_started/glossary.rst b/en_us/open_edx_course_authors/source/getting_started/glossary.rst new file mode 100644 index 0000000000..8eee4303c5 --- /dev/null +++ b/en_us/open_edx_course_authors/source/getting_started/glossary.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/glossary/glossary.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/getting_started/index.rst b/en_us/open_edx_course_authors/source/getting_started/index.rst new file mode 100644 index 0000000000..6ab884bd5e --- /dev/null +++ b/en_us/open_edx_course_authors/source/getting_started/index.rst @@ -0,0 +1,14 @@ +.. _Getting Started Index: + +################ +Getting Started +################ + +.. toctree:: + :maxdepth: 3 + + + browsers + get_started + accessibility + glossary diff --git a/en_us/open_edx_course_authors/source/index.rst b/en_us/open_edx_course_authors/source/index.rst new file mode 100755 index 0000000000..807b2344ec --- /dev/null +++ b/en_us/open_edx_course_authors/source/index.rst @@ -0,0 +1,20 @@ +######################################## +Building and Running an Open edX Course +######################################## + +.. toctree:: + :numbered: + :maxdepth: 2 + + read_me + preface + change_log + getting_started/index + building_course/index + developing_course/index + creating_content/index + exercises_tools/index + content_experiments/index + cohorts/index + releasing_course/index + running_course/index diff --git a/en_us/open_edx_course_authors/source/latex/Makefile b/en_us/open_edx_course_authors/source/latex/Makefile new file mode 100644 index 0000000000..6b87ad8814 --- /dev/null +++ b/en_us/open_edx_course_authors/source/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja + diff --git a/en_us/open_edx_course_authors/source/preface.rst b/en_us/open_edx_course_authors/source/preface.rst new file mode 100644 index 0000000000..53895c8473 --- /dev/null +++ b/en_us/open_edx_course_authors/source/preface.rst @@ -0,0 +1 @@ +.. include:: ../../shared/preface.rst \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/read_me.rst b/en_us/open_edx_course_authors/source/read_me.rst new file mode 100644 index 0000000000..3b9e252d27 --- /dev/null +++ b/en_us/open_edx_course_authors/source/read_me.rst @@ -0,0 +1,20 @@ +******* +Read Me +******* + +The edX *Building and Running an edX Course* guide is created +using RST_ files and Sphinx_. You, the user community, can help update and revise this documentation project on GitHub:: + + https://github.com/edx/edx-documentation/tree/master/en_us/open_edx_course_authors/source + +To suggest a revision, fork the project, make changes in your fork, and submit +a pull request back to the original project: this is known as the `GitHub +Flow`_. + +All pull requests need approval from edX. For more information, contact edX at +docs@edx.org. + +.. _Sphinx: http://sphinx-doc.org/ +.. _LaTeX: http://www.latex-project.org/ +.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser +.. _RST: http://docutils.sourceforge.net/rst.html diff --git a/en_us/open_edx_course_authors/source/releasing_course/beta_testing.rst b/en_us/open_edx_course_authors/source/releasing_course/beta_testing.rst new file mode 100644 index 0000000000..cf09353f41 --- /dev/null +++ b/en_us/open_edx_course_authors/source/releasing_course/beta_testing.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/releasing_course/beta_testing.rst diff --git a/en_us/open_edx_course_authors/source/releasing_course/course_launching.rst b/en_us/open_edx_course_authors/source/releasing_course/course_launching.rst new file mode 100644 index 0000000000..6d947f9aee --- /dev/null +++ b/en_us/open_edx_course_authors/source/releasing_course/course_launching.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/releasing_course/course_launching.rst diff --git a/en_us/open_edx_course_authors/source/releasing_course/index.rst b/en_us/open_edx_course_authors/source/releasing_course/index.rst new file mode 100644 index 0000000000..a86b61dfc4 --- /dev/null +++ b/en_us/open_edx_course_authors/source/releasing_course/index.rst @@ -0,0 +1,12 @@ +.. _Releasing Your Course Index: + +########################## +Releasing Your Course +########################## + +.. toctree:: + :maxdepth: 2 + + beta_testing + course_launching + staff_debug_info \ No newline at end of file diff --git a/en_us/open_edx_course_authors/source/releasing_course/staff_debug_info.rst b/en_us/open_edx_course_authors/source/releasing_course/staff_debug_info.rst new file mode 100644 index 0000000000..ae9c7dca47 --- /dev/null +++ b/en_us/open_edx_course_authors/source/releasing_course/staff_debug_info.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/releasing_course/staff_debug_info.rst diff --git a/en_us/open_edx_course_authors/source/running_course/bulk_email.rst b/en_us/open_edx_course_authors/source/running_course/bulk_email.rst new file mode 100644 index 0000000000..6b5006e190 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/bulk_email.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/bulk_email.rst diff --git a/en_us/open_edx_course_authors/source/running_course/checking_student_progress.rst b/en_us/open_edx_course_authors/source/running_course/checking_student_progress.rst new file mode 100644 index 0000000000..6c63111b3f --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/checking_student_progress.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/checking_student_progress.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_answers.rst b/en_us/open_edx_course_authors/source/running_course/course_answers.rst new file mode 100644 index 0000000000..723841a0ba --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_answers.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_answers.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_data.rst b/en_us/open_edx_course_authors/source/running_course/course_data.rst new file mode 100644 index 0000000000..789b4b3786 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_data.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_data.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_enrollment.rst b/en_us/open_edx_course_authors/source/running_course/course_enrollment.rst new file mode 100644 index 0000000000..9f84905c3e --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_enrollment.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_enrollment.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_grades.rst b/en_us/open_edx_course_authors/source/running_course/course_grades.rst new file mode 100644 index 0000000000..0c88357f9b --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_grades.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_grades.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_staffing.rst b/en_us/open_edx_course_authors/source/running_course/course_staffing.rst new file mode 100644 index 0000000000..999608a258 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_staffing.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_staffing.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_student.rst b/en_us/open_edx_course_authors/source/running_course/course_student.rst new file mode 100644 index 0000000000..259e498621 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_student.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_student.rst diff --git a/en_us/open_edx_course_authors/source/running_course/course_wiki.rst b/en_us/open_edx_course_authors/source/running_course/course_wiki.rst new file mode 100644 index 0000000000..bf5cff702a --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/course_wiki.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/course_wiki.rst diff --git a/en_us/open_edx_course_authors/source/running_course/discussion_guidance_moderators.rst b/en_us/open_edx_course_authors/source/running_course/discussion_guidance_moderators.rst new file mode 100644 index 0000000000..95092cb6ad --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/discussion_guidance_moderators.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/discussion_guidance_moderators.rst diff --git a/en_us/open_edx_course_authors/source/running_course/discussions.rst b/en_us/open_edx_course_authors/source/running_course/discussions.rst new file mode 100644 index 0000000000..2d5032ac30 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/discussions.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/discussions.rst diff --git a/en_us/open_edx_course_authors/source/running_course/discussions_students.rst b/en_us/open_edx_course_authors/source/running_course/discussions_students.rst new file mode 100644 index 0000000000..f90539b207 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/discussions_students.rst @@ -0,0 +1 @@ +.. include:: ../../../shared/building_and_running_chapters/running_course/discussions_students.rst diff --git a/en_us/open_edx_course_authors/source/running_course/index.rst b/en_us/open_edx_course_authors/source/running_course/index.rst new file mode 100644 index 0000000000..d8c7d02561 --- /dev/null +++ b/en_us/open_edx_course_authors/source/running_course/index.rst @@ -0,0 +1,21 @@ +.. _Running Your Course Index: + +########################## +Running Your Course +########################## + +.. toctree:: + :maxdepth: 2 + + course_staffing + course_enrollment + discussions + discussions_students + discussion_guidance_moderators + bulk_email + course_wiki + course_data + course_student + course_answers + course_grades + checking_student_progress \ No newline at end of file diff --git a/en_us/shared/exercises_tools/lti_component.rst b/en_us/shared/exercises_tools/lti_component.rst index f1d46f7e96..e5447ab506 100644 --- a/en_us/shared/exercises_tools/lti_component.rst +++ b/en_us/shared/exercises_tools/lti_component.rst @@ -14,16 +14,17 @@ version 1.1.1 specifications. You can use an LTI component in several ways. -* You can add external LTI content that is only displayed and does not require a -student response, such as textbook content. +* You can add external LTI content that is only displayed and does not require + a student response, such as textbook content. -* You can add external LTI content that requires a student response. An external - provider will grade student responses. +* You can add external LTI content that requires a student response. An + external provider will grade student responses. * You can use the component as a placeholder for syncing with an external grading system. -For example, the following LTI component incorporates a Cerego tool that students interact with. +For example, the following LTI component incorporates a Cerego tool that +students interact with. .. image:: ../../../shared/building_and_running_chapters/Images/LTIExample.png :alt: Cerego LTI component example