Skip to content

Commit 6e04ccf

Browse files
sarinasarina
committed
chore: Convert OEP headers to use :ref: instead of :doc: 
1 parent c7b1610 commit 6e04ccf

File tree

55 files changed

+205
-162
lines changed

Some content is hidden

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

55 files changed

+205
-162
lines changed

‎oep-templates/adr-based-template.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
.. Below is the display in the left sidebar on RTD. Please omit leading 0's
44
5+
.. _OEP-XXXX OEP Template:
6+
57
OEP-XXXX: OEP Template
68
######################
79

@@ -13,7 +15,7 @@ OEP-XXXX: OEP Template
1315
* - OEP
1416
- Link to the doc in the following format::
1517

16-
:doc:`OEP-XXXX <oep-XXXX-YYYY-ZZZZ>`
18+
:ref:`OEP-XXXX OEP Template`
1719

1820
* <XXXX is the next available OEP number>
1921
* <YYYY is the abbreviated Type: proc | bp | arch>

‎oep-templates/external-link-template.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
.. Below is the display in the left sidebar on RTD. Please omit leading 0's
44
5+
.. _OEP XXXX OEP Template:
6+
57
OEP-XXXX: OEP Template
68
######################
79

@@ -13,7 +15,7 @@ OEP-XXXX: OEP Template
1315
* - OEP
1416
- Link to the doc in the following format::
1517

16-
:doc:`OEP-XXXX <oep-XXXX-YYYY-ZZZZ>`
18+
:ref:`OEP-XXXX OEP Template`
1719

1820
* <XXXX is the next available OEP number>
1921
* <YYYY is the abbreviated Type: proc | bp | arch>

‎oep-templates/pep-based-template.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
.. Below is the display in the left sidebar on RTD. Please omit leading 0's
44
5+
.. _OEP XXXX OEP Template:
6+
57
OEP-XXXX: OEP Template
68
######################
79

@@ -13,7 +15,7 @@ OEP-XXXX: OEP Template
1315
* - OEP
1416
- Link to the doc in the following format::
1517

16-
:doc:`OEP-XXXX <oep-XXXX-YYYY-ZZZZ>`
18+
:ref:`OEP-XXXX OEP Template`
1719

1820
* <XXXX is the next available OEP number>
1921
* <YYYY is the abbreviated Type: proc | bp | arch>

‎oeps/architectural-decisions/oep-0003-arch-async-tasks.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.. _OEP-3 Asynchronous Task Management:
2+
13
OEP-3: Asynchronous Task Management
24
###################################
35

46
+---------------+-------------------------------------------+
5-
| OEP | :doc:`oep-0003-arch-async-tasks` |
7+
| OEP | :ref:`OEP-3 Asynchronous Task Management` |
68
+---------------+-------------------------------------------+
79
| Title | Asynchronous Task Management |
810
+---------------+-------------------------------------------+

‎oeps/architectural-decisions/oep-0004-arch-oauth-scopes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _OEP-4:
1+
.. _OEP-4 Application Authorization (Scopes):
22

