From bd0ff5869a63d81eb433c01aa13dd29e1751655c Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Wed, 29 May 2024 14:24:14 -0400 Subject: [PATCH 1/2] docs: Update README * Remove outdated Travis CI badge * s/edX/Open edX/ * Add note about Tutor - currently unknown if this package works on Tutor, but Devstack is deprecated. --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index fd41332a..b3d6b335 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,10 @@ Registrar service |Travis|_ |Codecov|_ =================================================== -.. |Travis| image:: https://travis-ci.com/edx/registrar.svg?branch=master -.. _Travis: https://travis-ci.com/edx/registrar -.. |Codecov| image:: http://codecov.io/github/edx/registrar/coverage.svg?branch=master -.. _Codecov: http://codecov.io/github/edx/registrar?branch=master +.. |Codecov| image:: http://codecov.io/github/openedx/registrar/coverage.svg?branch=master +.. _Codecov: http://codecov.io/github/openedx/registrar?branch=master -The Registrar service allows external organizations to integrate with edX programs, +The Registrar service allows external organizations to integrate with Open edX programs, providing REST APIs involving program structure, enrollment, and grading. Through Django Admin, it allows the definition of access roles for different API users. @@ -28,6 +26,8 @@ as well as important information about PII annotation. Using with Devstack ----------------- +! Note ! This section may be outdated. Tutor (https://docs.tutor.edly.io/gettingstarted.html) is now the supported development environment for the Open edX project, but we have not currently verified if Registrar works on Tutor. + The best way to run Registrar is within the edX Devstack: https://github.com/openedx/devstack. See the Devstack README for information on how to install and run Registrar. @@ -35,7 +35,7 @@ See the Devstack README for information on how to install and run Registrar. Using Standalone ----------------- -Alternatively, you may run Registrar locally without the edX Devstack. Note that in this configuration, functionality that depends on communication with other edX services (e.g. LMS authentication) will not work by default. +Alternatively, you may run Registrar locally. Note that in this configuration, functionality that depends on communication with other Open edX services (e.g. LMS authentication) will not work by default. Requirements: From 69927c54d69195c79b50c4d9d45f31b1e74bcf79 Mon Sep 17 00:00:00 2001 From: sarina Date: Thu, 30 May 2024 13:50:24 -0400 Subject: [PATCH 2/2] chore: Drop codecov to 90, which is a sane amount --- codecov.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/codecov.yml b/codecov.yml index c37995ce..2d4f2f62 100644 --- a/codecov.yml +++ b/codecov.yml @@ -3,9 +3,9 @@ coverage: status: patch: default: - target: 100 + target: 90 project: default: - target: 100 + target: 90 ignore: - "registrar/apps/core/permissions.py"