Skip to content
This repository was archived by the owner on Mar 20, 2025. It is now read-only.

Commit 3ae1f53

Browse files
committed
docs!: Convert Open edX learner's audience to edx.org
We've moved the Open edX learner's guide to https://docs.openedx.org/en/latest/learners/index.html so update the current learner's guide to indicate it is specific to edx.org as we've found many references in that guide that don't apply to Open edX courses.
1 parent 236c65f commit 3ae1f53

File tree

4 files changed

+20
-9
lines changed

4 files changed

+20
-9
lines changed

en_us/landing_page/source/index.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,21 @@ The `edX Release Notes`_ describe recent additions to the edX platform.
2626
If you use or host an Open edX site
2727
************************************
2828

29-
* Learners: See the :ref:`openlearners:Open edX Learner's Guide`.
29+
* Learners: See the `Open edX Learner's Guide`_.
3030

31-
* Course teams: See :ref:`Quick Start Build a Course`.
31+
* Course teams: See `Quick Start Build a Course`_.
3232

33-
* Developers: See the :ref:`Open edX Developer's Guide` and
34-
:ref:`Installing, Configuring, and Running the Open edX
35-
Platform`.
33+
* Developers: See the `Open edX Developer's Guide`_ and
34+
`Installing, Configuring, and Running the Open edX Platform`_.
3635

3736
.. toctree::
3837
:hidden:
3938

4039
dummy
4140

4241
.. _docs.edx.org: https://docs.edx.org
43-
.. _edX Release Notes: http://edx.readthedocs.io/projects/edx-release-notes/en/latest/
42+
.. _edX Release Notes: http://edx.readthedocs.io/projects/edx-release-notes/en/latest/
43+
.. _Open edX Learner's Guide: https://docs.openedx.org/en/latest/learners/index.html
44+
.. _Quick Start Build a Course: https://docs.openedx.org/en/latest/educators/quickstarts/build_a_course.html
45+
.. _Open edX Developer's Guide: https://docs.openedx.org/en/latest/developers/references/developer_guide/index.html
46+
.. _Installing, Configuring, and Running the Open edX Platform: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/index.html

en_us/open_edx_students/source/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@
44
sys.path.append('../../../')
55

66
from shared.conf import *
7+
from shared.edxconf import *
78

8-
project = u'Open edX Learner\'s Guide'
9+
project = u'edX.org Learner\'s Guide'
910

1011
exclude_patterns = ['links.rst', 'reusables/*', 'SFD_mathformatting.rst']
1112

1213
tags.add('Open_edX')
1314
product = 'Open_edX'
1415
set_audience(OPENEDX, LEARNERS)
1516

17+
html_theme_options["announcement"] = "This is the learner's guide for edx.org courses. For Open edX courses, please see the <a href='https://docs.openedx.org/en/latest/learners/index.html'>Open edX Learner's Guide</a>."
18+
1619

1720
def setup(app):
1821
app.add_config_value('product', '', True)

en_us/open_edx_students/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _Open edX Learner's Guide:
1+
.. _edX Learner's Guide:
22

33
########################
4-
Open edX Learner's Guide
4+
edX.org Learner's Guide
55
########################
66

77
.. toctree::

shared/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@
117117
# Categories
118118
PARTNER = object()
119119
OPENEDX = object()
120+
EDX = object()
120121

121122
# Audiences
122123
COURSE_TEAMS = object()
@@ -153,6 +154,10 @@
153154
'help_url': "https://openedx.org/community/connect/",
154155
'help_link_text': "Get Help",
155156
},
157+
(EDX, LEARNERS): {
158+
'help_url': "https://help.edx.org",
159+
'help_link_text': "Get Help",
160+
}
156161
}
157162

158163
# Defaults for the help links.

0 commit comments

Comments
 (0)