33
OEP-4: Application Authorization (Scopes)
44
#########################################
@@ -7,7 +7,7 @@ OEP-4: Application Authorization (Scopes)
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-4 <oep-0004-arch-oauth-scopes>`
10+
- :ref:`OEP-4 Application Authorization (Scopes)`
1111
* - Title
1212
- Application Authorization (Scopes)
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.. _OEP-15 Course-wide Custom JavaScript:
2+
13
OEP-15: Course-wide Custom JavaScript
24
#####################################
35

46
+---------------+----------------------------------------------------+
5-
| OEP | :doc:`OEP-15 <oep-0015-arch-course-wide-js>` |
7+
| OEP | :ref:`OEP-15 Course-wide Custom JavaScript` |
68
+---------------+----------------------------------------------------+
79
| Title | Course-wide Custom JavaScript |
810
+---------------+----------------------------------------------------+

‎oeps/architectural-decisions/oep-0026-arch-realtime-events.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.. _OEP-26 Real-time Events:
2+
13
OEP-26: Real-time Events
24
##########################
35

46
+-----------------+--------------------------------------------------------+
5-
| OEP | :doc:`OEP-26 <oep-0026-arch-realtime-events>` |
7+
| OEP | :ref:`OEP-26 Real-time Events` |
68
+-----------------+--------------------------------------------------------+
79
| Title | Real-time Events |
810
+-----------------+--------------------------------------------------------+
@@ -35,7 +37,7 @@ Status
3537

3638
As of 2025-02-05, this OEP has been accepted. It has been implemented in Open edX as the `event_routing_backends`_ plugin, which is currently in use for delivering real-time analytics to Aspects and to deliver real-time events to external systems via xAPI and Caliper. While that project adheres closely to this OEP, there are also other event-based communication mechanisms within the platform that are covered by other OEPs.
3739

38-
`OEP-41 <oep-0041-arch-async-server-event-messaging>`_ and `OEP-52 <oep-0052-arch-event-bus-architecture>`_ cover the general format and conventions for generic asynchronous event messaging across and within services. While this OEP concerns itself learner-specific event sharing. There is also some overlap, for instance when event-routing-backends is configured to send events to an event bus, however this OEP is not considered superceded at this time.
40+
:ref:`OEP-41 <OEP-41 Asynchronous Server Event Message Format>` and :ref:`OEP-52 <oep-52>` cover the general format and conventions for generic asynchronous event messaging across and within services. While this OEP concerns itself learner-specific event sharing. There is also some overlap, for instance when event-routing-backends is configured to send events to an event bus, however this OEP is not considered superceded at this time.
3941

4042
Where possible this document has been updated to match the implemented reality. However some sections may be out of date. The `event_routing_backends`_ plugin is the authoritative source for the current implementation.
4143

‎oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ OEP-30: PII Markup and Auditing
44
###############################
55

66
+---------------+------------------------------------------------------------+
7-
| OEP | :doc:`OEP-30 <oep-0030-arch-pii-markup-and-auditing>` |
7+
| OEP | :ref:`OEP-30 PII Markup and Auditing` |
88
+---------------+------------------------------------------------------------+
99
| Title | Personally Identifiable Information Markup and Auditing |
1010
+---------------+------------------------------------------------------------+

‎oeps/architectural-decisions/oep-0031-arch-i18n.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
.. _OEP-31 Micro-frontend Internationalization:
2+
13
OEP-31: Micro-frontend Internationalization
24
###########################################
35

46
.. list-table::
57

68
* - OEP
7-
- :doc:`OEP-31 <oep-0031-arch-i18n>`
9+
- :ref:`OEP-31 Micro-frontend Internationalization`
810
* - Title
911
- Micro-frontend Internationalization
1012
* - Last Modified

‎oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-32: Unique Identifier for Users
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-32 <oep-0032-arch-unique-identifier-for-users>`
10+
- :ref:`OEP-32`
1111
* - Title
1212
- Unique Identifier for Users
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-41: Asynchronous Server Event Message Format
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-41 <oep-0041-arch-async-server-event-messaging>`
10+
- :ref:`OEP-41 Asynchronous Server Event Message Format`
1111
* - Title
1212
- Asynchronous Server Event Message Format
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-45: Configuring and Operating Open edX
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-0045 <oep-0045-arch-ops-and-config>`
10+
- :ref:`OEP-45 Configuring and Operating Open edX`
1111
* - Title
1212
- Configuring and Operating Open edX
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0048-brand-customization.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
.. _OEP-48 Brand Customization:
2+
13
OEP-48: Brand Customization
24
###########################
35

46
.. list-table::
57
:widths: 25 75
68

79
* - OEP
8-
- :doc:`OEP-0048 <oep-0048-brand-customization>`
10+
- :ref:`OEP-48 Brand Customization`
911
* - Title
1012
- Brand Customization
1113
* - Last Modified

‎oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-50: Hooks extension framework
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-0050 <oep-0050-hooks-extension-framework>`
10+
- :ref:`OEP-50 Hooks extension framework`
1111
* - Title
1212
- Open edX Hooks Extension Framework
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OEP-52: Event Bus Architecture
99
:widths: 25 75
1010

1111
* - OEP-52
12-
- :doc:`OEP-0052 <oep-0052-arch-event-bus-architecture>`
12+
- :ref:`oep-52`
1313
* - Title
1414
- Event Bus Architecture
1515
* - Last Modified

‎oeps/architectural-decisions/oep-0058-arch-translations-management.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-58: Translations Management
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-58 <oep-0058-arch-translations-management>`
10+
- :ref:`OEP-58 Translations Management`
1111
* - Title
1212
- Translations Management
1313
* - Last Modified

