Skip to content

Commit b31799c

Browse files
committed
Migrate installing, configuring, and running guide
1 parent 0359c75 commit b31799c

File tree

97 files changed

+1481
-211
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+1481
-211
lines changed

source/community/release_notes/dogwood.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ enhancement also gives system administrators the ability to configure a list of
117117
file types that learners cannot upload.
118118

119119
For more information, see
120-
Configuring ORA2 to Prohibit Submission of File Types.
120+
:ref:`Configuring ORA2 to Prohibit Submission of File Types`.
121121

122122
Certificates
123123
============

source/developers/references/developer_guide/links.rst

Whitespace-only changes.

source/developers/references/developer_guide/process/code-considerations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ back to you with questions.
101101
.. _Open edX Release Planning: https://openedx.atlassian.net/wiki/spaces/COMM/pages/13205845/Open+edX+Release+Planning
102102

103103

104-
.. include:: ../links.rst
104+
.. include:: /links.txt

source/developers/references/developer_guide/process/contributor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ link to a WIP pull request in any discussion threads you start.
6262
.. _Open edX Product Working Group: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3449028609/Product+Working+Group
6363
.. _Product Roadmap: https://github.com/orgs/openedx/projects/4
6464

65-
.. include:: ../links.rst
65+
.. include:: /links.txt

source/developers/references/developer_guide/process/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ questions or concerns.
3535
* :ref:`Accessibility Guidelines`
3636
* :ref:`analytics`
3737

38-
.. include:: ../links.rst
38+
.. include:: /links.txt

source/developers/references/developer_guide/testing/github-actions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ changes.
9898
.. _.github repo: https://github.com/openedx/.github/tree/master/.github/workflows
9999
.. _fix Transifex resource names: https://github.com/openedx/openedx-translations/blob/main/.github/workflows/fix-transifex-resource-names.yml
100100
.. _workflow dispatch: https://github.com/openedx/openedx-translations/blob/cf313a06ebf8c3a792e67174dfcba7607da2d61f/.github/workflows/fix-transifex-resource-names.yml#L5-L13
101-
.. include:: ../links.rst
101+
.. include:: /links.txt

source/developers/references/running_pr_tests.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,6 @@ PRs, and follow them to be notified of when the fix has been applied (and then
9797
do the rebase). You could even try submitting a PR yourself to fix the failing
9898
tests!
9999

100-
.. _Open edX Forums: https://discuss.openedx.org/
101100
.. _openedx.org/cla: http://openedx.org/cla
101+
102+
.. include:: /links.txt

source/documentors/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Documentor's Home:
2+
13
Open edX Documentors
24
####################
35

source/educators/concepts/exercise_tools/about_OpenResponseAssessments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ you cannot specify these file types.
693693

694694
This set of file name extensions is provided as the default for Open edX
695695
installations. Open edX system administrators can update this list. For more
696-
information, see `Configuring ora2 to prohibit submission of file types`_.
696+
information, see :ref:`Configuring ora2 to prohibit submission of file types`.
697697

698698
.. list-table::
699699
:widths: 15 75

source/educators/how-tos/configure_certificate_timing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Configure Certificate Availability and Timing
1010
Before you can issue certificates, the administrator for your instance of
1111
Open edX must configure the platform to allow course teams to generate and
1212
issue certificates. For more information, see
13-
`Enable Automatic Certificate Generation`_ and
14-
`Enable Certificates`_ in *Installing, Configuring, and
13+
:ref:`Enable Automatic Certificate Generation` and
14+
:ref:`Enable Certificates` in *Installing, Configuring, and
1515
Running the Open edX Platform*.
1616

1717
The platform can automatically generate certificates for both self-paced courses and
@@ -64,7 +64,7 @@ Allow Learners to Receive Early Certificates
6464
********************************************
6565

6666
If the administrator has configured the site correctly (see
67-
`Enable Automatic Certificate Generation`_ in
67+
:ref:`Enable Automatic Certificate Generation` in
6868
*Installing, Configuring, and Running the Open edX Platform*),
6969
self-paced courses issue certificates to learners as soon as learners
7070
have completed enough of the course, with a high enough grade, to earn

source/educators/navigation/learner_engagement_communication.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Bulk Emails
4444
../references/communication/compose_email_message.rst
4545
../how-tos/communication/email_task_history_report.rst
4646

47+
.. _Automatic Emails:
48+
4749
Automatic Emails
4850
*******************************************************
4951

source/links.txt

Lines changed: 126 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
.. _VirtualEnvWrapper: http://virtualenvwrapper.readthedocs.io/en/latest
88

9-
.. _Configuring ORA2 to Prohibit Submission of File Types: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/ora2/ora2_blacklist.html
10-
119
.. _edx-platform: https://github.com/openedx/edx-platform
1210

1311
.. _init file: https://github.com/openedx/edx-ora2/blob/a4ce7bb00190d7baff60fc90fb613229565ca7ef/openassessment/fileupload/backends/__init__.py
@@ -174,10 +172,6 @@
174172

