openedx · feanil · Mar 9, 2023 · Mar 2, 2023 · Mar 2, 2023 · Mar 2, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches:
+    - '**'
+
+jobs:
+  check_for_moved_files:
+    name:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+        python-version: ['3.8']
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: setup python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install pip
+      run: pip install -r requirements/pip.txt
+
+    - name: Install Dependencies
+      run: pip install -r requirements/base.txt
+
+    - name: Run Rediraffe Check
+      run: make check_redirects
diff --git a/Makefile b/Makefile
@@ -248,3 +248,11 @@ requirements:
 
 dev-requirements:
 	pip install -r requirements/dev.txt
+
+update_redirects:
+	# If files got moved there should be a redirect in redirects.txt
+	sphinx-build -b rediraffewritediff oeps $(BUILDDIR)
+
+check_redirects:
+	# Check to make sure that any files that got moved have a redirect in redirects.txt
+	sphinx-build -b rediraffecheckdiff oeps $(BUILDDIR)
diff --git a/...s/oep-0005-arch-containerize-devstack.rst → ...d/oep-0005-arch-containerize-devstack.rst b/...s/oep-0005-arch-containerize-devstack.rst → ...d/oep-0005-arch-containerize-devstack.rst
@@ -12,13 +12,19 @@ OEP-5: Pre-built Developer Environments
 +---------------+----------------------------------------------------+
 | Arbiter       | Jesse Zoldak <[email protected]>                     |
 +---------------+----------------------------------------------------+
-| Status        | Accepted                                           |
+| Status        | Replaced                                           |
 +---------------+----------------------------------------------------+
 | Type          | Architecture                                       |
 +---------------+----------------------------------------------------+
 | Created       | 2016-06-28                                         |
 +---------------+----------------------------------------------------+
 
+.. attention::
+
+   This OEP has been replaced by
+   :doc:`/architectural-decisions/oep-0045/decisions/0001-tutor-as-replacement-for-edx-configuration`
+   a decision made as a part of :doc:`/architectural-decisions/oep-0045-arch-ops-and-config`
+
 Abstract
 ********
 

diff --git a/...s/0001-location-of-decentralized-docs.rst → ...s/0001-location-of-decentralized-docs.rst b/...s/0001-location-of-decentralized-docs.rst → ...s/0001-location-of-decentralized-docs.rst
diff --git a/...sions/0002-why-decentralized-devstack.rst → ...sions/0002-why-decentralized-devstack.rst b/...sions/0002-why-decentralized-devstack.rst → ...sions/0002-why-decentralized-devstack.rst
diff --git a/...0003-experiment-with-docker-interface.rst → ...0003-experiment-with-docker-interface.rst b/...0003-experiment-with-docker-interface.rst → ...0003-experiment-with-docker-interface.rst
diff --git a/...ons/oep-0005/decisions/0004-data-dump.rst → ...ved/oep-0005/decisions/0004-data-dump.rst b/...ons/oep-0005/decisions/0004-data-dump.rst → ...ved/oep-0005/decisions/0004-data-dump.rst
diff --git a/...5/decisions/0005-centralized-devstack.rst → ...5/decisions/0005-centralized-devstack.rst b/...5/decisions/0005-centralized-devstack.rst → ...5/decisions/0005-centralized-devstack.rst
diff --git a/...ctices/oep-0007-bp-migrate-to-python3.rst → ...chived/oep-0007-bp-migrate-to-python3.rst b/...ctices/oep-0007-bp-migrate-to-python3.rst → ...chived/oep-0007-bp-migrate-to-python3.rst
@@ -13,7 +13,7 @@ OEP-7: Migrating to Python 3
 +---------------+-----------------------------------------------+
 | Arbiter       | Christopher Pappas <[email protected]>          |
 +---------------+-----------------------------------------------+
-| Status        | Accepted                                      |
+| Status        | Obsolete                                      |
 +---------------+-----------------------------------------------+
 | Type          | Best Practice                                 |
 +---------------+-----------------------------------------------+
@@ -24,6 +24,15 @@ OEP-7: Migrating to Python 3
 
 .. _open-edx-proposals#21: https://github.com/openedx/open-edx-proposals/pull/21#pullrequestreview-18018383
 