‎oeps/architectural-decisions/oep-0064-arch-mobile-application-codebase-modernization.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
.. _OEP-64 Mobile App Codebase Modernization:
2+
13
OEP-64: Mobile App Codebase Modernization
24
#########################################
35

46
.. list-table::
57
:widths: 25 75
68

79
* - OEP
8-
- :doc:`OEP-64 <oep-0064-arch-mobile-application-codebase-modernization>`
10+
- :ref:`OEP-64 Mobile App Codebase Modernization`
911
* - Title
1012
- Mobile Application Codebase Modernization
1113
* - Last Modified

‎oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OEP-65: Frontend Composability
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-65 <oep-0065-arch-frontend-composability>`
10+
- :ref:`OEP-65 Frontend Composibility`
1111
* - Title
1212
- Frontend Composability
1313
* - Last Modified

‎oeps/archived/oep-0002-bp-repo-metadata.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _OEP-2:
1+
.. _OEP-2 Repository Metadata:
22

33
OEP-2: Repository Metadata
44
##########################
@@ -7,7 +7,7 @@ OEP-2: Repository Metadata
77
:widths: 25 75
88

99
* - OEP
10-
- :doc:`OEP-2 <oep-0002-bp-repo-metadata>`
10+
- :ref:`OEP-2 <OEP-2 Repository Metadata>`
1111
* - Title
1212
- Repository Metadata
1313
* - Last Modified

‎oeps/archived/oep-0005-arch-containerize-devstack.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
.. _OEP-5:
1+
.. _OEP-5 Pre-built Developer Environments:
22

33
OEP-5: Pre-built Developer Environments
44
#######################################
55

6-
+---------------+----------------------------------------------------+
7-
| OEP | :doc:`OEP-5 <oep-0005-arch-containerize-devstack>` |
8-
+---------------+----------------------------------------------------+
9-
| Title | Pre-built Developer Environments |
10-
+---------------+----------------------------------------------------+
11-
| Last Modified | 2016-08-04 |
12-
+---------------+----------------------------------------------------+
13-
| Author | Calen Pennington <[email protected]> |
14-
+---------------+----------------------------------------------------+
15-
| Arbiter | Jesse Zoldak <[email protected]> |
16-
+---------------+----------------------------------------------------+
17-
| Status | Replaced |
18-
+---------------+----------------------------------------------------+
19-
| Type | Architecture |
20-
+---------------+----------------------------------------------------+
21-
| Created | 2016-06-28 |
22-
+---------------+----------------------------------------------------+
6+
+---------------+------------------------------------------------------+
7+
| OEP | :ref:`OEP-5 <OEP-5 Pre-built Developer Environments>`|
8+
+---------------+------------------------------------------------------+
9+
| Title | Pre-built Developer Environments |
10+
+---------------+------------------------------------------------------+
11+
| Last Modified | 2016-08-04 |
12+
+---------------+------------------------------------------------------+
13+
| Author | Calen Pennington <[email protected]> |
14+
+---------------+------------------------------------------------------+
15+
| Arbiter | Jesse Zoldak <[email protected]> |
16+
+---------------+------------------------------------------------------+
17+
| Status | Replaced |
18+
+---------------+------------------------------------------------------+
19+
| Type | Architecture |
20+
+---------------+------------------------------------------------------+
21+
| Created | 2016-06-28 |
22+
+---------------+------------------------------------------------------+
2323

2424
.. attention::
2525

‎oeps/archived/oep-0005/decisions/0001-location-of-decentralized-docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Context
2121
Decision
2222
********
2323

24-
Place DD documentation(general decisions, general how-tos) in :ref:`OEP-5`. Eventually, these decisions will be used to update OEP-5.
24+
Place DD documentation(general decisions, general how-tos) in :ref:`OEP-5 Pre-built Developer Environments`. Eventually, these decisions will be used to update OEP-5.
2525

2626
.. note::
2727

‎oeps/archived/oep-0006-arch-context-xblock-fields.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.. _OEP-6 Context-scoped XBlock Fields:
2+
13
OEP-6: Context-scoped XBlock Fields
24
###################################
35

46
+---------------+----------------------------------------------------------+
5-
| OEP | :doc:`OEP-6 <oep-0006-arch-context-xblock-fields>` |
7+
| OEP | :ref:`OEP-6 <OEP-6 Context-scoped XBlock Fields>` |
68
+---------------+----------------------------------------------------------+
79
| Title | Context-scoped XBlock Fields |
810
+---------------+----------------------------------------------------------+

‎oeps/archived/oep-0007-bp-migrate-to-python3.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.. _OEP-7 Migrating to Python 3:
2+
13
OEP-7: Migrating to Python 3
24
############################
35

46
+---------------+-----------------------------------------------+
5-
| OEP | :doc:`OEP-7 <oep-0007-bp-migrate-to-python3>` |
7+
| OEP | :ref:`OEP-7 <OEP-7 Migrating to Python 3>` |
68
+---------------+-----------------------------------------------+
79
| Title | Migrating to Python 3 |
810
+---------------+-----------------------------------------------+

‎oeps/archived/oep-0009-bp-permissions.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _OEP-9:
1+
.. _OEP-9 User Authorization (Permissions):
22

33
OEP-9: User Authorization (Permissions)
44
#######################################
55

66
+---------------+-----------------------------------------------------------------------+
7-
| OEP | :doc:`OEP-9 <oep-0009-bp-permissions>` |
7+
| OEP | :ref:`OEP-9 <OEP-9 User Authorization (Permissions)>` |
88
+---------------+-----------------------------------------------------------------------+
99
| Title | User Authorization (Permissions) |
1010
+---------------+-----------------------------------------------------------------------+
@@ -214,13 +214,11 @@ changed if desired by creating a subclass, for example:
214214
If additional information about the session is needed beyond the user's
215215
identity in order to make a permission decision (for example, if an action
216216
should only be allowed if the client has been granted a particular OAuth
217-
scope, as outlined in `OEP-4`_), then a custom `BasePermission`_ subclass can
217+
scope, as outlined in :ref:`OEP-4 Application Authorization (Scopes)`), then a custom `BasePermission`_ subclass can
218218
be implemented which both consults the Django authorization API and makes the
219219
necessary checks against the session or other properties of the request
220220
object.
221221

222-
.. _OEP-4: https://open-edx-proposals.readthedocs.io/en/latest/oeps/oep-0004.html
223-
224222
In order to filter the querysets used to generate list responses to only
225223
include objects appropriate for the users permissions, an appropriate filter
226224
class should also be set. A generic implementation using the library

‎oeps/archived/oep-0011-bp-FED-technology.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
.. _OEP-11:
1+
.. _OEP-11 Front End Technology Standards:
22

33
OEP-11: Front End Technology Standards
44
######################################
55

6-
+---------------+--------------------------------------------------+
7-
| OEP | :doc:`OEP-11 <oep-0011-bp-FED-technology>` |
8-
+---------------+--------------------------------------------------+
9-
| Title | Front End Technology Standards |
10-
+---------------+--------------------------------------------------+
11-
| Last Modified | 2018-02-22 |
12-
+---------------+--------------------------------------------------+
13-
| Author | Andy Armstrong <[email protected]>, |
14-
| | George Babey <[email protected]> |
15-
+---------------+--------------------------------------------------+
16-
| Arbiter | Matt Drayer <[email protected]> |
17-
+---------------+--------------------------------------------------+
18-
| Status | Replaced |
19-
+---------------+--------------------------------------------------+
20-
| Type | Best Practice |
21-
+---------------+--------------------------------------------------+
22-
| Created | 2016-10-19 |
23-
+---------------+--------------------------------------------------+
6+
+---------------+------------------------------------------------------+
7+
| OEP | :ref:`OEP-11 <OEP-11 Front End Technology Standards>`|
8+
+---------------+------------------------------------------------------+
9+
| Title | Front End Technology Standards |
10+
+---------------+------------------------------------------------------+
11+
| Last Modified | 2018-02-22 |
12+
+---------------+------------------------------------------------------+
13+
| Author | Andy Armstrong <[email protected]>, |
14+
| | George Babey <[email protected]> |
15+
+---------------+------------------------------------------------------+
16+
| Arbiter | Matt Drayer <[email protected]> |
17+
+---------------+------------------------------------------------------+
18+
| Status | Replaced |
19+
+---------------+------------------------------------------------------+
20+
| Type | Best Practice |
21+
+---------------+------------------------------------------------------+
22+
| Created | 2016-10-19 |
23+
+---------------+------------------------------------------------------+
2424

2525
.. warning::
2626

0 commit comments

Comments
 (0)