Skip to content

docs: Update docs to reflect the repo name change. #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarina merged 1 commit into from
Jan 28, 2026
Merged

docs: Update docs to reflect the repo name change. #771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://open-edx-proposals.readthedocs.io>`_ on ReadTheDocs.
in `their published form <https://docs.openedx.org/projects/openedx-proposals/>`_ on docs.openedx.org.

Contributing
************
Expand All @@ -30,15 +30,15 @@ Please read `How To Contribute <https://openedx.org/r/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
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
Expand Down Expand Up @@ -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
*************************
Expand All @@ -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
6 changes: 3 additions & 3 deletions catalog-info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
2 changes: 1 addition & 1 deletion oep-templates/adr-based-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ YYYY-MM-DD
==========

* Document created
* `Pull request #XXX <https://github.com/openedx/open-edx-proposals/pull/XXX>`_
* `Pull request #XXX <https://github.com/openedx/openedx-proposals/pull/XXX>`_
2 changes: 1 addition & 1 deletion oep-templates/external-link-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ YYYY-MM-DD
##########

* Document created
* `Pull request #XXX <https://github.com/openedx/open-edx-proposals/pull/XXX>`_
* `Pull request #XXX <https://github.com/openedx/openedx-proposals/pull/XXX>`_
2 changes: 1 addition & 1 deletion oep-templates/pep-based-template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ YYYY-MM-DD
==========

* Document created
* `Pull request #XXX <https://github.com/openedx/open-edx-proposals/pull/XXX>`_
* `Pull request #XXX <https://github.com/openedx/openedx-proposals/pull/XXX>`_
2 changes: 1 addition & 1 deletion oeps/architectural-decisions/oep-0003-arch-async-tasks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/openedx/open-edx-proposals/pull/672>`_
* `Pull request #672 <https://github.com/openedx/openedx-proposals/pull/672>`_
8 changes: 4 additions & 4 deletions oeps/architectural-decisions/oep-0015-arch-course-wide-js.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -153,16 +153,16 @@ Change History
==========

* Mark as accepted
* `PR #693 <https://github.com/openedx/open-edx-proposals/pull/693>`_
* `PR #693 <https://github.com/openedx/openedx-proposals/pull/693>`_

2022-10-07
==========

* There were differences between the approach described in OEP-15 and the final implemntation in `edx-platform#28411 <https://github.com/openedx/edx-platform/pull/28411>`_ . This commit updated the OEP to match the latest implementation.
* `PR #396 <https://github.com/openedx/open-edx-proposals/pull/396>`_
* `PR #396 <https://github.com/openedx/openedx-proposals/pull/396>`_

2017-01-24
==========

* Initial draft
* `PR #43 <https://github.com/openedx/open-edx-proposals/pull/43>`_
* `PR #43 <https://github.com/openedx/openedx-proposals/pull/43>`_
38 changes: 19 additions & 19 deletions oeps/architectural-decisions/oep-0026-arch-realtime-events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,19 +284,19 @@ Change History

* Mark as accepted
* Update to reflect current implementation
* `PR #678 <https://github.com/openedx/open-edx-proposals/pull/678>`_
* `PR #678 <https://github.com/openedx/openedx-proposals/pull/678>`_

2023-11-06
==========

* Fixed various typos
* `PR #537 <https://github.com/openedx/open-edx-proposals/pull/537>`_
* `PR #537 <https://github.com/openedx/openedx-proposals/pull/537>`_

2023-04-14
==========

* Replace tCRIL references with Axim references
* `PR #464 <https://github.com/openedx/open-edx-proposals/pull/464>`_
* `PR #464 <https://github.com/openedx/openedx-proposals/pull/464>`_

2022-11-04
==========
Expand All @@ -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 <https://github.com/openedx/open-edx-proposals/pull/405>`_
* `PR #405 <https://github.com/openedx/openedx-proposals/pull/405>`_

2022-09-27
==========

* Change arbiter from Brian Wilson to Ed Zarecor
* `PR #386 <https://github.com/openedx/open-edx-proposals/pull/386>`_
* `PR #386 <https://github.com/openedx/openedx-proposals/pull/386>`_

2022-09-16
==========

* Change Github organization references from edx to openedx
* `PR #376 <https://github.com/openedx/open-edx-proposals/pull/376>`_
* `PR #376 <https://github.com/openedx/openedx-proposals/pull/376>`_

2021-01-20 - 2022-08-02
=======================

* RsT style cleanup and minor content updates
* `PR #365 <https://github.com/openedx/open-edx-proposals/pull/365>`_
* `PR #248 <https://github.com/openedx/open-edx-proposals/pull/248>`_
* `PR #245 <https://github.com/openedx/open-edx-proposals/pull/245>`_
* `PR #206 <https://github.com/openedx/open-edx-proposals/pull/206>`_
* `PR #365 <https://github.com/openedx/openedx-proposals/pull/365>`_
* `PR #248 <https://github.com/openedx/openedx-proposals/pull/248>`_
* `PR #245 <https://github.com/openedx/openedx-proposals/pull/245>`_
* `PR #206 <https://github.com/openedx/openedx-proposals/pull/206>`_

2021-04-09
==========

* Change http URLs to https
* `PR #200 <https://github.com/openedx/open-edx-proposals/pull/200>`_
* `PR #200 <https://github.com/openedx/openedx-proposals/pull/200>`_

2021-01-20
==========

