From 79f8355a7e3d886a24c246b283caeab9cc8af32c Mon Sep 17 00:00:00 2001 From: Akashdeep Dhar Date: Thu, 15 Dec 2022 21:11:22 +0530 Subject: [PATCH] Make the proposed changes Signed-off-by: Akashdeep Dhar --- docs/badges/prop_rewrite_entities.rst | 14 ++++++++------ docs/badges/prop_rewrite_technologies.rst | 8 ++++---- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/badges/prop_rewrite_entities.rst b/docs/badges/prop_rewrite_entities.rst index b831db2..4187a52 100644 --- a/docs/badges/prop_rewrite_entities.rst +++ b/docs/badges/prop_rewrite_entities.rst @@ -60,8 +60,9 @@ Internal entities 2. This is planned to be a repository of supporting assets (artworks, awarding conditions, consumer rules etc.) for the badges available for being awarded to the community members, which can be read from and - updated by the interactions with the Accolades API and by admins having - relevant accesses to the repository. + updated by the interactions with the Accolades API entity and the + Liberation entity as well as by admins having relevant accesses to the + repository. 3. This is planned to be a standalone entity with just one possible interaction with the neighbouring internal entity (i.e. Accolades API) and one possible interaction with the neighbouring external entity (i.e. @@ -85,10 +86,11 @@ Internal entities `fedbadges `_ fedmsg listener and/or is planned to be a reimplementation of the same. 2. This is planned to act as a messages consumer, listening into the Fedora - Messaging bus and comparing the messages against the awarding conditions - available on the Collection, and on a successful match, making a request - to the Accolades API for awarding the said badge to a certain contributor - who have met the conditions specified in the related badge rule. + Messaging bus matching the schemas that it is configured for and + comparing the messages against the awarding conditions available on the + Collection, and on a successful match, making a request to the Accolades + API for awarding the said badge to a certain contributor who have met the + conditions specified in the related badge rule. 3. This is planned to be a standalone entity with two possible interactions with the neighbouring internal entities (i.e. Accolades API and Collection) and no possible interaction with the neighbouring external diff --git a/docs/badges/prop_rewrite_technologies.rst b/docs/badges/prop_rewrite_technologies.rst index a3d8f9f..624d904 100644 --- a/docs/badges/prop_rewrite_technologies.rst +++ b/docs/badges/prop_rewrite_technologies.rst @@ -13,11 +13,11 @@ Accolades API ---- *Suggested using:* - | Web framework: `FastAPI `_ + | Web framework: `FastAPI `_ or `Flask `_ | CLI compositor: `Click `_ | Database abstraction: `Psycopg2 `_ | ORM and SQL library: `SQLAlchemy `_ - | Configuration parsing: `PyYAML `_ + | Configuration parsing: `PyYAML `_ or `Tomllib `_ | Caching and indexing: `Redis `_ Accolades CLI @@ -26,7 +26,7 @@ Accolades CLI *Suggested using:* | CLI compositor: `Click `_ | HTTP library: `Requests `_ - | Configuration parsing: `PyYAML `_ + | Configuration parsing: `PyYAML `_ or `Tomllib `_ Liberation ---- @@ -49,4 +49,4 @@ Messages Consumer | Listener: `Fedora Messaging `_ | CLI compositor: `Click `_ | HTTP library: `Requests `_ - | Configuration parsing: `PyYAML `_ + | Configuration parsing: `PyYAML `_ or `Tomllib `_