Conditionals:
See:
- conditionalized paragraph in: https://github.com/edx/edx-documentation/blame/DOCS/SaudiProjects/en_us/shared/building_and_running_chapters/developing_course/course_outline.rst#L132
- Partner doc config file: https://github.com/edx/edx-documentation/blob/DOCS/SaudiProjects/en_us/course_authors/source/conf.py#L23
- Open edX config file: https://github.com/edx/edx-documentation/blob/DOCS/SaudiProjects/en_us/open_edx_course_authors/source/conf.py#L22
- Output for Partner doc (doesn't include that paragraph): http://saudi-test-edx-building-guide.readthedocs.org/en/latest/developing_course/course_outline.html#add-content-in-the-course-outline
- Output for Open edX doc (does include that paragraph): http://saudi-test-open-edx-building-guide.readthedocs.org/en/latest/developing_course/course_outline.html#add-content-in-the-course-outline
Pluses:
- Pretty easy to implement on a paragraph basis.
Minuses:
- Could not get to work for a row in table. Thus we still have Student Notes listed in Partner table without link: http://saudi-test-edx-building-guide.readthedocs.org/en/latest/exercises_tools/create_exercises_and_tools.html#general-exercises-and-tools
We could work around that - Conditional text is still processed even if it isn't shown; that means you get build warnings for excluded text that has a link that's not actually shown. For example, in building partner doc, you get a warning that the link to prereq exams in the excluded paragraphs generates a warning even though it isn't shown. We can ignore warning but I'm concerned that if we don't have a standard of 100% clean builds, we end up overlooking warnings we should fix.
re: conditional text. I agree we should work to design our docs so that we can use this tool sparingly. When we do use, it, though, I think that we should include a comment indicating at a minimum what the related feature is by referencing the PR or JIRA story.
I conditionalized the learner engagement report. Check your links above (after while, still building).
Also note, I changed the way conditions are working to something much simpler.
for examples of using .. only:: audience
and config files for this setting per project:
Examples
.. only:: Open_edX
Data about course enrollment is available from the Instructor Dashboard and
from Insights. For more information, see :ref:`view_enrollment_count`.
.. 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`_.