diff --git a/README.rst b/README.rst index fc7988767..595f50e3d 100644 --- a/README.rst +++ b/README.rst @@ -11,16 +11,16 @@ that choice. OEPs are not the only way for a change to be made to Open edX, howe the goal is to create a collection of OEP documents as a repository or knowledge archive of large and broadly relevant choices made for the platform. -View the published list of `Open edX Proposals (OEPs)`_ on ReadTheDocs. +View the published list of `Open edX Proposals (OEPs)`_ on docs.openedx.org. -.. _Open edX Proposals (OEPs): https://open-edx-proposals.readthedocs.io +.. _Open edX Proposals (OEPs): https://docs.openedx.org/projects/openedx-proposals/ Getting Started *************** This repository holds a bunch of text files, each of which represents an OEP or supplementary documentation. For browsing these OEPs, we recommend you read them -in `their published form `_ on ReadTheDocs. +in `their published form `_ on docs.openedx.org. Contributing ************ @@ -30,7 +30,7 @@ Please read `How To Contribute `_ for d OEPs are foundational *community* documents. The whole community is invited to collaborate on these documents, from writing to fixing to updating to reviewing. Persons interested -in following OEP progress should join the `#open-edx-proposals Slack channel`_ and/or +in following OEP progress should join the `#openedx-proposals Slack channel`_ and/or follow the `Announcements category in the forums`_. Any member of the community is welcome to propose changes or addendums to existing @@ -38,7 +38,7 @@ OEPs, or to propose a brand new one! All that is needed is to fork this repo and get writing. We use `ReStructured Text (RST)`_ to write all our OEPs, and we discuss all proposed changes and additions on `pull requests`_. -.. _#open-edx-proposals Slack channel: https://openedx.slack.com/archives/C1L370YTZ +.. _#openedx-proposals Slack channel: https://openedx.slack.com/archives/C1L370YTZ .. _Announcements category in the forums: https://discuss.openedx.org/c/announcements/17 .. _ReStructured Text (RST): https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html .. _pull requests: https://docs.openedx.org/en/latest/developers/quickstarts/first_openedx_pr.html @@ -99,10 +99,10 @@ listed in the Code of Conduct text. People ****** -See the `open-edx-proposals Backstage page`_ for more information about who the +See the `openedx-proposals Backstage page`_ for more information about who the maintainers of this repo are and how to get in touch with them. -.. _open-edx-proposals Backstage page: https://backstage.openedx.org/catalog/default/component/open-edx-proposals +.. _openedx-proposals Backstage page: https://backstage.openedx.org/catalog/default/component/openedx-proposals Reporting Security Issues ************************* @@ -111,13 +111,13 @@ Please do not report security issues in public. Please email security@openedx.or .. |license-badge| image:: https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg - :target: https://github.com/openedx/open-edx-proposals/blob/main/LICENSE.txt + :target: https://github.com/openedx/openedx-proposals/blob/main/LICENSE.txt :alt: License -.. |doc-badge| image:: https://readthedocs.org/projects/open-edx-proposals/badge/?version=latest - :target: https://open-edx-proposals.readthedocs.io/en/latest/ +.. |doc-badge| image:: https://readthedocs.org/projects/openedx-proposals/badge/?version=latest + :target: https://docs.openedx.org/projects/openedx-proposals/ :alt: Documentation .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen -.. |contributors-badge| image:: https://img.shields.io/github/contributors/openedx/open-edx-proposals.svg +.. |contributors-badge| image:: https://img.shields.io/github/contributors/openedx/openedx-proposals.svg diff --git a/catalog-info.yaml b/catalog-info.yaml index eafeadb61..81596655f 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -1,15 +1,15 @@ # This file records information about this repo. Its use is described in OEP-55: -# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html +# https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html apiVersion: backstage.io/v1alpha1 # (Required) Acceptable Values: Component, Resource, System # A repo will almost certainly be a Component. kind: Component metadata: - name: 'open-edx-proposals' + name: 'openedx-proposals' description: "Open edX (Enhancement) Proposals" links: - - url: "https://open-edx-proposals.readthedocs.io/en/latest/index.html" + - url: "https://docs.openedx.org/projects/openedx-proposals/" title: "OEP Index" # Backstage uses the MaterialUI Icon Set. # https://mui.com/material-ui/material-icons/ diff --git a/oep-templates/adr-based-template.rst b/oep-templates/adr-based-template.rst index 08247e1f9..50c422e29 100644 --- a/oep-templates/adr-based-template.rst +++ b/oep-templates/adr-based-template.rst @@ -75,4 +75,4 @@ YYYY-MM-DD ========== * Document created -* `Pull request #XXX `_ +* `Pull request #XXX `_ diff --git a/oep-templates/external-link-template.rst b/oep-templates/external-link-template.rst index 41abeae72..fd4b64123 100644 --- a/oep-templates/external-link-template.rst +++ b/oep-templates/external-link-template.rst @@ -70,4 +70,4 @@ YYYY-MM-DD ########## * Document created -* `Pull request #XXX `_ +* `Pull request #XXX `_ diff --git a/oep-templates/pep-based-template.rst b/oep-templates/pep-based-template.rst index e17ff0ba0..22557e769 100644 --- a/oep-templates/pep-based-template.rst +++ b/oep-templates/pep-based-template.rst @@ -103,4 +103,4 @@ YYYY-MM-DD ========== * Document created -* `Pull request #XXX `_ +* `Pull request #XXX `_ diff --git a/oeps/architectural-decisions/oep-0003-arch-async-tasks.rst b/oeps/architectural-decisions/oep-0003-arch-async-tasks.rst index ee64c603b..99305358e 100644 --- a/oeps/architectural-decisions/oep-0003-arch-async-tasks.rst +++ b/oeps/architectural-decisions/oep-0003-arch-async-tasks.rst @@ -229,4 +229,4 @@ Change History 2025-02-02 ========== * Mark OEP as "Accepted", due to the implementation of the proposal in ``django-user-tasks`` -* `Pull request #672 `_ +* `Pull request #672 `_ diff --git a/oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst b/oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst index 03f0cb5a2..f7a015e37 100644 --- a/oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst +++ b/oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst @@ -30,7 +30,7 @@ OEP-15: Course-wide Custom JavaScript | | - `Documentation on course-wide JS/CSS`_ | +---------------+----------------------------------------------------+ -.. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/43 +.. _Original pull request: https://github.com/openedx/openedx-proposals/pull/43 .. _Initial OEP suggestion: https://groups.google.com/d/topic/edx-code/T83TDxhH74E/discussion .. _An edx-code question: https://groups.google.com/d/topic/edx-code/idjPWUIx8Ls/discussion .. _Documentation on course-wide JS/CSS: https://docs.openedx.org/en/latest/educators/how-tos/add_custom_css_or_javascript_code_to_a_course.html @@ -153,16 +153,16 @@ Change History ========== * Mark as accepted -* `PR #693 `_ +* `PR #693 `_ 2022-10-07 ========== * There were differences between the approach described in OEP-15 and the final implemntation in `edx-platform#28411 `_ . This commit updated the OEP to match the latest implementation. -* `PR #396 `_ +* `PR #396 `_ 2017-01-24 ========== * Initial draft -* `PR #43 `_ \ No newline at end of file +* `PR #43 `_ \ No newline at end of file diff --git a/oeps/architectural-decisions/oep-0026-arch-realtime-events.rst b/oeps/architectural-decisions/oep-0026-arch-realtime-events.rst index 8e7c14cd7..fef177016 100644 --- a/oeps/architectural-decisions/oep-0026-arch-realtime-events.rst +++ b/oeps/architectural-decisions/oep-0026-arch-realtime-events.rst @@ -284,19 +284,19 @@ Change History * Mark as accepted * Update to reflect current implementation -* `PR #678 `_ +* `PR #678 `_ 2023-11-06 ========== * Fixed various typos -* `PR #537 `_ +* `PR #537 `_ 2023-04-14 ========== * Replace tCRIL references with Axim references -* `PR #464 `_ +* `PR #464 `_ 2022-11-04 ========== @@ -305,74 +305,74 @@ Change History * Clarify language and update to reflect current thoughts * Remove references to Validator Processor * Change implementation of an LRS from "Deferring implementation" to "Out of scope" -* `PR #405 `_ +* `PR #405 `_ 2022-09-27 ========== * Change arbiter from Brian Wilson to Ed Zarecor -* `PR #386 `_ +* `PR #386 `_ 2022-09-16 ========== * Change Github organization references from edx to openedx -* `PR #376 `_ +* `PR #376 `_ 2021-01-20 - 2022-08-02 ======================= * RsT style cleanup and minor content updates -* `PR #365 `_ -* `PR #248 `_ -* `PR #245 `_ -* `PR #206 `_ +* `PR #365 `_ +* `PR #248 `_ +* `PR #245 `_ +* `PR #206 `_ 2021-04-09 ========== * Change http URLs to https -* `PR #200 `_ +* `PR #200 `_ 2021-01-20 ========== * Clarify when we should build on Django admin vs settings or a self-service portal -* `PR #156 `_ +* `PR #156 `_ 2020-12-07 ========== * Update example code -* `PR #175 `_ +* `PR #175 `_ 2020-09-20 - 2020-09-30 ======================= * Cleaning up links and references -* `PR #162 `_ -* `PR #163 `_ +* `PR #162 `_ +* `PR #163 `_ 2020-06-04 ========== * Significant updates to Caliper documentation -* `PR #152 `_ +* `PR #152 `_ 2019-05-25 ========== * Update title to remove prefixing zeros for consistency -* `PR #115 `_ +* `PR #115 `_ 2019-05-15 ========== * Update anonymized user ID section to unique user id as part of adding OEP-32 -* `PR #103 `_ +* `PR #103 `_ 2019-01-19 ========== * Initial publication -* `PR #73 `_ +* `PR #73 `_ diff --git a/oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst b/oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst index e20a85f33..12dcd7a71 100644 --- a/oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst +++ b/oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst @@ -28,9 +28,9 @@ OEP-30: PII Markup and Auditing | References | - `NIST Special Publication 800-122 (pdf)`_ | +---------------+------------------------------------------------------------+ -.. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/81 -.. _Update pull request: https://github.com/openedx/open-edx-proposals/pull/101 -.. _Second update pull request: https://github.com/openedx/open-edx-proposals/pull/676 +.. _Original pull request: https://github.com/openedx/openedx-proposals/pull/81 +.. _Update pull request: https://github.com/openedx/openedx-proposals/pull/101 +.. _Second update pull request: https://github.com/openedx/openedx-proposals/pull/676 .. _NIST Special Publication 800-122 (pdf): http://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-122.pdf Abstract @@ -337,28 +337,28 @@ Change History * Mark as accepted * Update to reflect current implementation -* `PR #676 `_ +* `PR #676 `_ 2022-09-16 ========== * Change Github organization references from edx to openedx -* `PR #376 `_ +* `PR #376 `_ 2021-01-20 - 2022-08-02 ======================= * RsT style cleanup and minor content updates -* `PR #365 `_ -* `PR #248 `_ -* `PR #245 `_ -* `PR #206 `_ +* `PR #365 `_ +* `PR #248 `_ +* `PR #245 `_ +* `PR #206 `_ 2020-02-19 ========== * Fix code blocks that weren't rendering, and typos -* `PR #134 `_ +* `PR #134 `_ 2019-01-30 ========== @@ -366,16 +366,16 @@ Change History * Update to match reference implementation, add links to it * Break our Organization tool into its own section * Change double colons to single colons in annotation tokens -* `PR #101 `_ +* `PR #101 `_ 2018-11-06 ========== * Change status from Provisional to Draft -* `PR #85 `_ +* `PR #85 `_ 2018-10-09 ========== * Initial draft -* `PR #81 `_ +* `PR #81 `_ diff --git a/oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst b/oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst index f6bd98561..dc9b58cd6 100644 --- a/oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst +++ b/oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst @@ -20,7 +20,7 @@ OEP-32: Unique Identifier for Users * - Status - Needs Revision * - Revision Ticket - - https://github.com/openedx/open-edx-proposals/issues/407 + - https://github.com/openedx/openedx-proposals/issues/407 * - Type - Architecture * - Created @@ -32,7 +32,7 @@ OEP-32: Unique Identifier for Users The guidance for external ids in this OEP is currently incorrect; it has been superseded by `this ADR `_. - The guidance in this OEP is partially correct. It is valid for internal ids, and invalid for external ids. For questions and discussion, please post on `GitHub issue 407 `_. + The guidance in this OEP is partially correct. It is valid for internal ids, and invalid for external ids. For questions and discussion, please post on `GitHub issue 407 `_. Decision ******** @@ -144,5 +144,5 @@ Change History 2024-07-08 ========== * Change status to "Needs Revision" -* `Discussion issue #407 ` -* `Pull request #603 `_ \ No newline at end of file +* `Discussion issue #407 ` +* `Pull request #603 `_ \ No newline at end of file diff --git a/oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst b/oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst index 0ddedd4d3..1a998d978 100644 --- a/oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst +++ b/oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst @@ -19,7 +19,7 @@ OEP-45: Configuring and Operating Open edX * - Status - Needs Revision * - Revision Ticket - - https://github.com/openedx/open-edx-proposals/issues/587 + - https://github.com/openedx/openedx-proposals/issues/587 * - Type - Architecture * - Created @@ -158,7 +158,7 @@ A clear manual of operations will exist in the form of RST files in an ``operati In the same vein as not dictating how operators create and manage their IDA config files, operators will also be expected to manage how they execute the operations documented in the manual. -.. _OEP-19: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html +.. _OEP-19: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0019-bp-developer-documentation.html .. _this commit: https://github.com/openedx-btr-wg/edx-platform/commit/18effd83f983f497ca0a1535108fa41dc50d06a2#diff-ca02329742db0a77612a18ba1260d178R1-R39 @@ -200,7 +200,7 @@ Implementation Strategy Discussion of implentation of this OEP will happen in a `separate Pull Request`_ . -.. _separate Pull Request: https://github.com/openedx/open-edx-proposals/pull/144 +.. _separate Pull Request: https://github.com/openedx/openedx-proposals/pull/144 Related Decisions ***************** @@ -220,4 +220,4 @@ Change History 2024-05-16 ========== * Change status to "Needs Revision" -* `Pull request #586 `_ +* `Pull request #586 `_ diff --git a/oeps/architectural-decisions/oep-0045/decisions/0002-helm-for-multi-instance-k8s.rst b/oeps/architectural-decisions/oep-0045/decisions/0002-helm-for-multi-instance-k8s.rst index 4dad6732a..10e13bbc7 100644 --- a/oeps/architectural-decisions/oep-0045/decisions/0002-helm-for-multi-instance-k8s.rst +++ b/oeps/architectural-decisions/oep-0045/decisions/0002-helm-for-multi-instance-k8s.rst @@ -20,7 +20,7 @@ Despite this, many major commercial Open edX hosting providers have migrated tow .. _Kubernetes: https://kubernetes.io/ .. _Deploying multiple Open edX instances onto a Kubernetes Cluster with Tutor: https://discuss.openedx.org/t/tech-talk-demo-deploying-multiple-open-edx-instances-onto-a-kubernetes-cluster-with-tutor/4641 -.. _decision 0001: https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0045/decisions/0001-tutor-as-replacement-for-edx-configuration.html +.. _decision 0001: https://docs.openedx.org/projects/openedx-proposals/en/latest/architectural-decisions/oep-0045/decisions/0001-tutor-as-replacement-for-edx-configuration.html Decision @@ -35,7 +35,7 @@ As the needs and deployment scale of Open edX operators can vary significantly, The goal is for these Helm charts to be developed and maintained collaboratively, by the Open edX Operators that are using them. All relevant best practices from both the Open edX and Helm projects should be followed from the start, such as `OEP-55 Project Maintainers`_. -.. _OEP-55 Project Maintainers: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html +.. _OEP-55 Project Maintainers: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html .. _Helm Charts: https://helm.sh/ @@ -129,4 +129,4 @@ Change History ========== * Document created -* `Pull request #372 `_ +* `Pull request #372 `_ diff --git a/oeps/architectural-decisions/oep-0048-brand-customization.rst b/oeps/architectural-decisions/oep-0048-brand-customization.rst index a27305a51..aa25ce226 100644 --- a/oeps/architectural-decisions/oep-0048-brand-customization.rst +++ b/oeps/architectural-decisions/oep-0048-brand-customization.rst @@ -109,6 +109,6 @@ Change History 2025-10-10 ========== * Add information about Design Tokens in Paragon 23 -* `Pull request #744 `_ +* `Pull request #744 `_ 2022-10-27: Marked this OEP as Accepted since the recommendations are already widely in use across the platform. diff --git a/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst b/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst index d3318ce0c..dd362c0f9 100644 --- a/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst +++ b/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst @@ -116,33 +116,33 @@ Change History ========== * Removed note about OEP being provisional, as it has been marked as Accepted. -* `Pull request #605 `_ +* `Pull request #605 `_ 2023-05-15 ========== * Added link to event_bus_redis implementation ADR. * Updated OEP status to Accepted. -* `Pull request #477 `_ +* `Pull request #477 `_ 2023-05-12 ========== * Added link to new openedx-events ADR -* `Pull request #478 `_ +* `Pull request #478 `_ 2022-11-29 ========== * Removed disclaimer about provisional ADRs (most have since been accepted) and added follow-up work in References -* `Pull request #414 `_ +* `Pull request #414 `_ 2022-07-11 ========== * Updated formatting. * Updated note about provisional updates, including reference to roadmap item. -* `Pull request #351 `_ +* `Pull request #351 `_ 2022-03-30 ========== @@ -152,7 +152,7 @@ Updated draft as follows: * Moved the Kafka technology choice to a separate edx.org ADR. * Added references and overview of a variety of other event bus related ADRs. * Moved ADR on schema representation to openedx-events, near a number of other event bus related ADRs. -* `Pull request #324 `_ +* `Pull request #324 `_ 2021-08-16 ========== diff --git a/oeps/architectural-decisions/oep-0058-arch-translations-management.rst b/oeps/architectural-decisions/oep-0058-arch-translations-management.rst index b594912e5..df4b110da 100644 --- a/oeps/architectural-decisions/oep-0058-arch-translations-management.rst +++ b/oeps/architectural-decisions/oep-0058-arch-translations-management.rst @@ -275,12 +275,12 @@ Change History 2024-07-25 ========== * Mark OEP as "Accepted", due to the full implementation of the proposal -* `Pull request #610 `_ +* `Pull request #610 `_ 2022-08-08 ========== * Document created -* `Pull request #367 `_ +* `Pull request #367 `_ .. _ecommerce-scripts: https://github.com/openedx/ecommerce-scripts/tree/master/transifex .. _edx-platform: https://github.com/openedx/edx-platform diff --git a/oeps/architectural-decisions/oep-0064-arch-mobile-application-codebase-modernization.rst b/oeps/architectural-decisions/oep-0064-arch-mobile-application-codebase-modernization.rst index 21b2b7bf1..e8e5ed807 100644 --- a/oeps/architectural-decisions/oep-0064-arch-mobile-application-codebase-modernization.rst +++ b/oeps/architectural-decisions/oep-0064-arch-mobile-application-codebase-modernization.rst @@ -98,7 +98,7 @@ Change History ========== * Document created, draft PR opened -* `Pull request #496 `_ +* `Pull request #496 `_ * Updated PR to reflect the latest OEP number and the named release planned * Updates to match conventions and other OEP feedback * Minor styling and formatting updates to document, including final Approved status. \ No newline at end of file diff --git a/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst b/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst index cf2612e3d..172d7d325 100644 --- a/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst +++ b/oeps/architectural-decisions/oep-0065-arch-frontend-composability.rst @@ -455,7 +455,7 @@ We feel that the siloing of micro-frontends, the proliferation of dependencies, .. _paragon: https://github.com/openedx/paragon .. _brand-openedx: https://github.com/openedx/brand-openedx .. _frontend-plugin-framework: https://github.com/openedx/frontend-plugin-framework -.. _depr-process: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html +.. _depr-process: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0021-proc-deprecation.html .. _frontend-template-application: https://github.com/openedx/frontend-template-application .. _LucidChart source: https://lucid.app/lucidchart/8c2db108-7c14-4525-8e3a-d2853db68b9e/edit?invitationId=inv_7a61f692-df0b-465b-8ec1-5a18ce4447ca @@ -488,7 +488,7 @@ Change History ========== * Document created -* `Pull request #575 `_ contains all review feedback. +* `Pull request #575 `_ contains all review feedback. 2024-06-26 ========== diff --git a/oeps/architectural-decisions/oep-0065/decisions/0001-unified-platform-repository.rst b/oeps/architectural-decisions/oep-0065/decisions/0001-unified-platform-repository.rst index bc49763c0..7863c22c5 100644 --- a/oeps/architectural-decisions/oep-0065/decisions/0001-unified-platform-repository.rst +++ b/oeps/architectural-decisions/oep-0065/decisions/0001-unified-platform-repository.rst @@ -138,7 +138,7 @@ Change History ========== * Document created -* `Pull request #598 `_ +* `Pull request #598 `_ 2024-09-13 ========== diff --git a/oeps/architectural-decisions/oep-0065/decisions/0002-frontend-app-migrations.rst b/oeps/architectural-decisions/oep-0065/decisions/0002-frontend-app-migrations.rst index f23c24df1..8e1745690 100644 --- a/oeps/architectural-decisions/oep-0065/decisions/0002-frontend-app-migrations.rst +++ b/oeps/architectural-decisions/oep-0065/decisions/0002-frontend-app-migrations.rst @@ -146,7 +146,7 @@ Change History ========== * Document created -* `Pull request #626 `_ +* `Pull request #626 `_ 2024-09-13 ========== diff --git a/oeps/architectural-decisions/oep-0065/decisions/0003-frontend-projects.rst b/oeps/architectural-decisions/oep-0065/decisions/0003-frontend-projects.rst index af9fde340..c4c2d1b20 100644 --- a/oeps/architectural-decisions/oep-0065/decisions/0003-frontend-projects.rst +++ b/oeps/architectural-decisions/oep-0065/decisions/0003-frontend-projects.rst @@ -141,7 +141,7 @@ Change History ========== * Document created -* `Pull request #626 `_ +* `Pull request #626 `_ 2024-09-13 ========== diff --git a/oeps/architectural-decisions/oep-0065/decisions/frontend-glossary.rst b/oeps/architectural-decisions/oep-0065/decisions/frontend-glossary.rst index f48fa5b57..5d3941773 100644 --- a/oeps/architectural-decisions/oep-0065/decisions/frontend-glossary.rst +++ b/oeps/architectural-decisions/oep-0065/decisions/frontend-glossary.rst @@ -148,4 +148,4 @@ Change History ************** * Document created -* `Pull request #626 `_ +* `Pull request #626 `_ diff --git a/oeps/archived/oep-0005/decisions/0004-data-dump.rst b/oeps/archived/oep-0005/decisions/0004-data-dump.rst index b490ae4a3..b204e2593 100644 --- a/oeps/archived/oep-0005/decisions/0004-data-dump.rst +++ b/oeps/archived/oep-0005/decisions/0004-data-dump.rst @@ -13,7 +13,7 @@ One of the goals for DD is to minimize start time/setup time. Setting up the dat Since this is the beginning of DD, the methods of providing necessary data to a general service's DD has not been established. A generalized solution has been proposed in `OEP-37`_, but it does not yet exist. -.. _OEP-37: https://github.com/openedx/open-edx-proposals/pull/118 +.. _OEP-37: https://github.com/openedx/openedx-proposals/pull/118 Decision diff --git a/oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst b/oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst index 0e3c1ad33..bba7ff302 100644 --- a/oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst +++ b/oeps/archived/oep-0005/decisions/0005-centralized-devstack.rst @@ -26,4 +26,4 @@ Consequences All files/changes related to implementation of Decentralized Devstack will be removed, and the decisions highlighted in decisions 0001 and 0002 are now reversed. .. _Devstack: https://github.com/openedx/devstack -.. _decision 0002: https://open-edx-proposals.readthedocs.io/en/latest/oep-0005/decisions/0002-why-decentralized-devstack.html +.. _decision 0002: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0005/decisions/0002-why-decentralized-devstack.html diff --git a/oeps/archived/oep-0006-arch-context-xblock-fields.rst b/oeps/archived/oep-0006-arch-context-xblock-fields.rst index 07c8b0aad..3a61d138b 100644 --- a/oeps/archived/oep-0006-arch-context-xblock-fields.rst +++ b/oeps/archived/oep-0006-arch-context-xblock-fields.rst @@ -253,7 +253,7 @@ the LTI "context" parameter. Previous discussions of note include: -* https://github.com/openedx/open-edx-proposals/pull/15 +* https://github.com/openedx/openedx-proposals/pull/15 * https://openedx.atlassian.net/browse/PLAT-325 * https://groups.google.com/d/msg/edx-code/ywjXV0wzQiw/FRzaK5nTAgAJ * On 2016-07-08, the author met with several stakeholders from edX (Calen @@ -435,4 +435,4 @@ Change History ========== * Marked as Obsolete, as this was never implemented -* `Pull request #606 `_ \ No newline at end of file +* `Pull request #606 `_ \ No newline at end of file diff --git a/oeps/archived/oep-0007-bp-migrate-to-python3.rst b/oeps/archived/oep-0007-bp-migrate-to-python3.rst index 523186f14..22251be1e 100644 --- a/oeps/archived/oep-0007-bp-migrate-to-python3.rst +++ b/oeps/archived/oep-0007-bp-migrate-to-python3.rst @@ -24,7 +24,7 @@ OEP-7: Migrating to Python 3 | Resolution | `open-edx-proposals#21`_ | +---------------+-----------------------------------------------+ -.. _open-edx-proposals#21: https://github.com/openedx/open-edx-proposals/pull/21#pullrequestreview-18018383 +.. _open-edx-proposals#21: https://github.com/openedx/openedx-proposals/pull/21#pullrequestreview-18018383 .. attention:: diff --git a/oeps/archived/oep-0009-bp-permissions.rst b/oeps/archived/oep-0009-bp-permissions.rst index 4bc455042..9cc4d3e38 100644 --- a/oeps/archived/oep-0009-bp-permissions.rst +++ b/oeps/archived/oep-0009-bp-permissions.rst @@ -280,7 +280,7 @@ shaped the recommendations: * Don't require database migrations or data loads each time a new permission is added or the implementation of one is changed -.. _OEP-3: https://open-edx-proposals.readthedocs.io/en/latest/oeps/oep-0003.html +.. _OEP-3: https://docs.openedx.org/projects/openedx-proposals/en/latest/oeps/oep-0003.html Backward Compatibility @@ -307,4 +307,4 @@ Change History =========== * Status updated to "Replaced by :ref:`OEP-66 User Authorization`" -* `PR #520 `_ +* `PR #520 `_ diff --git a/oeps/archived/oep-0011-bp-FED-technology.rst b/oeps/archived/oep-0011-bp-FED-technology.rst index c32e2dd3b..0f94a978e 100644 --- a/oeps/archived/oep-0011-bp-FED-technology.rst +++ b/oeps/archived/oep-0011-bp-FED-technology.rst @@ -224,7 +224,7 @@ Change History 2023-05-23 ========== * Mark Enzyme as deprecated -* `Pull request #487 `_ +* `Pull request #487 `_ .. Cross-references .. _AMD Modules: https://github.com/amdjs/amdjs-api/wiki/AMD @@ -242,7 +242,7 @@ Change History .. _Greenkeeper: https://greenkeeper.io/ .. _Jest: https://jestjs.io/ .. _JSX: https://facebook.github.io/react/docs/introducing-jsx.html -.. _oep 18: https://open-edx-proposals.readthedocs.io/en/latest/oep-0018-bp-python-dependencies.html +.. _oep 18: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0018-bp-python-dependencies.html .. _package lock: https://docs.npmjs.com/cli/v6/configuring-npm/package-locks .. _React: https://github.com/facebook/react .. _React at edX: https://openedx.atlassian.net/wiki/display/FEDX/React diff --git a/oeps/archived/oep-0012-arch-fragment-views.rst b/oeps/archived/oep-0012-arch-fragment-views.rst index 44b8c3959..85017e1e4 100644 --- a/oeps/archived/oep-0012-arch-fragment-views.rst +++ b/oeps/archived/oep-0012-arch-fragment-views.rst @@ -23,7 +23,7 @@ OEP-12: Pluggable User Interfaces | Resolution | `open-edx-proposals#34`_ | +---------------+----------------------------------------------------+ -.. _open-edx-proposals#34: https://github.com/openedx/open-edx-proposals/pull/34#pullrequestreview-18294926 +.. _open-edx-proposals#34: https://github.com/openedx/openedx-proposals/pull/34#pullrequestreview-18294926 .. attention:: @@ -549,7 +549,7 @@ A list of dated sections that describes a brief summary of each revision of the .. _How we switched our template rendering engine to React: https://engineering.pinterest.com/blog/how-we-switched-our-template-rendering-engine-react .. _Nunjucks Asynchronous Support: https://mozilla.github.io/nunjucks/api.html#asynchronous-support .. _jQuery-XBlock: https://github.com/edx-unsupported/edx-solutions-jquery-xblock -.. _OEP-6 Context-scoped XBlock Fields: https://open-edx-proposals.readthedocs.io/en/latest/oep-0006.html +.. _OEP-6 Context-scoped XBlock Fields: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0006.html .. _Pluggable UI hackathon project: https://github.com/openedx/edx-platform/pull/14122 .. _React Native: https://facebook.github.io/react-native/ .. _Web Components: http://webcomponents.org/ diff --git a/oeps/archived/oep-0016-bp-adopt-bootstrap.rst b/oeps/archived/oep-0016-bp-adopt-bootstrap.rst index 3ab419e3e..8ca0abab7 100644 --- a/oeps/archived/oep-0016-bp-adopt-bootstrap.rst +++ b/oeps/archived/oep-0016-bp-adopt-bootstrap.rst @@ -23,7 +23,7 @@ OEP-16: Bootstrap Adoption | Resolution | `Original pull request`_ | +---------------+---------------------------------------------------+ -.. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/46 +.. _Original pull request: https://github.com/openedx/openedx-proposals/pull/46 Abstract ******** diff --git a/oeps/archived/oep-0023-style-customization.rst b/oeps/archived/oep-0023-style-customization.rst index bc218ab96..4c32fb375 100644 --- a/oeps/archived/oep-0023-style-customization.rst +++ b/oeps/archived/oep-0023-style-customization.rst @@ -204,7 +204,7 @@ References https://openedx.atlassian.net/wiki/spaces/FEDX/pages/112001431/Challenges+with+comprehensive+theming+in+Eucalyptus 7. OEP-16: Bootstrap Adoption - https://github.com/openedx/open-edx-proposals/blob/a0c284c6c5f0f9419df1f5d6730b2a0c8ff26efc/oeps/oep-0016-bp-adopt-bootstrap.rst + https://github.com/openedx/openedx-proposals/blob/a0c284c6c5f0f9419df1f5d6730b2a0c8ff26efc/oeps/oep-0016-bp-adopt-bootstrap.rst 8. edx-bootstrap edx theme https://github.com/openedx/edx-bootstrap/tree/v1.0.3/sass diff --git a/oeps/archived/oep-0025-proc-incremental-improvements.rst b/oeps/archived/oep-0025-proc-incremental-improvements.rst index 490ffa2d2..b3f539fb5 100644 --- a/oeps/archived/oep-0025-proc-incremental-improvements.rst +++ b/oeps/archived/oep-0025-proc-incremental-improvements.rst @@ -25,7 +25,7 @@ OEP-25: Incremental Improvements | `Resolution` | `Original pull request`_ | +-----------------+----------------------------------------------------------+ -.. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/66#pullrequestreview-151034037 +.. _Original pull request: https://github.com/openedx/openedx-proposals/pull/66#pullrequestreview-151034037 .. attention:: @@ -321,10 +321,10 @@ Change History ========== * TL;DR section added to opening of doc. -* `Pull request #168 `_ +* `Pull request #168 `_ 2018-10-09 ========== * Document created -* `Pull request #66 `_ +* `Pull request #66 `_ diff --git a/oeps/archived/oep-0056-proc-architectural-advisory-process.rst b/oeps/archived/oep-0056-proc-architectural-advisory-process.rst index 9e1de8739..5b0599934 100644 --- a/oeps/archived/oep-0056-proc-architectural-advisory-process.rst +++ b/oeps/archived/oep-0056-proc-architectural-advisory-process.rst @@ -214,7 +214,7 @@ Change History ========== * Marked as Obsolete, as this was never implemented -* `Pull request #606 `_ +* `Pull request #606 `_ 2022-03-28 ========== @@ -223,7 +223,7 @@ Change History * Renamed "Decision Maker's Checklist" to "Decision Impact checklist" to be clearer around the role it plays in the process. A separate "decision maker's checklist" may exist to help walk people through the overall AAP. * Added some more cross-links in the document to (hopefully) help readers find information and understand concepts. * Added a section about Discourse forums and the role they (and other mediums) might play in the AAP. -* `Pull request #305 `_ +* `Pull request #305 `_ 2022-03-23 ========== @@ -232,17 +232,17 @@ Change History * Adding "proc" prefix to the filename. * Removing usage of "ADR authors" and "decision authors" in favor of "decision makers" * Clarifying "experts" to be "subject matter experts" -* `Pull request #305 `_ +* `Pull request #305 `_ 2022-02-25 ========== * Ready for review. * Removed sections on "Technical Strategic Review" in favor of focusing solely on the Architecture Advisory Process. This focuses the OEP on tactical architectural decision making, rather than trying to also include a suggestion for how to handle architectural strategic planning. -* `Pull request #305 `_ +* `Pull request #305 `_ 2022-02-09 ========== * Document created. -* `Pull request #305 `_ +* `Pull request #305 `_ diff --git a/oeps/best-practices/oep-0018-bp-python-dependencies.rst b/oeps/best-practices/oep-0018-bp-python-dependencies.rst index 093865cbc..253e3ec22 100644 --- a/oeps/best-practices/oep-0018-bp-python-dependencies.rst +++ b/oeps/best-practices/oep-0018-bp-python-dependencies.rst @@ -25,7 +25,7 @@ OEP-18: Python Dependency Management | `Resolution` | `open-edx-proposals#56 resolution`_ | +-----------------+--------------------------------------------------------+ -.. _open-edx-proposals#56 resolution: https://github.com/openedx/open-edx-proposals/pull/56#pullrequestreview-116976355 +.. _open-edx-proposals#56 resolution: https://github.com/openedx/openedx-proposals/pull/56#pullrequestreview-116976355 .. contents:: :local: @@ -500,7 +500,7 @@ Change History * Note that URL-specified dependencies subvert the upgrade process * Add requirement that URL-specified dependencies be accompanied with a comment linking to a follow-up issue -* `Pull request #450 `_ +* `Pull request #450 `_ 2021-04-30 ========== @@ -510,22 +510,22 @@ Change History * Use syntax highlighting for code blocks only where appropriate * Remove reference to deprecated `owner` field from OEP-2 * Remove reference to dead site "allmychanges" -* `Pull request #211 `_ +* `Pull request #211 `_ 2019-02-20 ========== * Remind that pip ignores transitive URL-based dependencies -* `Pull request #106 `_ +* `Pull request #106 `_ 2018-10-18 ========== * Add tip about ``pip compile -v`` -* `Pull request #82 `_ +* `Pull request #82 `_ 2018-05-02 ========== * Document created -* `Pull request #56 `_ +* `Pull request #56 `_ diff --git a/oeps/best-practices/oep-0019-bp-developer-documentation.rst b/oeps/best-practices/oep-0019-bp-developer-documentation.rst index c5eb63720..835255543 100644 --- a/oeps/best-practices/oep-0019-bp-developer-documentation.rst +++ b/oeps/best-practices/oep-0019-bp-developer-documentation.rst @@ -62,14 +62,14 @@ Decisions * The `developer section`_ of docs.openedx.org will contain the main index for all repo specific and system wide developer docs. -* System wide decisions, best practices and processes will live in the `open-edx-proposals`_ repository. +* System wide decisions, best practices and processes will live in the `openedx-proposals`_ repository. * ADRs, How Tos and other single repo impacting docs will live in a ``/docs`` folder in the impacted repo. * edX Inc. specific documentation such as notes, agile meeting artifacts, and documentation of edX specific process and decisions will live in `Confluence`_. .. _developer section: https://docs.openedx.org/en/latest/developers -.. _open-edx-proposals: https://github.com/openedx/open-edx-proposals +.. _openedx-proposals: https://github.com/openedx/openedx-proposals .. _Open API: https://www.openapis.org/ .. _MDX: https://mdxjs.com/ @@ -106,13 +106,13 @@ OEPs * - **Rationale** - To establish software development coherency and efficiency with minimal centralized governance across a long-term maintained platform. * - **Location in GitHub** - - Stored and reviewed in the `open-edx-proposals`_ GitHub repo; published to `Open edX Proposals Read The Docs`_. + - Stored and reviewed in the `openedx-proposals`_ GitHub repo; published to `Open edX Proposals Read The Docs`_. * - **Maintenance** - OEP-1_ describes the OEP review process. They will be maintained by the `edX Architecture team`_. -.. _open-edx-proposals: https://github.com/openedx/open-edx-proposals -.. _Open edX Proposals Read The Docs: https://open-edx-proposals.readthedocs.io -.. _OEP-1: https://open-edx-proposals.readthedocs.io/en/latest/oep-0001.html +.. _openedx-proposals: https://github.com/openedx/openedx-proposals +.. _Open edX Proposals Read The Docs: https://docs.openedx.org/projects/openedx-proposals +.. _OEP-1: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0001.html .. _edX Architecture team: https://openedx.atlassian.net/wiki/spaces/AC/pages/439353453/Architecture+Team .. _ADRs: @@ -302,7 +302,7 @@ This section summarizes the requirements for long-term developer documentation. * For system-wide documentation: - * OEPs_ will live within the open-edx-proposals_ repo. + * OEPs_ will live within the openedx-proposals_ repo. * If other system-wide documentation is needed, they will live within the developer section of the `docs.openedx.org repo`. * **Exported Diagrams**. In order to keep diagrams updated across time, they will need to be exported from whichever tool they were created in, with the exported version maintained in GitHub. @@ -481,12 +481,12 @@ Change History * Remove references to the deprecated edx-developer docs. * Also update references to docs.edx.org to docs.openedx.org. -* `Pull request #411 `_ +* `Pull request #411 `_ 2022-09-22 ---------- -* `Tweaks to ADR template `_ +* `Tweaks to ADR template `_ 2022-06-22 ---------- @@ -497,4 +497,4 @@ Change History ---------- * Add ADR template, add Change History section -* `Pull request #340 `_ +* `Pull request #340 `_ diff --git a/oeps/best-practices/oep-0037-bp-test-data.rst b/oeps/best-practices/oep-0037-bp-test-data.rst index ad729b758..b39816c8f 100644 --- a/oeps/best-practices/oep-0037-bp-test-data.rst +++ b/oeps/best-practices/oep-0037-bp-test-data.rst @@ -58,9 +58,9 @@ Once PII has been removed, an attempt can be made to export just the needed data Note that if the following recommendations on creating data are followed, test data created for a unit test can be fairly easily re-purposed for use as development environment data sets. This can be useful because the starting point is already free of PII and has been verified by tests to work as intended. -.. _PII: https://open-edx-proposals.readthedocs.io/en/latest/oep-0030-arch-pii-markup-and-auditing.html +.. _PII: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0030-arch-pii-markup-and-auditing.html .. _dj_anonymizer: https://github.com/preply/dj_anonymizer -.. _OEP-30: https://open-edx-proposals.readthedocs.io/en/latest/oep-0030-arch-pii-markup-and-auditing.html +.. _OEP-30: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0030-arch-pii-markup-and-auditing.html .. _django-fixture-magic: https://github.com/davedash/django-fixture-magic Creating Data @@ -199,4 +199,4 @@ A list of dated sections that describes a brief summary of each revision of the ========== * Add "Deferred" to the title of the OEP to more clearly indicate the status of this OEP. -* `Pull request #674 `_ +* `Pull request #674 `_ diff --git a/oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst b/oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst index 3b0ada4e8..bac5b2588 100644 --- a/oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst +++ b/oeps/best-practices/oep-0037/decisions/0001-yaml-centralization.rst @@ -31,4 +31,4 @@ Rejected Alternatives Put Data yaml files in each individual IDA's repo, this is rejected cause this would make it harder for developers to know what is being created if they have to go look at yaml files in each IDA. -.. _OEP-37: https://github.com/openedx/open-edx-proposals/pull/118 +.. _OEP-37: https://github.com/openedx/openedx-proposals/pull/118 diff --git a/oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst b/oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst index 799cf8bc8..53416fca8 100644 --- a/oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst +++ b/oeps/best-practices/oep-0037/decisions/0002-remote-dev-data-generation.rst @@ -27,4 +27,4 @@ Consequences - There will be more coupling between different YAML files -.. _OEP-37: https://github.com/openedx/open-edx-proposals/pull/118 +.. _OEP-37: https://github.com/openedx/openedx-proposals/pull/118 diff --git a/oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst b/oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst index f082214e5..855af5492 100644 --- a/oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst +++ b/oeps/best-practices/oep-0037/decisions/0003-data-creation-functions.rst @@ -27,4 +27,4 @@ Consequences -.. _OEP-37: https://github.com/openedx/open-edx-proposals/pull/118 +.. _OEP-37: https://github.com/openedx/openedx-proposals/pull/118 diff --git a/oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst b/oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst index f93f9fa59..c2282aaf1 100644 --- a/oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst +++ b/oeps/best-practices/oep-0037/decisions/0004-defer-remote-dev-data-generation.rst @@ -36,4 +36,4 @@ Consequences - `OEP-37`_ shall be marked as deferred for now until it is ready to be picked up again. -.. _OEP-37: https://github.com/openedx/open-edx-proposals/pull/118 +.. _OEP-37: https://github.com/openedx/openedx-proposals/pull/118 diff --git a/oeps/best-practices/oep-0038-Data-Modeling.rst b/oeps/best-practices/oep-0038-Data-Modeling.rst index a52cd3a58..a22ba1d63 100644 --- a/oeps/best-practices/oep-0038-Data-Modeling.rst +++ b/oeps/best-practices/oep-0038-Data-Modeling.rst @@ -282,7 +282,7 @@ Models should be Annotated for PII - All models in the Open edX ecosystem should be tagged for PII using `code annotations`_ by following OEP-30_. .. _code annotations: https://github.com/openedx/code-annotations> -.. _OEP-30: https://github.com/openedx/open-edx-proposals/blob/master/oeps/oep-0030-arch-pii-markup-and-auditing.rst +.. _OEP-30: https://github.com/openedx/openedx-proposals/blob/master/oeps/oep-0030-arch-pii-markup-and-auditing.rst Have sane default values diff --git a/oeps/best-practices/oep-0042-bp-authentication.rst b/oeps/best-practices/oep-0042-bp-authentication.rst index 4dd0421f0..ab845505e 100644 --- a/oeps/best-practices/oep-0042-bp-authentication.rst +++ b/oeps/best-practices/oep-0042-bp-authentication.rst @@ -284,7 +284,7 @@ References * `Architectural Decision Records (ADRs)`_ -.. _Architectural Decision Records (ADRs): https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#adrs +.. _Architectural Decision Records (ADRs): https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0019-bp-developer-documentation.html#adrs Change History diff --git a/oeps/best-practices/oep-0049-django-app-patterns.rst b/oeps/best-practices/oep-0049-django-app-patterns.rst index fc4fab6bf..9eb470b94 100644 --- a/oeps/best-practices/oep-0049-django-app-patterns.rst +++ b/oeps/best-practices/oep-0049-django-app-patterns.rst @@ -66,7 +66,7 @@ README.rst Each app should contain a README.rst to explain its use. See full details of what should go in the README.rst in OEP-0019_. -.. _OEP-0019: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#readmes +.. _OEP-0019: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0019-bp-developer-documentation.html#readmes .. _apps.py: @@ -258,7 +258,7 @@ This should be an architectural decision record (ADR) describing the decision be If this is the only app in the repository, this ADR should just be a stub linking to the full ADR in `0001-purpose-of-this-repo.rst` (see `TODOs after running cookiecutter`_). -.. _ADRs section of OEP-0019: https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#adrs +.. _ADRs section of OEP-0019: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0019-bp-developer-documentation.html#adrs .. _TODOs after running cookiecutter: https://github.com/openedx/edx-cookiecutters#3-todos-after-running-cookiecutter Consequences diff --git a/oeps/best-practices/oep-0051-bp-conventional-commits.rst b/oeps/best-practices/oep-0051-bp-conventional-commits.rst index 96290a9d4..76c0b0356 100644 --- a/oeps/best-practices/oep-0051-bp-conventional-commits.rst +++ b/oeps/best-practices/oep-0051-bp-conventional-commits.rst @@ -133,7 +133,7 @@ Include references or links to supporting information, such as Jira or GitHub is Larger decisions should be recorded in Architectural Decision Records, as explained in `OEP-0019`__. -__ https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html#adrs +__ https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0019-bp-developer-documentation.html#adrs Footer ====== @@ -255,5 +255,5 @@ Change History .. _Conventional Commits: https://www.conventionalcommits.org -.. _Change Transparency: https://github.com/openedx/open-edx-proposals/pull/180 +.. _Change Transparency: https://github.com/openedx/openedx-proposals/pull/180 .. _Angular commit message format: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format diff --git a/oeps/best-practices/oep-0066-bp-authorization.rst b/oeps/best-practices/oep-0066-bp-authorization.rst index b3eb513b5..5292d4c43 100644 --- a/oeps/best-practices/oep-0066-bp-authorization.rst +++ b/oeps/best-practices/oep-0066-bp-authorization.rst @@ -589,17 +589,17 @@ Change History * Update django_comment_client_role section * Add draft course_roles section -* `Pull request #556 `_ +* `Pull request #556 `_ 2023-10-23 ---------- * PR comment updates - add additional diagram, add information from `Authorization Architecture Vision & Principles`_ -* `Pull request #520 `_ +* `Pull request #520 `_ 2023-08-21 ---------- * Document created -* `Pull request #520 `_ +* `Pull request #520 `_ diff --git a/oeps/best-practices/oep-0067-bp-tools-and-technology.rst b/oeps/best-practices/oep-0067-bp-tools-and-technology.rst index 4c66abc31..cd62c39a9 100644 --- a/oeps/best-practices/oep-0067-bp-tools-and-technology.rst +++ b/oeps/best-practices/oep-0067-bp-tools-and-technology.rst @@ -25,7 +25,7 @@ OEP-67: Standard Tools and Technologies * - Review Period - 2023-09-05 - 2023-10-10 * - Resolution - - * https://github.com/openedx/open-edx-proposals/pull/518 + - * https://github.com/openedx/openedx-proposals/pull/518 * - References - :ref:`OEP-11 Front End Technology Standards` @@ -378,29 +378,29 @@ Change History * Add note encouraging CSS Variables instead of SCSS * Remove note about the Tech Radar as it is deprecated (`DEPR ticket `_) -* `Pull request #675 `_ +* `Pull request #675 `_ 2025-01-30 ========== * Updated "edX"-specific language to "Open edX" where applicable * Removed and/or updated author notes from when the OEP was being written -* `Pull request #666 `_ +* `Pull request #666 `_ 2024-07-25 ========== * Added "Development dependencies should be separated into devDependencies" -* `Pull request #615 `_ +* `Pull request #615 `_ * Changed guidance on React state/data loading to recommend React Query instead of Redux * Updated JavaScript/TypeScript guidance -* `Pull request #616 `_ +* `Pull request #616 `_ 2023-09-05 ========== * Document created -* `Pull request #518 `_ +* `Pull request #518 `_ 2024-05-23 ========== diff --git a/oeps/conf.py b/oeps/conf.py index e35751351..092a05ec0 100644 --- a/oeps/conf.py +++ b/oeps/conf.py @@ -66,8 +66,8 @@ html_context = { "display_github": True, # Integrate GitHub - "github_user": "edx", # Username - "github_repo": "open-edx-proposals", # Repo name + "github_user": "openedx", # Username + "github_repo": "openedx-proposals", # Repo name "github_version": "master", # Version "conf_py_path": "/oeps/", # Path in the checkout to the docs root } @@ -134,7 +134,7 @@ html_theme = 'sphinx_book_theme' html_theme_options = { - "repository_url": "https://github.com/openedx/open-edx-proposals", + "repository_url": "https://github.com/openedx/openedx-proposals", "repository_branch": "master", "path_to_docs": "oeps", "use_repository_button": True, diff --git a/oeps/processes/oep-0001.rst b/oeps/processes/oep-0001.rst index 000e17e7b..184a30646 100644 --- a/oeps/processes/oep-0001.rst +++ b/oeps/processes/oep-0001.rst @@ -37,11 +37,11 @@ OEP-1: OEP Purpose and Guidelines | | - Similar in principle to `Architecture Decision Records`_ | +---------------+--------------------------------------------------------------+ -.. _open-edx-proposals#1: https://github.com/openedx/open-edx-proposals/pull/1 -.. _open-edx-proposals#53: https://github.com/openedx/open-edx-proposals/pull/53 -.. _open-edx-proposals#60: https://github.com/openedx/open-edx-proposals/pull/60 -.. _open-edx-proposals#85: https://github.com/openedx/open-edx-proposals/pull/85 -.. _open-edx-proposals#1 resolution: https://github.com/openedx/open-edx-proposals/pull/1#issuecomment-220419055 +.. _open-edx-proposals#1: https://github.com/openedx/openedx-proposals/pull/1 +.. _open-edx-proposals#53: https://github.com/openedx/openedx-proposals/pull/53 +.. _open-edx-proposals#60: https://github.com/openedx/openedx-proposals/pull/60 +.. _open-edx-proposals#85: https://github.com/openedx/openedx-proposals/pull/85 +.. _open-edx-proposals#1 resolution: https://github.com/openedx/openedx-proposals/pull/1#issuecomment-220419055 .. _PEP: https://www.python.org/dev/peps/pep-0001/ .. _Architecture Decision Records: https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions @@ -56,7 +56,7 @@ Overview community process that the Open edX community has agreed should be adopted by the project. * OEPs are not used to dictate small decisions made in every day feature work. - See `OEP-19 `_ + See `OEP-19 `_ for more detail. * This document specifies both how to write an OEP and how to get to a consensus throughout the community that the OEP should be accepted. @@ -209,7 +209,7 @@ available number. The pull request title should be of the form "OEP-XXXX: ", where *XXXX* is the OEP number claimed for the included proposal. -.. _central OEP repository: https://github.com/openedx/open-edx-proposals +.. _central OEP repository: https://github.com/openedx/openedx-proposals Step 3. Review with Arbiter --------------------------- @@ -220,7 +220,7 @@ is achieved, announce the OEP to the community in the following channels: * Create a topic in the `Announcements - Architecture category`_ in Discourse, with "OEP", its number and its title in the subject line. -* `#open-edx-proposals Slack channel`_. +* `#openedx-proposals Slack channel`_. The Open edX community is given the opportunity to comment on the OEP. The Arbiter serves to keep the discussion on track and to bring the review @@ -234,14 +234,14 @@ wording/status change to an existing OEP, or the addition of a new ADR to an OEP - please announce the change: #. Announce the merge - and briefly describe the change - in the - `#open-edx-proposals Slack channel`_. + `#openedx-proposals Slack channel`_. #. If applicable, announce to an appropriate working group in Slack or at an upcoming working group meeting. #. If applicable, close the associated GitHub ticket(s) associated with the change. .. _Announcements - Architecture category: https://discuss.openedx.org/c/announcements/architecture -.. _#open-edx-proposals Slack channel: https://openedx.slack.com/messages/C1L370YTZ/details/ +.. _#openedx-proposals Slack channel: https://openedx.slack.com/messages/C1L370YTZ/details/ OEP Status ========== @@ -323,7 +323,7 @@ that this particular one requires some renewed attention. When changing status to "Needs Revision", a row titled "Revision Ticket" should be added to the preamble (directly under the status field) that directs to the -GitHub issue or draft pull request in the ``open-edx-proposals`` repository that +GitHub issue or draft pull request in the ``openedx-proposals`` repository that describes what about the OEP that needs revisioning. Rejecting an OEP @@ -378,7 +378,7 @@ document, and assist in linking Authors with Arbiters when needed. Submitting OEP Updates ---------------------- -Once an OEP has merged to the open-edx-proposals repository (which can +Once an OEP has merged to the openedx-proposals repository (which can happen when the OEP is in any status, including "Under Review"), changes can be suggested to it via new pull requests. Whether those changes are included is up to the Authors of the OEP. @@ -389,7 +389,7 @@ Unpublished OEPs Sometimes an OEP is written but ultimately abandoned before being merged. These can be found in closed, unmerged, PRs (see the list `here`_). -.. _here: https://github.com/openedx/open-edx-proposals/pulls?q=is%3Apr+is%3Aclosed+is%3Aunmerged +.. _here: https://github.com/openedx/openedx-proposals/pulls?q=is%3Apr+is%3Aclosed+is%3Aunmerged Updating Best Practice and Process OEPs --------------------------------------- @@ -483,9 +483,9 @@ for use: * `External link template`_ for OEPs with mostly external content. -.. _PEP-based template: https://github.com/openedx/open-edx-proposals/tree/master/oep-templates/pep-based-template.rst -.. _ADR-based template: https://github.com/openedx/open-edx-proposals/tree/master/oep-templates/adr-based-template.rst -.. _External link template: https://github.com/openedx/open-edx-proposals/tree/master/oep-templates/external-link-template.rst +.. _PEP-based template: https://github.com/openedx/openedx-proposals/tree/master/oep-templates/pep-based-template.rst +.. _ADR-based template: https://github.com/openedx/openedx-proposals/tree/master/oep-templates/adr-based-template.rst +.. _External link template: https://github.com/openedx/openedx-proposals/tree/master/oep-templates/external-link-template.rst OEP Header Preamble @@ -590,36 +590,36 @@ Change History 2024-07-25 ========== * Add guidance on announcing changes (new as well as changed OEPs and ADRs) -* `Pull request #602 `_ +* `Pull request #602 `_ 2024-07-08 ========== * Reflect reality that rejected or withdrawn proposals are frequently left unmerged even though OEP-1 calls for it. * Remove "Rejected" status, as it is unused. -* `Pull request #601 `_ +* `Pull request #601 `_ 2024-06-25 ========== * Remove "Withdrawn" status -* `Pull request #597 `_ +* `Pull request #597 `_ 2024-05-16 ========== * Add a "Needs Revision" status -* `Pull request #586 `_ +* `Pull request #586 `_ 2022-10-05 ========== * Require OEPs merged as "Draft" or "Provisional" to provide a reference for "Follow Up Work" with a link to a rollout doc, follow up PR, or similar. -* `Pull request #387 `_ -* `Pull request #391 `_ +* `Pull request #387 `_ +* `Pull request #391 `_ 2022-09-23 ========== * Move OEP templates to a top-level directory for better discoverability -* `Pull request #382 `_ +* `Pull request #382 `_ 2022-06-22 ========== @@ -631,7 +631,7 @@ Change History ========== * Clarify what is currently meant by "Architecture Group" (not an official team right now) -* `Pull request #326 `_ +* `Pull request #326 `_ 2022-02-27 ========== @@ -642,32 +642,32 @@ Multiple changes. * Codify the "Change History" section, which most OEPs already use * Specify that entries should link to the discussion PR. - * `Pull request #297 `_ + * `Pull request #297 `_ #. * Add Overview section for greater clarity - * `Pull request #298 `_ + * `Pull request #298 `_ #. * Add an at-a-glance section for the Arbiter role - * `Pull request #299 `_ + * `Pull request #299 `_ #. * Codify that Process OEPs may be updated - * `Pull request #300 `_ + * `Pull request #300 `_ #. * Clarified OEP update procedures - * `Pull request #301 `_ + * `Pull request #301 `_ #. * Switch author-ownership model to a community-stewardship one - * `Pull request #302 `_ + * `Pull request #302 `_ 2022-01-13 ========== @@ -675,26 +675,26 @@ Multiple changes. * Codifying that choosing an Arbiter, in practice, is done by the OEP Author(s) * Remove authority for assiting with arbitration and the overall process from the edX internal architecture team to the Open edX community architecture group -* `Pull request #284 `_ +* `Pull request #284 `_ 2020-10-01 ========== * Add a new "Obsolete" status to OEPs -* `Pull request #246 `_ +* `Pull request #246 `_ 2019-08-27 ========== * Changed announcement process from email to Discourse. * Minor clarifications to wording. -* `Pull request #123 `_ +* `Pull request #123 `_ 2018-11-06 ========== * Added a new "Provisional" status. -* `Pull request #85 `_ +* `Pull request #85 `_ 2018-05-05 ========== @@ -710,7 +710,7 @@ Multiple changes. * Support alternative simpler templates. * Refactored description for OEP status and review. -* `Pull request #60 `_ +* `Pull request #60 `_ 2018-02-05 ========== @@ -731,7 +731,7 @@ Multiple changes. * Append type and brief title to an OEP's file name. * Remove "Product Enhancement" proposal type. * Remove support for Google Docs for discussion. -* `Pull request #53 `_ +* `Pull request #53 `_ 2016-10-11 ========== @@ -744,17 +744,17 @@ Multiple changes. * Add support for Google Docs and other external forums for discussion of the proposal. * Add "References" field to the preamble. -* `Pull request #17 `_ +* `Pull request #17 `_ 2016-08-24 ========== * Add a definition of the *Change History* section. * Add a copyright notice. -* `Pull request #19 `_ +* `Pull request #19 `_ 2016-05-16 ========== * Document created -* `Pull request #1 `_ +* `Pull request #1 `_ diff --git a/oeps/processes/oep-0010-proc-openedx-releases.rst b/oeps/processes/oep-0010-proc-openedx-releases.rst index b05454a9f..23eb6ed35 100644 --- a/oeps/processes/oep-0010-proc-openedx-releases.rst +++ b/oeps/processes/oep-0010-proc-openedx-releases.rst @@ -23,7 +23,7 @@ OEP-10: Open edX Releases | Resolution | `Original pull request`_ | +---------------+---------------------------------------------------+ -.. _Original pull request: https://github.com/openedx/open-edx-proposals/pull/26 +.. _Original pull request: https://github.com/openedx/openedx-proposals/pull/26 .. - Expectations for component owners @@ -186,7 +186,7 @@ Change History ========== * Updated the link to the Google sheets calendar -* `Pull request #731 `_ +* `Pull request #731 `_ 2025-05-23 @@ -195,7 +195,7 @@ Change History * Update the naming convention for release branches * Remove mention of Devstack as a supported development environment * Clarify that Tutor is suitable for production environments -* `Pull request #712 `_ +* `Pull request #712 `_ 2023-09-28 @@ -203,28 +203,28 @@ Change History * Reference catalog-info.yaml instead of OEP-2 for where we store release metadata. -* `Pull request #526 `_ +* `Pull request #526 `_ 2022-02-24 ========== * Remove info about older installation methods that are no longer relevant. -* `Pull request #452 `_ +* `Pull request #452 `_ 2020-04-26 ========== * Added the "maybe" key for "openedx-release". -* `Pull request #145 `_ +* `Pull request #145 `_ 2018-08-22 ========== * Installation details adjusted to match current Hawthorn realities. -* `Pull request #78 `_ +* `Pull request #78 `_ 2016-11-21 ========== * Document created -* `Pull request #26 `_ +* `Pull request #26 `_ diff --git a/oeps/processes/oep-0014-proc-archive-repos.rst b/oeps/processes/oep-0014-proc-archive-repos.rst index efbb36154..139008cc2 100644 --- a/oeps/processes/oep-0014-proc-archive-repos.rst +++ b/oeps/processes/oep-0014-proc-archive-repos.rst @@ -51,7 +51,7 @@ When a repository under the `openedx organization`_ will no longer be maintained This process is not for repositories that are currently still in use by either the latest release or the master branches of the Open edX platform. If a repository is in use, but planned to be removed, it should go through the `deprecation process`_ and when that is completed it can be archived as described by the process below. -.. _deprecation process: https://open-edx-proposals.readthedocs.io/en/latest/oep-0021-proc-deprecation.html +.. _deprecation process: https://docs.openedx.org/projects/openedx-proposals/en/latest/oep-0021-proc-deprecation.html Transfer to New Owner if Interest @@ -59,7 +59,7 @@ Transfer to New Owner if Interest First, if the repository is public, and a part of Open edX releases, follow these steps to see if anyone would like to take ownership of it: -1. Post a notice to `Open edX Deprecation Announcements`_ announcing that the repository will be archived, and inquiring if anyone would like to take ownership of the repo. Cross post to the ``#general`` and ``#open-edx-proposals`` channels in the `Open edX slack`_. If there are no responses after 2 work days, skip to `Archive Steps`_. +1. Post a notice to `Open edX Deprecation Announcements`_ announcing that the repository will be archived, and inquiring if anyone would like to take ownership of the repo. Cross post to the ``#general`` and ``#openedx-proposals`` channels in the `Open edX slack`_. If there are no responses after 2 work days, skip to `Archive Steps`_. 2. If someone does wish to take ownership of the repository, post a new notice to `Open edX Deprecation Announcements`_, clearly indicating who the new proposed owner is, how much time they have to spend maintaining the repo, and when the transfer will take place. Cross post in the above mentioned Slack channels. Wait at least 2 business days before proceeding. diff --git a/oeps/processes/oep-0021-proc-deprecation.rst b/oeps/processes/oep-0021-proc-deprecation.rst index 46682807a..838a6410d 100644 --- a/oeps/processes/oep-0021-proc-deprecation.rst +++ b/oeps/processes/oep-0021-proc-deprecation.rst @@ -241,71 +241,71 @@ Change History 2025-05-23 ========== * Clarify that "ticket" in this context refers to a GitHub ticket made using the DEPR template. -* `Pull request #711 `_ +* `Pull request #711 `_ 2025-04-28 ========== * Restore and update the Discourse announcement template. -* `Pull request #704 `_ +* `Pull request #704 `_ 2025-04-15 ========== * Updated process with new workflow states * Simplified document for greater clarity and conciseness -* `Pull request #660 `_ +* `Pull request #660 `_ 2024-04-12 ========== * Changed process to require every DEPR have a coordinator. -* `Pull request #576 `_ +* `Pull request #576 `_ 2023-06-21 ========== * Update Discourse template to describe how to stay up to date on removal status. -* `Pull request #500 `_ +* `Pull request #500 `_ 2022-11-01 ========== * Simplified guidance around the earliest named release and removal dates. * Clarify that proposal can be made while incomplete, as long as they aren't communicated until they are complete. -* `Pull request #404 `_ +* `Pull request #404 `_ 2022-07-05 ========== * Add suggestion for monitoring. -* `Pull request #350 `_ +* `Pull request #350 `_ 2022-06-03 ========== * Suggest alignment with release cycle -* `Pull request #252 `_ +* `Pull request #252 `_ 2022-02-08 ========== * Migrate from Jira to GitHub Issues/Projects -* `Pull request #280 `_ +* `Pull request #280 `_ 2021-04-26 ========== * "Removal dates" has become synonymous with "Accepted dates", so we are eliminating them to clarify the process. -* `Pull request #207 `_ +* `Pull request #207 `_ 2021-02-05 ========== * Added TL;DR section and workflow visuals -* `Pull request #176 `_ +* `Pull request #176 `_ 2019-01-02 ========== * Recommend codebase impact review as part of DEPR process -* `Pull request #95 `_ +* `Pull request #95 `_ 2018-11-02 ========== @@ -313,10 +313,10 @@ Change History * Describes the process in specific ordered steps for one to follow. * Adds references to external docs. * Updates information on the JIRA ticketing process. -* `Pull request #83 `_ +* `Pull request #83 `_ 2018-06-21 ========== * Document created -* `Pull request #63 `_ +* `Pull request #63 `_ diff --git a/oeps/processes/oep-0054-core-contributors.rst b/oeps/processes/oep-0054-core-contributors.rst index 630d3e84d..86f1013ba 100644 --- a/oeps/processes/oep-0054-core-contributors.rst +++ b/oeps/processes/oep-0054-core-contributors.rst @@ -443,43 +443,43 @@ Change History * Clarify that CC nominations must provide supporting evidence that candidate has demonstrated the 3C's -* `Pull request #355 `_ +* `Pull request #355 `_ 2022-06-08 ========== * Add link to the runbooks guide for onboarding new CCs -* `Pull request #335 `_ +* `Pull request #335 `_ 2022-02-28 ========== * Elaborate on CC's responsibilities to fulfill their commitment -* `Pull request #304 `_ +* `Pull request #304 `_ 2022-02-16 ========== * Added clarifications around the voting process for new CC members. -* `Pull request #293 `_ +* `Pull request #293 `_ 2022-02-11 ========== * Specify how to expand responsibilities for roles with fine-grained permissions (such as code committers) -* `Pull request #296 `_ +* `Pull request #296 `_ 2022-02-04 ========== * Procedures to remove CCs added. -* `Pull request #292 `_ +* `Pull request #292 `_ 2021-12-20 ========== * Document created. -* `Pull request #275 `_ +* `Pull request #275 `_ .. _Code of Conduct: https://openedx.org/code-of-conduct/ diff --git a/oeps/processes/oep-0055-proc-project-maintainers.rst b/oeps/processes/oep-0055-proc-project-maintainers.rst index 171c8c593..efecb99dc 100644 --- a/oeps/processes/oep-0055-proc-project-maintainers.rst +++ b/oeps/processes/oep-0055-proc-project-maintainers.rst @@ -463,9 +463,9 @@ Change History * 2025-03-10 - A group can maintain a repo as long as at least one person in the group satisifies all the indivudal requirements. Before, it was unclear/impied that every group member needed CC access to the repo. - `PR 691 `_. + `PR 691 `_. -* 2022-01-28 - `Document created `_ +* 2022-01-28 - `Document created `_ Source Material @@ -525,7 +525,7 @@ Notes .. _Django framework: https://www.djangoproject.com/ -.. _Core Contributor Program: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0054-core-contributors.html +.. _Core Contributor Program: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0054-core-contributors.html .. _maintainership documents: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3426418790/Maintainership+of+Open+edX+Repos diff --git a/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst b/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst index a028e3bc8..746c78e4c 100644 --- a/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst +++ b/oeps/processes/oep-0055/decisions/0001-use-backstage-to-support-maintainers.rst @@ -103,7 +103,7 @@ References .. code:: yaml # This file records information about this repo. Its use is described in OEP-55: - # https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html + # https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html apiVersion: backstage.io/v1alpha1 # (Required) Acceptable Values: Component, Resource, System diff --git a/oeps/processes/oep-0055/decisions/0002-maintainership-transfer-process.rst b/oeps/processes/oep-0055/decisions/0002-maintainership-transfer-process.rst index ee282e8d8..460cb6cd0 100644 --- a/oeps/processes/oep-0055/decisions/0002-maintainership-transfer-process.rst +++ b/oeps/processes/oep-0055/decisions/0002-maintainership-transfer-process.rst @@ -48,7 +48,7 @@ Communicate on the `forums`_ that ``component X`` is seeking a new maintainer. Hello, I'm the current maintainer of `component X`. I am no longer able to dedicate the amount of time needed to properly maintain this component to the - level described in (OEP-55)[https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html] + level described in (OEP-55)[https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html] and I am seeking a new maintainer. Code: /link/to/codebase @@ -126,5 +126,5 @@ References * Link to the deprecation process. -.. _the deprecation and removal(DEPR) process: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html -.. _DEPR: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html +.. _the deprecation and removal(DEPR) process: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0021-proc-deprecation.html +.. _DEPR: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0021-proc-deprecation.html diff --git a/oeps/processes/oep-0055/decisions/0003-readme-specification.rst b/oeps/processes/oep-0055/decisions/0003-readme-specification.rst index cc328d7df..fbf8193ee 100644 --- a/oeps/processes/oep-0055/decisions/0003-readme-specification.rst +++ b/oeps/processes/oep-0055/decisions/0003-readme-specification.rst @@ -100,6 +100,6 @@ Examples * `DoneXBlock `_ -.. _OEP-55: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html -.. _OEP-19: https://open-edx-proposals.readthedocs.io/en/latest/best-practices/oep-0019-bp-developer-documentation.html +.. _OEP-55: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html +.. _OEP-19: https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0019-bp-developer-documentation.html diff --git a/oeps/processes/oep-0057-proc-core-product.rst b/oeps/processes/oep-0057-proc-core-product.rst index b4cafa990..8d7b10724 100644 --- a/oeps/processes/oep-0057-proc-core-product.rst +++ b/oeps/processes/oep-0057-proc-core-product.rst @@ -27,7 +27,7 @@ OEP-57: Core Product * - Review Period - 2022-10-11 - 2022-11-07 * - References - - | * `Earlier draft of OEP-57 `_ + - | * `Earlier draft of OEP-57 `_ | * `Earlier discussions on the Core Product and Kernel `_ | * `Follow-up Work: Definition of Product Narrative `_ | * `Follow-up Work: Definition of the Core Product `_ @@ -339,9 +339,9 @@ Notes .. _FUN MOOC: https://www.fun-mooc.fr/en/ -.. _OEP-10: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0010-proc-openedx-releases.html +.. _OEP-10: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0010-proc-openedx-releases.html -.. _Maintainers Program: https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html +.. _Maintainers Program: https://docs.openedx.org/projects/openedx-proposals/en/latest/processes/oep-0055-proc-project-maintainers.html Change History ************** @@ -355,4 +355,4 @@ Change History footnotes into one because the text was reordered, and the 2nd footnote depended on the first; using the "Open edX" trademark appropriately (it may only be used as an adjective); removing forward references as discussed. -* `Pull request #398 `_ +* `Pull request #398 `_ diff --git a/oeps/processes/oep-0060-proc-sec-group.rst b/oeps/processes/oep-0060-proc-sec-group.rst index a6af789c5..14672f5c2 100644 --- a/oeps/processes/oep-0060-proc-sec-group.rst +++ b/oeps/processes/oep-0060-proc-sec-group.rst @@ -262,4 +262,4 @@ Change History ========== * Document created -* `Pull request #401 `_ +* `Pull request #401 `_ diff --git a/oeps/processes/oep-0063-proc-toc-resolution-request.rst b/oeps/processes/oep-0063-proc-toc-resolution-request.rst index 2fa389f15..d6375be68 100644 --- a/oeps/processes/oep-0063-proc-toc-resolution-request.rst +++ b/oeps/processes/oep-0063-proc-toc-resolution-request.rst @@ -68,7 +68,7 @@ Specification Step-by-step - How to Submit a Resolution Request ================================================= -- Open a discussion in a public place, such as the `forum `_ or using one of the formal decision recording formats such as `OEPs `_. The topics presented need to have been discussed in the community before being formally considered by the TOC. +- Open a discussion in a public place, such as the `forum `_ or using one of the formal decision recording formats such as `OEPs `_. The topics presented need to have been discussed in the community before being formally considered by the TOC. - After public review, post a formal Resolution Request to the TOC, by opening a `github ticket `_. Mention the `TOC chair `_ in the request to make sure they get notified. See the format below. - Notify the participants of the public discussions that you have created the TOC Resolution Request, by posting a link to it in the discussion threads. - Core contributors and/or TOC members supporting the Resolution Request reply in the thread to say so. @@ -103,4 +103,4 @@ Change History ========== * Document created with rough first draft -* `Pull request #484 `_ created +* `Pull request #484 `_ created