+
+.. attention::
+
+   This OEP is Obsolete as all systems within the Open edX platform now run on
+   Python >= 3.8
+
+   This OEP served as a coordination point for the upgrade related decisions but
+   is no longer relevant to the project.
+
 Abstract
 ********
 

diff --git a/...ecisions/oep-0012-arch-fragment-views.rst → ...archived/oep-0012-arch-fragment-views.rst b/...ecisions/oep-0012-arch-fragment-views.rst → ...archived/oep-0012-arch-fragment-views.rst
@@ -12,7 +12,7 @@ OEP-12: Pluggable User Interfaces
 +---------------+----------------------------------------------------+
 | Arbiter       | Clinton Blackburn <[email protected]>                |
 +---------------+----------------------------------------------------+
-| Status        | Accepted                                           |
+| Status        | Obsolete                                           |
 +---------------+----------------------------------------------------+
 | Type          | Architecture                                       |
 +---------------+----------------------------------------------------+
@@ -23,6 +23,12 @@ OEP-12: Pluggable User Interfaces
 
 .. _open-edx-proposals#34: https://github.com/openedx/open-edx-proposals/pull/34#pullrequestreview-18294926
 
+.. attention::
+
+   This OEP assumes UI components managed by Django however, the Open edX
+   platform has moved to JS based Micro-Frontends for its user interfaces and
+   thus the decisions and proposals in this OEP are no longer relevant.
+
 Abstract
 ********
 

diff --git a/...ral-decisions/oep-0012/insights-cards.png → oeps/archived/oep-0012/insights-cards.png b/...ral-decisions/oep-0012/insights-cards.png → oeps/archived/oep-0012/insights-cards.png
diff --git a/...ep-0012/proposed-instructor-dashboard.png → ...ep-0012/proposed-instructor-dashboard.png b/...ep-0012/proposed-instructor-dashboard.png → ...ep-0012/proposed-instructor-dashboard.png
diff --git a/...ep-0025-proc-incremental-improvements.rst → ...ep-0025-proc-incremental-improvements.rst b/...ep-0025-proc-incremental-improvements.rst → ...ep-0025-proc-incremental-improvements.rst
@@ -12,7 +12,7 @@ OEP-25: Incremental Improvements
 +-----------------+----------------------------------------------------------+
 | Arbiter         | Adam Stankiewicz <[email protected]>                  |
 +-----------------+----------------------------------------------------------+
-| Status          | Accepted                                                 |
+| Status          | Obsolete                                                 |
 +-----------------+----------------------------------------------------------+
 | Type            | Process                                                  |
 +-----------------+----------------------------------------------------------+
@@ -25,6 +25,14 @@ OEP-25: Incremental Improvements
 
 .. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/66#pullrequestreview-151034037
 
+.. attention::
+
+   The incremental improvements process is no longer being actively maintained.
+   If you are looking for places where you can help the project check out issues
+   tagged as `help wanted
+   <https://github.com/openedx/public-engineering/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22>`
+   in the ``public-engineering`` project.
+
 TL;DR
 *****
 

diff --git a/oeps/processes/oep-0025/INCR_workflow → oeps/archived/oep-0025/INCR_workflow b/oeps/processes/oep-0025/INCR_workflow → oeps/archived/oep-0025/INCR_workflow
diff --git a/oeps/processes/oep-0025/INCR_workflow.png → oeps/archived/oep-0025/INCR_workflow.png b/oeps/processes/oep-0025/INCR_workflow.png → oeps/archived/oep-0025/INCR_workflow.png
diff --git a/...st-practices/oep-0034-bp-lint-amnesty.rst → oeps/archived/oep-0034-bp-lint-amnesty.rst b/...st-practices/oep-0034-bp-lint-amnesty.rst → oeps/archived/oep-0034-bp-lint-amnesty.rst
@@ -13,7 +13,7 @@ OEP-34: Lint Amnesty
 +-----------------+--------------------------------------------------------+
 | Arbiter         | Usama Sadiq <[email protected]>                           |
 +-----------------+--------------------------------------------------------+
-| Status          | Accepted                                               |
+| Status          | Obsolete                                               |
 +-----------------+--------------------------------------------------------+
 | Type            | Best Practice                                          |
 +-----------------+--------------------------------------------------------+
@@ -22,6 +22,11 @@ OEP-34: Lint Amnesty
 | `Review Period` | 2019-03-12 - 2021-04-30                                |
 +-----------------+--------------------------------------------------------+
 
