Skip to content

Commit

Permalink
Merge pull request #530 from edx/sylvia/docs/small_updates
Browse files Browse the repository at this point in the history
Correct typo in Open edX Installing... readme
  • Loading branch information
srpearce committed Sep 9, 2015
2 parents 00a7035 + d1e5818 commit b760f63
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
41 changes: 40 additions & 1 deletion en_us/edx_style_guide/source/ExampleRSTFile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,43 @@ list.
certificates, you must select the type of certificate you want after you
select **Enroll Now**.

***************************************
Conditional Text
***************************************

To conditionalize a single paragraph, use either the ``only:: Partners`` or
the ``only:: Open_edX`` directive, and indent the paragraph under the
directive. You can add the conditional text as regular text or as a note.

Make sure to indent the paragraph under the directive.

::

.. only:: Partners

Data about course enrollment is available from edX Insights. You can access
Insights from the Instructor Dashboard for your live course: after you select
**Instructor**, follow the link in the banner at the top of each page. For
more information, see `Using edX Insights`_.
.. only:: Open_edX

.. note::
If you want to require an entrance exam for your course, you also create
the exam in the course outline. Before you can create an exam, you must
set your course to require an entrance exam in Studio. For more
information, see :ref:`Require an Entrance Exam`.

To conditionalize more than a paragraph, use either the ``only:: Partners`` or
the ``only:: Open_edX`` directive, and then use an ``include::`` directive
indented under the only directive.

::

.. only:: Open_edX

.. include:: ../../../shared/building_and_running_chapters/running_course/Section_course_student.rst



*********************************
Expand Down Expand Up @@ -241,7 +278,9 @@ text that is useful to someone who might not be able to see the image.
Tables
************************************

Each example in this section shows the raw formatting for the table followed by the table as it would render (if you are viewing this file as part of the Style Guide).
Each example in this section shows the raw formatting for the table followed
by the table as it would render (if you are viewing this file as part of the
Style Guide).

======================================
Example of a table with an empty cell
Expand Down
6 changes: 3 additions & 3 deletions en_us/install_operations/source/front_matter/read_me.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ The *Installing and Configuring the Open edX Platform* documentation is created
using RST_ files and Sphinx_. As a member of the community, you can help update
and revise this documentation project on GitHub:

https://github.com/edx/edx-
documentation/tree/master/en_us/install_operations/source
``https://github.com/edx/edx-documentation/tree/master/en_us/install_operations/source``

To suggest a revision, follow the `GitHub Flow`_: fork the project, make changes in your fork, and submit a pull request back to the original project.
To suggest a revision, follow the `GitHub Flow`_: fork the project, make
changes in your fork, and submit a pull request back to the original project.

.. _Sphinx: http://sphinx-doc.org/
.. _LaTeX: http://www.latex-project.org/
Expand Down

0 comments on commit b760f63

Please sign in to comment.