From 020cf7843c7fa530c45acf36162fe086712b7057 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Thu, 2 Mar 2023 14:59:54 -0500 Subject: [PATCH] docs: Move less relevant OEPs to an archived section. Add a small info box to give people context for why the OEPs are in this section. --- .../oep-0005-arch-containerize-devstack.rst | 8 +++++++- .../0001-location-of-decentralized-docs.rst | 0 .../decisions/0002-why-decentralized-devstack.rst | 0 .../0003-experiment-with-docker-interface.rst | 0 .../oep-0005/decisions/0004-data-dump.rst | 0 .../decisions/0005-centralized-devstack.rst | 0 .../oep-0007-bp-migrate-to-python3.rst | 11 ++++++++++- .../oep-0012-arch-fragment-views.rst | 8 +++++++- .../oep-0012/insights-cards.png | Bin .../oep-0012/proposed-instructor-dashboard.png | Bin .../oep-0025-proc-incremental-improvements.rst | 10 +++++++++- oeps/{processes => archived}/oep-0025/INCR_workflow | 0 .../oep-0025/INCR_workflow.png | Bin .../oep-0034-bp-lint-amnesty.rst | 7 ++++++- .../oep-0037-bp-test-data.rst | 6 ++++++ .../oep-0037/decisions/0001-yaml-centralization.rst | 0 .../decisions/0002-remote-dev-data-generation.rst | 0 .../decisions/0003-data-creation-functions.rst | 0 .../0004-defer-remote-dev-data-generation.rst | 0 oeps/index.rst | 6 +++--- 20 files changed, 48 insertions(+), 8 deletions(-) rename oeps/{architectural-decisions => archived}/oep-0005-arch-containerize-devstack.rst (97%) rename oeps/{architectural-decisions => archived}/oep-0005/decisions/0001-location-of-decentralized-docs.rst (100%) rename oeps/{architectural-decisions => archived}/oep-0005/decisions/0002-why-decentralized-devstack.rst (100%) rename oeps/{architectural-decisions => archived}/oep-0005/decisions/0003-experiment-with-docker-interface.rst (100%) rename oeps/{architectural-decisions => archived}/oep-0005/decisions/0004-data-dump.rst (100%) rename oeps/{architectural-decisions => archived}/oep-0005/decisions/0005-centralized-devstack.rst (100%) rename oeps/{best-practices => archived}/oep-0007-bp-migrate-to-python3.rst (98%) rename oeps/{architectural-decisions => archived}/oep-0012-arch-fragment-views.rst (98%) rename oeps/{architectural-decisions => archived}/oep-0012/insights-cards.png (100%) rename oeps/{architectural-decisions => archived}/oep-0012/proposed-instructor-dashboard.png (100%) rename oeps/{processes => archived}/oep-0025-proc-incremental-improvements.rst (97%) rename oeps/{processes => archived}/oep-0025/INCR_workflow (100%) rename oeps/{processes => archived}/oep-0025/INCR_workflow.png (100%) rename oeps/{best-practices => archived}/oep-0034-bp-lint-amnesty.rst (95%) rename oeps/{best-practices => archived}/oep-0037-bp-test-data.rst (99%) rename oeps/{best-practices => archived}/oep-0037/decisions/0001-yaml-centralization.rst (100%) rename oeps/{best-practices => archived}/oep-0037/decisions/0002-remote-dev-data-generation.rst (100%) rename oeps/{best-practices => archived}/oep-0037/decisions/0003-data-creation-functions.rst (100%) rename oeps/{best-practices => archived}/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst (100%) diff --git a/oeps/architectural-decisions/oep-0005-arch-containerize-devstack.rst b/oeps/archived/oep-0005-arch-containerize-devstack.rst similarity index 97% rename from oeps/architectural-decisions/oep-0005-arch-containerize-devstack.rst rename to oeps/archived/oep-0005-arch-containerize-devstack.rst index 8240b9126..62b0d6827 100644 --- a/oeps/architectural-decisions/oep-0005-arch-containerize-devstack.rst +++ b/oeps/archived/oep-0005-arch-containerize-devstack.rst @@ -12,13 +12,19 @@ OEP-5: Pre-built Developer Environments +---------------+----------------------------------------------------+ | Arbiter | Jesse Zoldak | +---------------+----------------------------------------------------+ -| 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/oeps/architectural-decisions/oep-0005/decisions/0001-location-of-decentralized-docs.rst b/oeps/archived/oep-0005/decisions/0001-location-of-decentralized-docs.rst similarity index 100% rename from oeps/architectural-decisions/oep-0005/decisions/0001-location-of-decentralized-docs.rst rename to oeps/archived/oep-0005/decisions/0001-location-of-decentralized-docs.rst diff --git a/oeps/architectural-decisions/oep-0005/decisions/0002-why-decentralized-devstack.rst b/oeps/archived/oep-0005/decisions/0002-why-decentralized-devstack.rst similarity index 100% rename from oeps/architectural-decisions/oep-0005/decisions/0002-why-decentralized-devstack.rst rename to oeps/archived/oep-0005/decisions/0002-why-decentralized-devstack.rst diff --git a/oeps/architectural-decisions/oep-0005/decisions/0003-experiment-with-docker-interface.rst b/oeps/archived/oep-0005/decisions/0003-experiment-with-docker-interface.rst similarity index 100% rename from oeps/architectural-decisions/oep-0005/decisions/0003-experiment-with-docker-interface.rst rename to oeps/archived/oep-0005/decisions/0003-experiment-with-docker-interface.rst diff --git a/oeps/architectural-decisions/oep-0005/decisions/0004-data-dump.rst b/oeps/archived/oep-0005/decisions/0004-data-dump.rst similarity index 100% rename from oeps/architectural-decisions/oep-0005/decisions/0004-data-dump.rst rename to oeps/archived/oep-0005/decisions/0004-data-dump.rst diff --git a/oeps/architectural-decisions/oep-0005/decisions/0005-centralized-devstack.rst b/oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst similarity index 100% rename from oeps/architectural-decisions/oep-0005/decisions/0005-centralized-devstack.rst rename to oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst diff --git a/oeps/best-practices/oep-0007-bp-migrate-to-python3.rst b/oeps/archived/oep-0007-bp-migrate-to-python3.rst similarity index 98% rename from oeps/best-practices/oep-0007-bp-migrate-to-python3.rst rename to oeps/archived/oep-0007-bp-migrate-to-python3.rst index 2ef69db6c..5260cdb08 100644 --- a/oeps/best-practices/oep-0007-bp-migrate-to-python3.rst +++ b/oeps/archived/oep-0007-bp-migrate-to-python3.rst @@ -13,7 +13,7 @@ OEP-7: Migrating to Python 3 +---------------+-----------------------------------------------+ | Arbiter | Christopher Pappas | +---------------+-----------------------------------------------+ -| 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/oeps/architectural-decisions/oep-0012-arch-fragment-views.rst b/oeps/archived/oep-0012-arch-fragment-views.rst similarity index 98% rename from oeps/architectural-decisions/oep-0012-arch-fragment-views.rst rename to oeps/archived/oep-0012-arch-fragment-views.rst index e8f103770..d35bcb4ce 100644 --- a/oeps/architectural-decisions/oep-0012-arch-fragment-views.rst +++ b/oeps/archived/oep-0012-arch-fragment-views.rst @@ -12,7 +12,7 @@ OEP-12: Pluggable User Interfaces +---------------+----------------------------------------------------+ | Arbiter | Clinton Blackburn | +---------------+----------------------------------------------------+ -| 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/oeps/architectural-decisions/oep-0012/insights-cards.png b/oeps/archived/oep-0012/insights-cards.png similarity index 100% rename from oeps/architectural-decisions/oep-0012/insights-cards.png rename to oeps/archived/oep-0012/insights-cards.png diff --git a/oeps/architectural-decisions/oep-0012/proposed-instructor-dashboard.png b/oeps/archived/oep-0012/proposed-instructor-dashboard.png similarity index 100% rename from oeps/architectural-decisions/oep-0012/proposed-instructor-dashboard.png rename to oeps/archived/oep-0012/proposed-instructor-dashboard.png diff --git a/oeps/processes/oep-0025-proc-incremental-improvements.rst b/oeps/archived/oep-0025-proc-incremental-improvements.rst similarity index 97% rename from oeps/processes/oep-0025-proc-incremental-improvements.rst rename to oeps/archived/oep-0025-proc-incremental-improvements.rst index 302b83fb6..7f0150c77 100644 --- a/oeps/processes/oep-0025-proc-incremental-improvements.rst +++ b/oeps/archived/oep-0025-proc-incremental-improvements.rst @@ -12,7 +12,7 @@ OEP-25: Incremental Improvements +-----------------+----------------------------------------------------------+ | Arbiter | Adam Stankiewicz | +-----------------+----------------------------------------------------------+ -| 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 + ` + in the ``public-engineering`` project. + TL;DR ***** diff --git a/oeps/processes/oep-0025/INCR_workflow b/oeps/archived/oep-0025/INCR_workflow similarity index 100% rename from oeps/processes/oep-0025/INCR_workflow rename to oeps/archived/oep-0025/INCR_workflow diff --git a/oeps/processes/oep-0025/INCR_workflow.png b/oeps/archived/oep-0025/INCR_workflow.png similarity index 100% rename from oeps/processes/oep-0025/INCR_workflow.png rename to oeps/archived/oep-0025/INCR_workflow.png diff --git a/oeps/best-practices/oep-0034-bp-lint-amnesty.rst b/oeps/archived/oep-0034-bp-lint-amnesty.rst similarity index 95% rename from oeps/best-practices/oep-0034-bp-lint-amnesty.rst rename to oeps/archived/oep-0034-bp-lint-amnesty.rst index f5686839d..9bd462d58 100644 --- a/oeps/best-practices/oep-0034-bp-lint-amnesty.rst +++ b/oeps/archived/oep-0034-bp-lint-amnesty.rst @@ -13,7 +13,7 @@ OEP-34: Lint Amnesty +-----------------+--------------------------------------------------------+ | Arbiter | Usama Sadiq | +-----------------+--------------------------------------------------------+ -| 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/archived/oep-0037-bp-test-data.rst similarity index 99% rename from oeps/best-practices/oep-0037-bp-test-data.rst rename to oeps/archived/oep-0037-bp-test-data.rst index 8c4eee7ea..14071828b 100644 --- a/oeps/best-practices/oep-0037-bp-test-data.rst +++ b/oeps/archived/oep-0037-bp-test-data.rst @@ -23,6 +23,12 @@ OEP-37: Dev Data * - Review Period - 2019-06-19 to 2019-11-25 + +.. attention:: + + This proposal is deferred as there is no current plans to actively work on + implementing this work. + Abstract ******** diff --git a/oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst b/oeps/archived/oep-0037/decisions/0001-yaml-centralization.rst similarity index 100% rename from oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst rename to oeps/archived/oep-0037/decisions/0001-yaml-centralization.rst diff --git a/oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst b/oeps/archived/oep-0037/decisions/0002-remote-dev-data-generation.rst similarity index 100% rename from oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst rename to oeps/archived/oep-0037/decisions/0002-remote-dev-data-generation.rst diff --git a/oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst b/oeps/archived/oep-0037/decisions/0003-data-creation-functions.rst similarity index 100% rename from oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst rename to oeps/archived/oep-0037/decisions/0003-data-creation-functions.rst diff --git a/oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst b/oeps/archived/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst similarity index 100% rename from oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst rename to oeps/archived/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst diff --git a/oeps/index.rst b/oeps/index.rst index 3d78be24b..4ff8a8afc 100644 --- a/oeps/index.rst +++ b/oeps/index.rst @@ -57,8 +57,8 @@ is no clear code repository where they should reside. architectural-decisions/oep-* -Obsolete Or Replaced -==================== +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 @@ -69,4 +69,4 @@ into similar situations in the future. :glob: :caption: Obsolete or Replaced - obsolete_or_replaced/oep-* + archived/oep-*