+.. attention::
+
+   This decision was a one time decision and is not relevant to the current
+   active project.
+
 Context
 *******
 

diff --git a/oeps/best-practices/oep-0037-bp-test-data.rst b/oeps/best-practices/oep-0037-bp-test-data.rst
@@ -23,6 +23,7 @@ OEP-37: Dev Data
    * - Review Period
      - 2019-06-19 to 2019-11-25
 
+
 Abstract
 ********
 

diff --git a/oeps/conf.py b/oeps/conf.py
@@ -36,10 +36,14 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.graphviz',
     'sphinx_copybutton',
+    'sphinxext.rediraffe',
 ]
 
 graphviz_output_format = 'svg'
 
+rediraffe_redirects = "redirects.txt"
+rediraffe_branch = 'origin/master'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/oeps/index.rst b/oeps/index.rst
@@ -56,3 +56,17 @@ is no clear code repository where they should reside.
    :caption: Architectural Decisions
 
    architectural-decisions/oep-*
+
+Archived Proposals
+==================
+
+These are older decisions or documents that are no longer relevant to the
+project but that we leave here for posterity and as useful reference if we run
+into similar situations in the future.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Obsolete or Replaced
+
+   archived/oep-*
diff --git a/oeps/redirects.txt b/oeps/redirects.txt
@@ -0,0 +1,10 @@
+"architectural-decisions/oep-0005-arch-containerize-devstack.rst" "archived/oep-0005-arch-containerize-devstack.rst"
+"architectural-decisions/oep-0005/decisions/0001-location-of-decentralized-docs.rst" "archived/oep-0005/decisions/0001-location-of-decentralized-docs.rst"
+"architectural-decisions/oep-0005/decisions/0002-why-decentralized-devstack.rst" "archived/oep-0005/decisions/0002-why-decentralized-devstack.rst"
+"architectural-decisions/oep-0005/decisions/0003-experiment-with-docker-interface.rst" "archived/oep-0005/decisions/0003-experiment-with-docker-interface.rst"
+"architectural-decisions/oep-0005/decisions/0004-data-dump.rst" "archived/oep-0005/decisions/0004-data-dump.rst"
+"architectural-decisions/oep-0005/decisions/0005-centralized-devstack.rst" "archived/oep-0005/decisions/0005-centralized-devstack.rst"
+"architectural-decisions/oep-0012-arch-fragment-views.rst" "archived/oep-0012-arch-fragment-views.rst"
+"best-practices/oep-0007-bp-migrate-to-python3.rst" "archived/oep-0007-bp-migrate-to-python3.rst"
+"best-practices/oep-0034-bp-lint-amnesty.rst" "archived/oep-0034-bp-lint-amnesty.rst"
+"processes/oep-0025-proc-incremental-improvements.rst" "archived/oep-0025-proc-incremental-improvements.rst"
diff --git a/requirements/base.in b/requirements/base.in
@@ -4,4 +4,4 @@
 sphinx
 sphinx-book-theme
 sphinx-copybutton
-
+sphinxext-rediraffe
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -53,6 +53,7 @@ sphinx==4.5.0
     #   pydata-sphinx-theme
     #   sphinx-book-theme
     #   sphinx-copybutton
+    #   sphinxext-rediraffe
 sphinx-book-theme==0.3.3
     # via -r requirements/base.in
 sphinx-copybutton==0.5.1
@@ -69,6 +70,8 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
+sphinxext-rediraffe==0.2.7
+    # via -r requirements/base.in
 urllib3==1.26.14
     # via requests
 zipp==3.15.0

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -96,6 +96,7 @@ sphinx==4.5.0
     #   sphinx-autobuild
     #   sphinx-book-theme
     #   sphinx-copybutton
+    #   sphinxext-rediraffe
 sphinx-autobuild==2021.3.14
     # via -r requirements/dev.in
 sphinx-book-theme==0.3.3
@@ -126,6 +127,8 @@ sphinxcontrib-serializinghtml==1.1.5
     # via
     #   -r requirements/base.txt
     #   sphinx
+sphinxext-rediraffe==0.2.7
+    # via -r requirements/base.txt
 tornado==6.2
     # via livereload
 urllib3==1.26.14