{"id":13416210,"url":"https://github.com/openedx/open-edx-proposals","last_synced_at":"2025-04-06T10:09:38.325Z","repository":{"id":37464565,"uuid":"55162195","full_name":"openedx/open-edx-proposals","owner":"openedx","description":"Proposals for Open edX architecture, best practices and processes ","archived":false,"fork":false,"pushed_at":"2025-03-18T15:56:09.000Z","size":10105,"stargazers_count":47,"open_issues_count":24,"forks_count":36,"subscribers_count":88,"default_branch":"master","last_synced_at":"2025-03-21T18:03:12.362Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://open-edx-proposals.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-31T15:36:33.000Z","updated_at":"2025-03-18T15:56:13.000Z","dependencies_parsed_at":"2024-04-12T17:42:46.188Z","dependency_job_id":"53e5cf8c-7a32-4b9c-bedd-58a32c69868b","html_url":"https://github.com/openedx/open-edx-proposals","commit_stats":null,"previous_names":["edx/open-edx-proposals"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fopen-edx-proposals","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fopen-edx-proposals/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fopen-edx-proposals/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fopen-edx-proposals/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/open-edx-proposals/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247464185,"owners_count":20942966,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T21:00:55.509Z","updated_at":"2025-04-06T10:09:38.299Z","avatar_url":"https://github.com/openedx.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"Open edX Proposals Index\n########################\n\n|license-badge| |doc-badge| |status-badge| |contributors-badge|\n\nOEP (pronounced “oh-epp”) stands for Open edX (Enhancement) Proposal. An OEP is\na document that details a specific technology or community decision being made by\nthe Open edX community, in the form of a best practice, architecture design, or\nprocess adjustment. An OEP should provide the use cases and rationales that surround\nthat choice. OEPs are not the only way for a change to be made to Open edX, however,\nthe goal is to create a collection of OEP documents as a repository or knowledge\narchive of large and broadly relevant choices made for the platform.\n\nView the published list of `Open edX Proposals (OEPs)`_ on ReadTheDocs.\n\n.. _Open edX Proposals (OEPs): https://open-edx-proposals.readthedocs.io\n\nGetting Started\n***************\n\nThis repository holds a bunch of text files, each of which represents an OEP or\nsupplementary documentation. For browsing these OEPs, we recommend you read them\nin `their published form \u003chttps://open-edx-proposals.readthedocs.io\u003e`_ on ReadTheDocs.\n\nContributing\n************\n\nContributions are very welcome.\nPlease read `How To Contribute \u003chttps://openedx.org/r/how-to-contribute\u003e`_ for details.\n\nOEPs are foundational *community* documents. The whole community is invited to collaborate\non these documents, from writing to fixing to updating to reviewing. Persons interested\nin following OEP progress should join the `#open-edx-proposals Slack channel`_ and/or\nfollow the `Announcements category in the forums`_.\n\nAny member of the community is welcome to propose changes or addendums to existing\nOEPs, or to propose a brand new one! All that is needed is to fork this repo and\nget writing. We use `ReStructured Text (RST)`_ to write all our OEPs, and we discuss\nall proposed changes and additions on `pull requests`_.\n\n.. _#open-edx-proposals Slack channel: https://openedx.slack.com/archives/C1L370YTZ\n.. _Announcements category in the forums: https://discuss.openedx.org/c/announcements/17\n.. _ReStructured Text (RST): https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html\n.. _pull requests: https://docs.openedx.org/en/latest/developers/quickstarts/first_openedx_pr.html\n\nTesting Locally\n***************\n\nBefore you make a pull request with your proposed changes, please try to visually test your changes first.\n\nTo test locally in a Python virtual env, you will first need to install `GraphViz \u003chttp://graphviz.org/\u003e`_\nOn a Mac, this can be done via ``brew install graphviz``; on Ubuntu, use ``sudo apt install graphviz``; on Red Hat variants use ``sudo dnf install graphviz``.\nNext, run the following commands\n\n.. code-block:: bash\n\n  pip install sphinx  # it may fail for non-obvious reasons without this\n  make requirements\n  make html\n\nCommon Warnings\n===============\n\nDocument isn't Included in any toctree\n--------------------------------------\n\nIf you have some documents that you only reference via ``:doc:`` or ``:ref:`` tags you may get this error.\nIf there is no table of contents that the files obviously belong in, an easy way to fix this error is to put the\ndocuments in a hidden toctree near where they are referenced:\n\n.. code-block:: rst\n\n    .. toctree::\n        :hidden:\n\n        path/to/referenced-file.rst\n\nGetting Help\n************\n\nIf you're having difficulties writing or testing, reach out to us on the\n`discussion forums`_. Be sure to categorize your question appropriately -\nif you're looking for technical help, the Development category is what you\nwant. If you're stuck on an idea and could use some community help in\nbringing it to life, try the Collaborative Proposals category!\n\n.. _discussion forums: https://discuss.openedx.org/\n\nCode of Conduct\n***************\n\nAll contributors to and reviewers of documentation in this repo must adhere\nto the `Open edX Code of Conduct`_. If you witness a breach of the Code of\nConduct, please reach out to the maintainer of this repo or to the contacts\nlisted in the Code of Conduct text.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n******\n\nSee the `open-edx-proposals Backstage page`_ for more information about who the\nmaintainers of this repo are and how to get in touch with them.\n\n.. _open-edx-proposals Backstage page: https://backstage.openedx.org/catalog/default/component/open-edx-proposals\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n\n.. |license-badge| image:: https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg\n    :target: https://github.com/openedx/open-edx-proposals/blob/main/LICENSE.txt\n    :alt: License\n\n.. |doc-badge| image:: https://readthedocs.org/projects/open-edx-proposals/badge/?version=latest\n    :target: https://open-edx-proposals.readthedocs.io/en/latest/\n    :alt: Documentation\n\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n\n.. |contributors-badge| image:: https://img.shields.io/github/contributors/openedx/open-edx-proposals.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fopen-edx-proposals","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Fopen-edx-proposals","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fopen-edx-proposals/lists"}