* Clarify when we should build on Django admin vs settings or a self-service portal
* `PR #156 <https://github.com/openedx/open-edx-proposals/pull/156>`_
* `PR #156 <https://github.com/openedx/openedx-proposals/pull/156>`_

2020-12-07
==========

* Update example code
* `PR #175 <https://github.com/openedx/open-edx-proposals/pull/175>`_
* `PR #175 <https://github.com/openedx/openedx-proposals/pull/175>`_

2020-09-20 - 2020-09-30
=======================

* Cleaning up links and references
* `PR #162 <https://github.com/openedx/open-edx-proposals/pull/162>`_
* `PR #163 <https://github.com/openedx/open-edx-proposals/pull/163>`_
* `PR #162 <https://github.com/openedx/openedx-proposals/pull/162>`_
* `PR #163 <https://github.com/openedx/openedx-proposals/pull/163>`_

2020-06-04
==========

* Significant updates to Caliper documentation
* `PR #152 <https://github.com/openedx/open-edx-proposals/pull/152>`_
* `PR #152 <https://github.com/openedx/openedx-proposals/pull/152>`_

2019-05-25
==========

* Update title to remove prefixing zeros for consistency
* `PR #115 <https://github.com/openedx/open-edx-proposals/pull/115>`_
* `PR #115 <https://github.com/openedx/openedx-proposals/pull/115>`_

2019-05-15
==========

* Update anonymized user ID section to unique user id as part of adding OEP-32
* `PR #103 <https://github.com/openedx/open-edx-proposals/pull/103>`_
* `PR #103 <https://github.com/openedx/openedx-proposals/pull/103>`_

2019-01-19
==========

* Initial publication
* `PR #73 <https://github.com/openedx/open-edx-proposals/pull/73>`_
* `PR #73 <https://github.com/openedx/openedx-proposals/pull/73>`_
26 changes: 13 additions & 13 deletions oeps/architectural-decisions/oep-0030-arch-pii-markup-and-auditing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -337,45 +337,45 @@ Change History

* Mark as accepted
* Update to reflect current implementation
* `PR #676 <https://github.com/openedx/open-edx-proposals/pull/676>`_
* `PR #676 <https://github.com/openedx/openedx-proposals/pull/676>`_

2022-09-16
==========

* Change Github organization references from edx to openedx
* `PR #376 <https://github.com/openedx/open-edx-proposals/pull/376>`_
* `PR #376 <https://github.com/openedx/openedx-proposals/pull/376>`_

2021-01-20 - 2022-08-02
=======================

* RsT style cleanup and minor content updates
* `PR #365 <https://github.com/openedx/open-edx-proposals/pull/365>`_
* `PR #248 <https://github.com/openedx/open-edx-proposals/pull/248>`_
* `PR #245 <https://github.com/openedx/open-edx-proposals/pull/245>`_
* `PR #206 <https://github.com/openedx/open-edx-proposals/pull/206>`_
* `PR #365 <https://github.com/openedx/openedx-proposals/pull/365>`_
* `PR #248 <https://github.com/openedx/openedx-proposals/pull/248>`_
* `PR #245 <https://github.com/openedx/openedx-proposals/pull/245>`_
* `PR #206 <https://github.com/openedx/openedx-proposals/pull/206>`_

2020-02-19
==========

* Fix code blocks that weren't rendering, and typos
* `PR #134 <https://github.com/openedx/open-edx-proposals/pull/134>`_
* `PR #134 <https://github.com/openedx/openedx-proposals/pull/134>`_

2019-01-30
==========

* 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 <https://github.com/openedx/open-edx-proposals/pull/101>`_
* `PR #101 <https://github.com/openedx/openedx-proposals/pull/101>`_

2018-11-06
==========

* Change status from Provisional to Draft
* `PR #85 <https://github.com/openedx/open-edx-proposals/pull/85>`_
* `PR #85 <https://github.com/openedx/openedx-proposals/pull/85>`_

2018-10-09
==========

* Initial draft
* `PR #81 <https://github.com/openedx/open-edx-proposals/pull/81>`_
* `PR #81 <https://github.com/openedx/openedx-proposals/pull/81>`_
8 changes: 4 additions & 4 deletions oeps/architectural-decisions/oep-0032-arch-unique-identifier-for-users.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <https://github.com/openedx/edx-platform/blob/e1c8fb51bec2be3aa8da9750cb52b01728d1a740/openedx/core/djangoapps/external_user_ids/docs/decisions/0001-externalid.rst>`_.

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 <https://github.com/openedx/open-edx-proposals/issues/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 <https://github.com/openedx/openedx-proposals/issues/407>`_.

Decision
********
Expand Down Expand Up @@ -144,5 +144,5 @@ Change History
2024-07-08
==========
* Change status to "Needs Revision"
* `Discussion issue #407 <https://github.com/openedx/open-edx-proposals/issues/407>`
* `Pull request #603 <https://github.com/openedx/open-edx-proposals/pull/603>`_
* `Discussion issue #407 <https://github.com/openedx/openedx-proposals/issues/407>`
* `Pull request #603 <https://github.com/openedx/openedx-proposals/pull/603>`_
8 changes: 4 additions & 4 deletions oeps/architectural-decisions/oep-0045-arch-ops-and-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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


Expand Down Expand Up @@ -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
*****************
Expand All @@ -220,4 +220,4 @@ Change History
2024-05-16
==========
* Change status to "Needs Revision"
* `Pull request #586 <https://github.com/openedx/open-edx-proposals/pull/586>`_
* `Pull request #586 <https://github.com/openedx/openedx-proposals/pull/586>`_
Loading