Merge pull request #552 from edx/ahodges/os_lti_tp

Adds edX as LTI tool provider docs to Open CA guide
openedx · Sep 18, 2015 · 67698f4 · 67698f4
2 parents 5baaafb + 49fb6b7
commit 67698f4
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 19 deletions.
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
@@ -27,4 +27,5 @@ see :ref:`Developing Your Course Index`.
    course_rerun
    custom_courses
    export_import_course
+   lti/index
 
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/index.rst b/en_us/open_edx_course_authors/source/building_course/lti/index.rst
@@ -0,0 +1,36 @@
+.. _Using Open edX as an LTI Tool Provider:
+
+######################################
+Using Open edX as an LTI Tool Provider
+######################################
+
+Your installation of Open edX can be configured to be a learning tool
+interoperability (LTI) provider to other systems and applications. If your Open
+edX site is configured to be an LTI provider, you can present content from an
+Open edX course in any application that is configured to be a consumer of that
+content. As a result, you can reuse Open edX course content, including advanced
+problem types and videos, in contexts other than the Open edX LMS. Examples
+include courses running on Canvas, Blackboard, and other learning management
+systems and applications.
+
+For more information about the configuration process for this feature, see
+`Configuring an edX Instance as an LTI Tool Provider`_ in the *Installing,
+Configuring, and Running the Open edX Platform* guide.
+
+You use the topics in this section to prepare your course for reuse.
+
+.. toctree::
+   :maxdepth: 2
+
+   lti_reuse_content
+   lti_prepare_content
+   lti_address_content
+   lti_grade_content
+   lti_canvas_example
+   lti_blackboard_example
+
+You can also include content from an LTI provider in your Open edX courses. For
+more information, see :ref:`LTI Component`.
+
+.. _Configuring an edX Instance as an LTI Tool Provider: http://edx.readthedocs.org/projects/edx-installing-configuring-and-running/en/latest/configuration/lti/index.html
+
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/lti_address_content.rst b/en_us/open_edx_course_authors/source/building_course/lti/lti_address_content.rst
@@ -0,0 +1,2 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_address_content.rst
+
diff --git a/...s/open_edx_course_authors/source/building_course/lti/lti_blackboard_example.rst b/...s/open_edx_course_authors/source/building_course/lti/lti_blackboard_example.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_blackboard_example.rst
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/lti_canvas_example.rst b/en_us/open_edx_course_authors/source/building_course/lti/lti_canvas_example.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_canvas_example.rst
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/lti_grade_content.rst b/en_us/open_edx_course_authors/source/building_course/lti/lti_grade_content.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_grade_content.rst
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/lti_prepare_content.rst b/en_us/open_edx_course_authors/source/building_course/lti/lti_prepare_content.rst
@@ -0,0 +1,2 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_prepare_content.rst
+
diff --git a/en_us/open_edx_course_authors/source/building_course/lti/lti_reuse_content.rst b/en_us/open_edx_course_authors/source/building_course/lti/lti_reuse_content.rst
@@ -0,0 +1 @@
+.. include:: ../../../../shared/building_and_running_chapters/building_course/lti/lti_reuse_content.rst
diff --git a/en_us/open_edx_course_authors/source/front_matter/change_log.rst b/en_us/open_edx_course_authors/source/front_matter/change_log.rst
@@ -13,6 +13,8 @@ September 2015
 
    * - Date
      - Change
+   * - 18 September 2015
+     - Added the :ref:`Using Open edX as an LTI Tool Provider` section.
    * - 9 September 2015
      - Updated the :ref:`Student_Answer_Submission` section to include topics
        about the downloadable student state report and the submission history

diff --git a/...hared/building_and_running_chapters/building_course/lti/lti_address_content.rst b/...hared/building_and_running_chapters/building_course/lti/lti_address_content.rst
@@ -219,8 +219,8 @@ steps.
 
 #. In your browser, enter the URL for the course structure API. 
 
-   For example, to access the course structure API for the edX Demo course on
-   Edge, you enter this URL.
+   For example, to access the course structure API for the edX Demo course, 
+   you enter this URL.
 
    ``https://edge.edx.org/api/course_structure/v0/course_structures/course-v1:edX+DemoX+Demo_Course`` 
 

diff --git a/...hared/building_and_running_chapters/building_course/lti/lti_prepare_content.rst b/...hared/building_and_running_chapters/building_course/lti/lti_prepare_content.rst
@@ -15,10 +15,10 @@ Preparing to Reuse Course Content
 
 .. only:: Open_edX
 
-  Before you begin work to reuse the content in an edX course, check with your
-  development operations (DevOps) team for information about the edX website to
-  use. At some sites, a completely separate open edX instance, with a different
-  Studio website, is set up to be the LTI tool provider.
+  Before you begin work to reuse the content in an Open edX course, check with
+  your development operations (DevOps) team for information about the 
+  website to use. At some sites, a completely separate Open edX instance, with
+  a different Studio website, is set up to be the LTI tool provider.
 
 .. contents:: 
    :local:
@@ -69,21 +69,28 @@ editing its XML before you import.
 Create the Duplicate Course
 ***********************************
 
-Before you create a duplicate course, be sure to check with your DevOps team or
-your edX PM to determine the website that hosts your organization's courses for
-LTI use.
+.. only:: Partners
+
+  Before you create a duplicate course, be sure to check with your DevOps team
+  or your edX Partner Manager to determine the website that hosts your
+  organization's courses for LTI use.
+
+.. only:: Open_edX
+
+  Before you create a duplicate course, be sure to check with your DevOps team
+  to determine the website that hosts your organization's courses for LTI use.
 
 To create the duplicate course, follow these steps.
 
-#. In Studio on edX Edge, export the course. For more information, see
+#. In Studio, export the original course. For more information, see
    :ref:`Export a Course`.
 
-#. In Studio on your organization's host site for LTI courses (either edX Edge
-   or your organization's own LTI site), create a course. This is the duplicate
-   course.
+#. In Studio on your organization's host site for LTI courses, create a course.
+   This is the duplicate course.
 
-   .. note:: If your organization uses edX Edge as the host site, be sure to
-    give the duplicate course a different, distinguishing name or run.
+   .. note:: If your organization uses the same site as the host for both the 
+    original course and for LTI courses, be sure to give the duplicate course a
+    different name or run.
 
 #. In the duplicate course, import the tar.gz file that you exported in step 1.
    For more information, see :ref:`Import a Course`.

diff --git a/.../shared/building_and_running_chapters/building_course/lti/lti_reuse_content.rst b/.../shared/building_and_running_chapters/building_course/lti/lti_reuse_content.rst
@@ -46,10 +46,12 @@ the external LMS.
 Learner Identification and Single Sign On
 ******************************************
 
-.. note:: Different configuration options are available for how an external 
- LMS and edX Edge authenticate users. Your DevOps team is likely to have
- additional information about the specific authentication process used by your
- institution.
+.. only:: Partners
+
+  .. note:: Different configuration options are available for how an external 
+   LMS and edX Edge authenticate users. Your DevOps team is likely to have
+   additional information about the specific authentication process used by 
+   your institution.
 
 Learners do not need to navigate to a different website, or sign in to any
 other system (including edX), to access content that originates in an edX