Commit 16523b99 by Mark Hoeber

Merge pull request #2947 from edx/markhoeber/documentation/doc-34

Edits from Alison's initial review
parents f666b854 bb856984
...@@ -95,7 +95,7 @@ edX101 and the edX Demo Course ...@@ -95,7 +95,7 @@ edX101 and the edX Demo Course
EdX has provided edX101_ and the `edX Demo course <https://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038>`_ to help familiarize you with taking and creating edX courses. EdX has provided edX101_ and the `edX Demo course <https://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038>`_ to help familiarize you with taking and creating edX courses.
* edX101_, available on Edge_, is both an example of a course you can build with Studio, and a self-paced walk through of planning, building, and running your own online course. * edX101_, available on Edge_, is an example of a course built with Studio. It is a self-paced walk through of planning, building, and running your own online course.
* The `edX Demo course <https://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038>`_, available on edX.org_, allows new students to explore and learn how to take an edX course. We recommend that you become familiar with the student’s experience of an edX course before you begin building your first course. * The `edX Demo course <https://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038>`_, available on edX.org_, allows new students to explore and learn how to take an edX course. We recommend that you become familiar with the student’s experience of an edX course before you begin building your first course.
......
...@@ -33,7 +33,7 @@ Create a Discussion Component ...@@ -33,7 +33,7 @@ Create a Discussion Component
To create a new HTML component in an existing Unit, ensure the Unit is Private. To create a new HTML component in an existing Unit, ensure the Unit is Private.
For more information on Public and Private Units, see LINK. For more information on Public and Private Units, see :ref:`Public and Private Units`.
#. Under **Add New Component**, click the **discussion** icon. #. Under **Add New Component**, click the **discussion** icon.
...@@ -53,7 +53,7 @@ For more information on Public and Private Units, see LINK. ...@@ -53,7 +53,7 @@ For more information on Public and Private Units, see LINK.
.. image:: Images/DiscussionComponentEditor.png .. image:: Images/DiscussionComponentEditor.png
:alt: Image of the discussion component editor :alt: Image of the discussion component editor
#. Follow the guidelines in the editor to fill in the **Discussion Category**, **Display Name**, and **Subcategory**. #. Follow the guidelines in the editor to fill in the **Category**, **Display Name**, and **Subcategory**.
#. Click **Save**. #. Click **Save**.
......
...@@ -401,7 +401,7 @@ The current sort order is shown at the top of the file list, and the active sort ...@@ -401,7 +401,7 @@ The current sort order is shown at the top of the file list, and the active sort
Find Files Find Files
================== ==================
The **Files & Uploads** page lists up to 50 files. If your course has more than 50 files, additional files are listed in other pages. The **Files & Uploads** page lists up to 50 files. If your course has more than 50 files, additional files are listed on other pages.
The range of the files listed on the page, and the total number of files, are shown at the top of the page. The range of the files listed on the page, and the total number of files, are shown at the top of the page.
...@@ -438,7 +438,8 @@ To delete a file, click the **x** icon next to the file. You are prompted to co ...@@ -438,7 +438,8 @@ To delete a file, click the **x** icon next to the file. You are prompted to co
**************** ****************
Add Static Pages Add Static Pages
**************** ****************
You can add static pages to your course. Each static page appears in your courses navigation bar. You can add static pages to your course. Each static page appears in your course's navigation bar.
For example, the following navigation bar includes a For example, the following navigation bar includes a
**Syllabus** and **Projects** static pages. **Syllabus** and **Projects** static pages.
...@@ -493,9 +494,9 @@ To add a course update: ...@@ -493,9 +494,9 @@ To add a course update:
#. From the **Content** menu, select **Updates**. #. From the **Content** menu, select **Updates**.
#. Click **New Update**. #. Click **New Update**.
#. Enter your update as as HTML. #. Enter your update in the HTML editor that opens.
.. note:: You must enter the update in HTML. For a template that includes placeholders, see :ref:`Appendix A`. .. note:: You must enter the update in HTML. See :ref:`Appendix A`.
4. Click **Save**. 4. Click **Save**.
...@@ -504,12 +505,12 @@ To add a course update: ...@@ -504,12 +505,12 @@ To add a course update:
********************** **********************
Add Course Handouts Add Course Handouts
********************** **********************
You can add course handouts that are visible to students on the **Course Info** page. You can add course handouts that are visible to students on the **Course Info** page. To add an uploaded file to the course handouts, you will need its URL.
.. note:: You must :ref:`Add Files to a Course` before you can add them as course handouts. .. note:: You must :ref:`Add Files to a Course` before you can add them as course handouts.
#. From the **Content** menu, select **Updates**. #. From the **Content** menu, select **Updates**.
#. In the **Course Handouts** page, click **Edit**. #. In the **Course Handouts** panel, click **Edit**.
#. Edit the HTML to add links to the files you uploaded. See :ref:`Add a Link in an HTML Component` for more information. #. Edit the HTML to add links to the files you uploaded. See :ref:`Add a Link in an HTML Component` for more information.
#. Click **Save**. #. Click **Save**.
...@@ -518,7 +519,7 @@ You can add course handouts that are visible to students on the **Course Info** ...@@ -518,7 +519,7 @@ You can add course handouts that are visible to students on the **Course Info**
**************** ****************
Add Textbooks Add Textbooks
**************** ****************
You can add textbooks for your course as PDF files. You can add PDF textbooks for your course.
.. note:: Do not use image files (for example, .PNG files) as textbooks for your course, as they are not accessible to screen readers. Review the :ref:`Best Practices for Accessible PDFs` for more information. .. note:: Do not use image files (for example, .PNG files) as textbooks for your course, as they are not accessible to screen readers. Review the :ref:`Best Practices for Accessible PDFs` for more information.
...@@ -542,5 +543,5 @@ To add a textbook: ...@@ -542,5 +543,5 @@ To add a textbook:
3. Enter the **Textbook Name**. 3. Enter the **Textbook Name**.
#. Enter the first **Chapter Name**. #. Enter the first **Chapter Name**.
#. To upload a PDF file from your computer, click **Upload PDF**. Follow the prompts to upload your file. #. To upload a PDF file from your computer, click **Upload PDF**. Follow the prompts to upload your file.
#. To add addition chapters, click **+Add a Chapter** and repeat steps 3 and 4. #. To add more chapters, click **+Add a Chapter** and repeat steps 3 and 4.
#. Click **Save**. #. Click **Save**.
\ No newline at end of file
...@@ -109,7 +109,7 @@ You configure the following fields for each assignment type: ...@@ -109,7 +109,7 @@ You configure the following fields for each assignment type:
The general category of the assignment. This name will be visible to students. The general category of the assignment. This name will be visible to students.
.. note:: All assignments of a particular type are automatically worth the same amount. Thus, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems. .. note:: All assignments of a particular type count the same toward the weight of that category. As a result, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems.
* **Abbreviation:** * **Abbreviation:**
...@@ -144,7 +144,7 @@ You configure the following fields for each assignment type: ...@@ -144,7 +144,7 @@ You configure the following fields for each assignment type:
Set the Assignment Type for Graded Subsections Set the Assignment Type for Graded Subsections
********************************************** **********************************************
After you configure assignment types, as you are organizing your course, After you configure assignment types, as you are organizing your course,
you set the assignment type for Subsections that contain problems that are to be graded. you set the assignment type for subsections that contain problems that are to be graded. Courses are organized to include sections and subsections. Each subsection that contains problems to be graded can include only one assignment type. See :ref:`subsections` for more information.
.. note:: You can designate a Subsection as one, and only one, of the assignment types you configured. You can also set a due date. .. note:: You can designate a Subsection as one, and only one, of the assignment types you configured. You can also set a due date.
......
...@@ -59,7 +59,7 @@ EdX then evaluates your request. When course creation permissions are granted, y ...@@ -59,7 +59,7 @@ EdX then evaluates your request. When course creation permissions are granted, y
Create Your First Course Create Your First Course
*************************** ***************************
When you receive notice that you can create courses, log into Studio_. When you receive notice that you can create courses, log in to Studio_.
You see the following page: You see the following page:
......
...@@ -112,7 +112,7 @@ For more information about viewing drafts or the current version of your course, ...@@ -112,7 +112,7 @@ For more information about viewing drafts or the current version of your course,
Units Units
****** ******
Subsections are divided into units. A unit, in turn, contains one or more components. Subsections are divided into units. A unit, in turn, contains one or more components, such as HTML content, problems, and videos.
In the LMS, each unit in the subsection appears as a link on the course ribbon at the top of the page. The following image shows a subsection that has eight units: In the LMS, each unit in the subsection appears as a link on the course ribbon at the top of the page. The following image shows a subsection that has eight units:
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
Read Me Read Me
******* *******
The edX *Building a course with Studio* documentation is created The edX *Building a Course with edX Studio* documentation is created
using RST_ files and Sphinx_. You, the user community, can help update and revise using RST_ files and Sphinx_. You, the user community, can help update and revise
this documentation project on GitHub:: this documentation project on GitHub::
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment