Skip to content

Commit 869674b

Browse files
committed
Stubs for Tutor Dev, Ops Quickstarts
1 parent 8ce5916 commit 869674b

7 files changed

Lines changed: 73 additions & 5 deletions

File tree

source/developers/concepts/tutor.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This video, by Edly Academy, explains the basic concepts of Tutor.
1111

1212
.. seealso::
1313

14+
:ref:`Tutor QS (Dev)`
15+
1416
:ref:`qs Dev First PR`
1517

1618
**Maintenance chart**

source/developers/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Open edX Developers
1212
:class-footer: sd-border-0
1313

1414
* :doc:`/developers/quickstarts/first_openedx_pr`
15-
* :doc:`/developers/quickstarts/so_you_want_to_contribute`
15+
* :ref:`qs Dev Contributing`
16+
* :ref:`Tutor QS (Dev)`
1617
+++
1718
.. button-ref:: quickstarts/index
1819
:color: primary
@@ -25,8 +26,9 @@ Open edX Developers
2526
:class-card: sd-shadow-md sd-p-2
2627
:class-footer: sd-border-0
2728

29+
* :ref:`qs Dev Contributing`
30+
* :ref:`Tutor QS (Dev)`
2831
* :doc:`references/running_pr_tests`
29-
* :doc:`references/internal_data_formats/index`
3032
* :doc:`concepts/hooks_extension_framework`
3133

3234
.. grid-item-card:: How-tos
@@ -51,6 +53,7 @@ Open edX Developers
5153
* :doc:`concepts/backend_layout_and_approach`
5254
* :doc:`concepts/accessibility`
5355
* :doc:`concepts/hooks_extension_framework`
56+
* :ref:`Tutor Concept (Dev)`
5457
+++
5558
.. button-ref:: concepts/index
5659
:color: primary

source/developers/quickstarts/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Developer Quickstarts
99

1010
.. seealso::
1111

12-
:doc:`/developers/references/developer_guide/process/index`
12+
:ref:`Open edX Developer's Guide`
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _Tutor QS (Dev):
2+
3+
Tutor Quickstart (Developer)
4+
#############################
5+
6+
.. tags:: site operator, quickstart
7+
8+
.. admonition:: tutor main vs tutor local
9+
10+
``tutor main`` should be used by developers when writing code for the
11+
master/main branches.
12+
13+
``tutor local`` should be used by site operators to deploy an Open edX
14+
instance. See :ref:`Tutor QS (Operator)` if you wish to deploy an Open edX
15+
instance.
16+
17+
.. seealso::
18+
19+
:ref:`Tutor Concept (Operator)`
20+
21+
:ref:`qs Dev First PR`
22+
23+
**Maintenance chart**
24+
25+
+--------------+-------------------------------+----------------+--------------------------------+
26+
| Review Date | Working Group Reviewer | Release |Test situation |
27+
+--------------+-------------------------------+----------------+--------------------------------+
28+
| | | | |
29+
+--------------+-------------------------------+----------------+--------------------------------+

source/site_ops/concepts/tutor.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ This video, by Edly Academy, explains the basic concepts of Tutor.
1111

1212
.. seealso::
1313

14-
:ref:`Site Operators QS`
14+
:ref:`Site Operator QS`
15+
16+
:ref:`Tutor QS (Operator)`
1517

1618
**Maintenance chart**
1719

source/site_ops/quickstarts/quickstart_video.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _Site Operators QS:
1+
.. _Site Operator QS:
22

33
Site Operators: Quick Start
44
###########################
@@ -9,6 +9,11 @@ Watch the following video on how to set up Open edX quickly using Tutor:
99

1010
.. youtube:: QngJaemFLms
1111

12+
.. seealso::
13+
14+
:ref:`Tutor Concept (Operator)`
15+
16+
:ref:`Tutor QS (Operator)`
1217

1318
**Maintenance chart**
1419

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _Tutor QS (Operator):
2+
3+
Tutor Quickstart (Operator)
4+
#############################
5+
6+
.. tags:: site operator, quickstart
7+
8+
.. admonition:: tutor local vs tutor main
9+
10+
``tutor local`` should be used by site operators to deploy an Open edX instance.
11+
12+
``tutor main`` should be used by developers when writing code for the
13+
master/main branches. See :ref:`Tutor QS (Dev)` if you are developing code.
14+
15+
.. seealso::
16+
17+
:ref:`Tutor Concept (Dev)`
18+
19+
:ref:`Site Operator QS`
20+
21+
**Maintenance chart**
22+
23+
+--------------+-------------------------------+----------------+--------------------------------+
24+
| Review Date | Working Group Reviewer | Release |Test situation |
25+
+--------------+-------------------------------+----------------+--------------------------------+
26+
| | | | |
27+
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)