Skip to content

Commit a744e81

Browse files
sarinasarina
committed
chore: Convert OEP headers to use :ref: instead of :doc: 
1 parent ca8deab commit a744e81

File tree

55 files changed

+238
-186
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

+238
-186
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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _oep-32:
2+
.. _OEP-32 Unique Identifier for Users:
23

34
OEP-32: Unique Identifier for Users
45
###################################
@@ -7,7 +8,7 @@ OEP-32: Unique Identifier for Users
78
:widths: 25 75
89

910
* - OEP
10-
- :doc:`OEP-32 <oep-0032-arch-unique-identifier-for-users>`
11+
- :ref:`OEP-32 <OEP-32 Unique Identifier for Users>`
1112
* - Title
1213
- Unique Identifier for Users
1314
* - Last Modified

0 commit comments

Comments
 (0)