From 3aca32c49ccfcd990211bdc1c464e95e8f02628f Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Tue, 16 Aug 2022 09:29:35 -0400 Subject: [PATCH 1/9] fix: initial efforts to create useful, standard readme with purpose. --- README.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 9132a748dc..4b5a7648b2 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,32 @@ -This is the core repository of the Open edX software. It includes the LMS -(student-facing, delivering courseware), and Studio (course authoring) -components. +############ +edX Platform +############ +| |License: AGPL v3| |Status| |Python CI| |Publish package to PyPi| + +.. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0 + +.. |Python CI| image:: https://github.com/openedx/edx-platform/actions/workflows/ci.yml/badge.svg + :target: https://github.com/openedx/edx-platform/actions/workflows/ci.yml + +.. |Publish package to PyPi| image:: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml/badge.svg + :target: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml + +.. |Status| image:: https://img.shields.io/badge/status-maintained-31c653 + +Purpose +======= +The Open edX platform is a service oriented platform for authoring and +delivering online learning at any scale. The platform is written in +Python and JavaScript and makes extensive use of the Django +framework. At the highest level, the platform is composed of a +monolith, some independently deployable applications (IDAs), and +micro-frontends (MFEs) based on the ReactJS. + +This repository hosts the monolith at the center of the Open edX +platform. Functionally, the edx-platform repository provides the +environment for authoring courses, Open edX Studio, also called the +CMS, and the course delivery service, called the LMS. Installation ------------ From 07f5f04fad8d2124562492b9dbea5c185c5d4f69 Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Tue, 16 Aug 2022 09:40:50 -0400 Subject: [PATCH 2/9] fix: removing PyPi publish badge --- README.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.rst b/README.rst index 4b5a7648b2..e51bdcbb35 100644 --- a/README.rst +++ b/README.rst @@ -9,9 +9,6 @@ edX Platform .. |Python CI| image:: https://github.com/openedx/edx-platform/actions/workflows/ci.yml/badge.svg :target: https://github.com/openedx/edx-platform/actions/workflows/ci.yml -.. |Publish package to PyPi| image:: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml/badge.svg - :target: https://github.com/openedx/edx-platform/actions/workflows/pypi-release.yml - .. |Status| image:: https://img.shields.io/badge/status-maintained-31c653 Purpose From 9d42ed5d7e5ece23a5d66bdbf20b4d4b64bd95cc Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Tue, 16 Aug 2022 10:06:02 -0400 Subject: [PATCH 3/9] fix: actually remove the badge. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e51bdcbb35..a2e9108378 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ ############ edX Platform ############ -| |License: AGPL v3| |Status| |Python CI| |Publish package to PyPi| +| |License: AGPL v3| |Status| |Python CI| .. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg :target: https://www.gnu.org/licenses/agpl-3.0 From 6982807a52a60cebec2f4d1da808f49a576577a0 Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Tue, 16 Aug 2022 13:21:25 -0400 Subject: [PATCH 4/9] fix: add link, and dash. Co-authored-by: Kyle McCormick --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a2e9108378..0117d775dc 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ edX Platform Purpose ======= -The Open edX platform is a service oriented platform for authoring and +The `Open edX Platform `_ is a service-oriented platform for authoring and delivering online learning at any scale. The platform is written in Python and JavaScript and makes extensive use of the Django framework. At the highest level, the platform is composed of a From d3ff7adef71d837166b791f40bca0ffad4d22997 Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Wed, 7 Sep 2022 17:08:41 -0400 Subject: [PATCH 5/9] fix: Update README.rst Co-authored-by: Kyle McCormick --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 0117d775dc..5c4649ad7a 100644 --- a/README.rst +++ b/README.rst @@ -12,7 +12,7 @@ edX Platform .. |Status| image:: https://img.shields.io/badge/status-maintained-31c653 Purpose -======= +------- The `Open edX Platform `_ is a service-oriented platform for authoring and delivering online learning at any scale. The platform is written in Python and JavaScript and makes extensive use of the Django From 501a1b62d7dd6ce160affc3c60dc94043ef6a3ab Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Wed, 7 Sep 2022 17:11:25 -0400 Subject: [PATCH 6/9] fix: Update README.rst Co-authored-by: Kyle McCormick --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 5c4649ad7a..32e50e740a 100644 --- a/README.rst +++ b/README.rst @@ -21,9 +21,9 @@ monolith, some independently deployable applications (IDAs), and micro-frontends (MFEs) based on the ReactJS. This repository hosts the monolith at the center of the Open edX -platform. Functionally, the edx-platform repository provides the -environment for authoring courses, Open edX Studio, also called the -CMS, and the course delivery service, called the LMS. +platform. Functionally, the edx-platform repository provides two services: +* CMS, which powers Open edX Studio, the platform's learning content authoring environment; and +* LMS, which delivers learning content. Installation ------------ From 0dacf8378982dfc80fba03c1306f66af165da9eb Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Wed, 7 Sep 2022 17:13:34 -0400 Subject: [PATCH 7/9] fix: updated name --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 32e50e740a..6bd53e7f84 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -############ -edX Platform -############ +################# +Open edX Platform +################# | |License: AGPL v3| |Status| |Python CI| .. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg From 01c4e1f69b0eabab3bded941d2357078c13e04c0 Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Mon, 12 Sep 2022 13:00:12 -0400 Subject: [PATCH 8/9] fix: add new newline. Co-authored-by: Kyle McCormick --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 6bd53e7f84..54f22832f3 100644 --- a/README.rst +++ b/README.rst @@ -22,6 +22,7 @@ micro-frontends (MFEs) based on the ReactJS. This repository hosts the monolith at the center of the Open edX platform. Functionally, the edx-platform repository provides two services: + * CMS, which powers Open edX Studio, the platform's learning content authoring environment; and * LMS, which delivers learning content. From 4b110c2fe96c206cdadca88e7e5d2f14eb2a2035 Mon Sep 17 00:00:00 2001 From: Edward Zarecor Date: Mon, 12 Sep 2022 13:01:33 -0400 Subject: [PATCH 9/9] fix: Add acronym expansion Co-authored-by: Kyle McCormick --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 54f22832f3..6d060d77ce 100644 --- a/README.rst +++ b/README.rst @@ -23,8 +23,8 @@ micro-frontends (MFEs) based on the ReactJS. This repository hosts the monolith at the center of the Open edX platform. Functionally, the edx-platform repository provides two services: -* CMS, which powers Open edX Studio, the platform's learning content authoring environment; and -* LMS, which delivers learning content. +* CMS (Content Management Service), which powers Open edX Studio, the platform's learning content authoring environment; and +* LMS (Learning Management Service), which delivers learning content. Installation ------------