175173
.. _app_label: https://docs.djangoproject.com/en/1.8/ref/models/options/#app-label
176174

177-
.. _Enable Certificates: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_certificates.html
178-
179-
.. _Enable Automatic Certificate Generation: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_certificates.html#enable-automatic-certificate-generation
180-
181175
.. _Media formats supported by the HTML audio and video elements: https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats#MP4_H.264_(AAC_or_MP3)
182176

183177
.. _editing object metadata: http://docs.aws.amazon.com/AmazonS3/latest/UG/EditingtheMetadataofanObject.html
@@ -212,10 +206,134 @@
212206

213207
.. _Time and Date Time Zone Converter: http://www.timeanddate.com/worldclock/converter.html
214208

215-
.. _Installing, Configuring, and Running the Open edX Platform: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/index.html
216-
217209
.. _Tree of Math: http://www.onemathematicalcat.org/MathJaxDocumentation/TeXSyntax.htm
218210

219211
.. _MathJax Documentation: http://docs.mathjax.org/en/latest/index.html
220212

221213
.. _Mathematics meta: http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
214+
215+
.. _Open edX Release Schedule: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3613392957/Open+edX+Release+Schedule
216+
217+
.. _Open edX Releases Wiki page: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4191191044/Open+edX+Releases+Homepage
218+
219+
.. _The migrate.sh script: https://github.com/openedx/configuration/blob/named-release/dogwood.rc/util/vagrant/migrate.sh
220+
221+
.. _The upgrade.sh script: https://github.com/openedx/configuration/blob/master/util/vagrant/upgrade.sh
222+
223+
.. _forum migration described on the Open edX wiki: https://openedx.atlassian.net/wiki/display/TNL/Migrating+the+Discussion+Forums+to+Support+Teams+Discussion+Filtering
224+
225+
.. _Native Installation to Tutor forum post: https://discuss.openedx.org/t/upgrade-from-native-to-tutor/9252
226+
227+
.. _this second Native to Tutor post: https://discuss.overhang.io/t/migrating-from-native-install-to-tutor-juniper-tutor-10-x/1533
228+
229+
.. _Open edX Installation options: https://openedx.atlassian.net/wiki/x/wwCXAw
230+
231+
.. _Open edX Native 12.04 Installation: https://openedx.atlassian.net/wiki/x/bgCXAw
232+
233+
.. _Legacy Open edX Native Installation: https://openedx.atlassian.net/wiki/x/g4G6C
234+
235+
.. _Koa Open edX Native Installation: https://openedx.atlassian.net/wiki/x/lIJjdQ
236+
237+
.. _Django Forms: https://docs.djangoproject.com/en/1.8/ref/forms/
238+
239+
.. _example CSS file for drag and drop problems: https://github.com/openedx/xblock-drag-and-drop-v2/blob/master/drag_and_drop_v2/public/themes/apros.css
240+
241+
.. _custom_form_app: https://github.com/open-craft/custom-form-app
242+
243+
.. _GitHub: http://github.com
244+
245+
.. _EdX Search: https://github.com/openedx/edx-search/
246+
247+
.. _edX Automated Communication Engine: http://edx-ace.readthedocs.io/en/latest
248+
249+
.. _IMS LTI 1.1 Consumer Launch: http://www.imsglobal.org/developers/LTI/test/v1p1/lms.php
250+
251+
.. _password_policy_validators: https://github.com/openedx/edx-platform/blob/master/common/djangoapps/util/password_policy_validators.py
252+
253+
.. _Python SAML Toolkit: https://github.com/onelogin/python-saml
254+
255+
.. _random and highly secure password: https://github.com/openedx/edx-platform/blob/46d69eba/common/djangoapps/third_party_auth/pipeline.py#L392-L410
256+
257+
.. _OID: https://en.wikipedia.org/wiki/Object_identifier
258+
259+
.. _URN: https://en.wikipedia.org/wiki/Uniform_Resource_Name
260+
261+
.. _eduPersonPrincipalName: https://www.internet2.edu/media/medialibrary/2013/09/04/internet2-mace-dir-eduperson-201203.html#eduPersonPrincipalName
262+
263+
.. _eduPersonEntitlement: https://www.internet2.edu/media/medialibrary/2013/09/04/internet2-mace-dir-eduperson-201203.html#eduPersonEntitlement
264+
265+
.. _eduPerson Object Class Specification: https://www.internet2.edu/media/medialibrary/2013/09/04/internet2-mace-dir-eduperson-201203.html
266+
267+
.. _Google Developers Console: https://console.developers.google.com/project/_/apiui/apis/library
268+
269+
.. _Facebook for Developers: https://developers.facebook.com/apps/?action=create
270+
271+
.. _LinkedIn Developers: https://www.linkedin.com/secure/developer
272+
273+
.. _Microsoft Sign In: https://account.live.com
274+
275+
.. _Azure account creation: https://azure.microsoft.com/en-us/pricing/free-trial
276+
277+
.. _Azure sign in: https://portal.azure.com
278+
279+
.. _AWS template file: https://github.com/openedx/edx-platform/blob/b3462e5b1c3cc45ad8673f3f12e84fa17ffa6b64/lms/envs/aws.py#L586-L596
280+
281+
.. _Font Awesome: http://fortawesome.github.io/Font-Awesome/icons/
282+
283+
.. _Elastic MapReduce: http://aws.amazon.com/elasticmapreduce/
284+
285+
.. _default EC2 role for Amazon EMR: http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-iam-roles-defaultroles.html#emr-iam-roles-defaultec2
286+
287+
.. _Default IAM Roles for Amazon EMR: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-iam-role-for-ec2.html
288+
289+
.. _a single public subnet: http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Scenario1.html
290+
291+
.. _example configuration scenario: http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Scenario2.html
292+
293+
.. _Open edX Forums: https://discuss.openedx.org/
294+
295+
.. _submission_mixin.py: https://github.com/openedx/edx-ora2/blob/a4ce7bb00190d7baff60fc90fb613229565ca7ef/openassessment/xblock/submission_mixin.py
296+
297+
.. _official Google instructions: https://developers.google.com/identity/protocols/oauth2
298+
299+
.. _python-social-auth supported backend: http://python-social-auth.readthedocs.io/en/latest/backends/index.html#social-backends
300+
301+
.. _list of python-social-auth backends: https://github.com/omab/python-social-auth/tree/master/social/backends
302+
303+
.. _python-social-auth documentation: http://python-social-auth.readthedocs.io/en/latest/index.html
304+
305+
.. _OAuth backends supported by python-social-auth v0.2.12: http://python-social-auth.readthedocs.io/en/latest/backends/index.html#social-backends
306+
307+
.. _the default value in the aws.py file: https://github.com/openedx/edx-platform/blob/b3462e5b1c3cc45ad8673f3f12e84fa17ffa6b64/lms/envs/aws.py#L586-L596
308+
309+
.. _YouTube Data API v3: https://developers.google.com/youtube/v3/
310+
311+
.. _instructions for obtaining authorization credentials: https://developers.google.com/youtube/registering_an_application
312+
313+
.. _Query string syntax: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax
314+
315+
.. _Ansible: https://docs.ansible.com/
316+
317+
.. _configuration: https://github.com/openedx/configuration
318+
319+
.. _Virtual Environments: http://docs.python-guide.org/en/latest/dev/virtualenvs/
320+
321+
.. _VirtualEnv Installation: https://virtualenv.pypa.io/en/latest/installation.html
322+
323+
.. _VirtualEnvWrapper: http://virtualenvwrapper.readthedocs.io/en/latest
324+
325+
.. _spot pricing market: http://aws.amazon.com/ec2/purchasing-options/spot-instances/
326+
327+
.. _edX Managing the Full Stack: https://github.com/openedx/configuration/wiki/edX-Managing-the-Full-Stack
328+
329+
.. _edX Enrollment API: https://docs.openedx.org/projects/edx-platform/en/latest/references/lms_apis.html#get--enrollment-v1-course-course_id
330+
331+
.. _edx-analytics-configuration: https://github.com/openedx/edx-analytics-configuration
332+
333+
.. _AWS Command Line Interface: http://aws.amazon.com/cli/
334+
335+
.. _edX Analytics Installation: https://openedx.atlassian.net/wiki/display/OpenOPS/edX+Analytics+Installation
336+
337+
.. _retirement: https://user-retirement-guide.readthedocs.io/en/latest/index.html
338+
339+
.. _AWS Documentation: http://aws.amazon.com/documentation/

source/other/getting_help.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Getting Help
66
If you are unable to find what you need here or need more help than the
77
documentation provides, we'd love to hear about it via the :doc:`feedback`.
88

9-
To get more help we recommend checking out the `Open edX Forums
10-
<https://discuss.openedx.org>`_. Make sure to search the forums before posting a
9+
To get more help we recommend checking out the `Open edX Forums`_. Make sure to search the forums before posting a
1110
new question in case others have had the same question as you.
1211

1312
The community also has a `slack workspace
@@ -20,3 +19,5 @@ responses.
2019

2120
The Open edX community has agreed upon a shared `code of conduct
2221
<https://openedx.org/code-of-conduct/>`_, please be sure to review it.
22+
23+
.. include:: /links.txt

source/site_ops/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ Open edX Site Operators
33

44
.. note::
55

6-
This area is still under active development. You can find the old
7-
documentation here: `Installing, Configuring, and Running the Open edX Platform`_
6+
This area is still under active development.
87

98
For information about the latest release of the Open edX Platform, you can
109
check out the :doc:`/community/release_notes/index`
Loading
Loading

0 commit comments

Comments
 (0)