Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

docs: Update README #621

Merged
merged 2 commits into from
May 30, 2024
Merged

docs: Update README #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd0ff58
docs: Update README
sarina May 29, 2024
69927c5
chore: Drop codecov to 90, which is a sane amount
sarina May 30, 2024
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
12 changes: 6 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -28,14 +26,16 @@ 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.

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:

Expand Down
4 changes: 2 additions & 2 deletions codecov.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ coverage:
status:
patch:
default:
target: 100
target: 90
project:
default:
target: 100
target: 90
ignore:
- "registrar/apps/core/permissions.py"
Loading