Skip to content

Commit

Permalink
feat: the latest BA documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
wowkalucky committed Jun 17, 2024
1 parent 2624c76 commit 800039c
Show file tree
Hide file tree
Showing 6 changed files with 316 additions and 236 deletions.
36 changes: 28 additions & 8 deletions docs/badges/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,53 @@
Configuration
=============

The Badges feature is configured via the Credentials admin interface.
.. note::

This section provides information on how and where to set up badge templates and organizations.

The Badges feature is configured in the Credentials admin panel.

.. image:: ../_static/images/badges/badges-admin.png
:alt: Badges administration

Credly Organizations
--------------------

Multiple Credly Organizations can be configured.
Multiple Credly Organizations can be configured.

**All communication between Open edX Credentials and Credly service happens on behalf of a Credly Organization.**

Enter "Credly Organizations" list page (`<credentials>/admin/badges/credlyorganization/`) and create a new item:
Go to the Credly Organization section in the admin panel and create a new item:

- to set the UUID use your Credly Organization identifier;
- to set the authorization token issue one in the Credly Organization's dashboard;
1. to set the UUID use your Credly Organization identifier;
2. to set the authorization token issue one in the Credly Organization's dashboard.

Check: the system pulls the Organization's details and updates its name.

In case of errors check used credentials for the Organization.
In case of errors check the used credentials for the Organization.

Badge templates
---------------

**Badge template** is another **credential** type. Credly badge template is a kind of a badge template.
*Credly badge templates* (badge templates for short) are created in the Credly Organization's dashboard and then, if published, they are retrieved by the Credentials via API.

Webhooks
~~~~~~~~~~~~~~~

.. note::

Webhooks is a connection with Credly and external platform that allows your server to be notified about events occuring within Credly.

Webhooks are set up on Credly management dashboard as Credly is a main initiator of the syncronization.

You should be able to select an action from the list so that whenever this action happens internally, external platform will be alerted and updated.

Without the syncronization, actions such as:

- Update of the badge template
- Archivation of the badge template

*Credly badge templates* (badge templates for brevity) are created in the Credly Organization's dashboard and then, if published, they are retrieved by the Credentials via API.
external platform will not be aware of any changes so it might continue issuing outdated badges.

Synchronization
~~~~~~~~~~~~~~~
Expand Down
Loading

0 comments on commit 800039c

Please sign in to comment.