Infrastructure/arc
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Make the proposed changes

Browse source 
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
This commit is contained in:
Akashdeep Dhar 2022-12-15 21:11:22 +05:30 • committed by zlopez
parent 9ad1c57d13
commit 79f8355a7e
2 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/badges/prop_rewrite_entities.rst
View file

@ -60,8 +60,9 @@ Internal entities
2. This is planned to be a repository of supporting assets (artworks, 2. This is planned to be a repository of supporting assets (artworks,
awarding conditions, consumer rules etc.) for the badges available for awarding conditions, consumer rules etc.) for the badges available for
being awarded to the community members, which can be read from and being awarded to the community members, which can be read from and
updated by the interactions with the Accolades API and by admins having updated by the interactions with the Accolades API entity and the
relevant accesses to the repository. 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 3. This is planned to be a standalone entity with just one possible
interaction with the neighbouring internal entity (i.e. Accolades API) interaction with the neighbouring internal entity (i.e. Accolades API)
and one possible interaction with the neighbouring external entity (i.e. and one possible interaction with the neighbouring external entity (i.e.
@ -85,10 +86,11 @@ Internal entities
`fedbadges <https://github.com/fedora-infra/fedbadges>`_ fedmsg listener `fedbadges <https://github.com/fedora-infra/fedbadges>`_ fedmsg listener
and/or is planned to be a reimplementation of the same. 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 2. This is planned to act as a messages consumer, listening into the Fedora
Messaging bus and comparing the messages against the awarding conditions Messaging bus matching the schemas that it is configured for and
available on the Collection, and on a successful match, making a request comparing the messages against the awarding conditions available on the
to the Accolades API for awarding the said badge to a certain contributor Collection, and on a successful match, making a request to the Accolades
who have met the conditions specified in the related badge rule. 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 3. This is planned to be a standalone entity with two possible interactions
with the neighbouring internal entities (i.e. Accolades API and with the neighbouring internal entities (i.e. Accolades API and
Collection) and no possible interaction with the neighbouring external Collection) and no possible interaction with the neighbouring external

8
docs/badges/prop_rewrite_technologies.rst
View file

@ -13,11 +13,11 @@ Accolades API
---- ----
*Suggested using:* *Suggested using:*
| Web framework: `FastAPI <https://fastapi.tiangolo.com/>`_ | Web framework: `FastAPI <https://fastapi.tiangolo.com/>`_ or `Flask <https://flask.palletsprojects.com/>`_
| CLI compositor: `Click <https://click.palletsprojects.com/>`_ | CLI compositor: `Click <https://click.palletsprojects.com/>`_
| Database abstraction: `Psycopg2 <https://www.psycopg.org/docs/>`_ | Database abstraction: `Psycopg2 <https://www.psycopg.org/docs/>`_
| ORM and SQL library: `SQLAlchemy <https://sqlalchemy.org/>`_ | ORM and SQL library: `SQLAlchemy <https://sqlalchemy.org/>`_
| Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ | Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ or `Tomllib <https://docs.python.org/3/library/tomllib.html>`_
| Caching and indexing: `Redis <https://redis.io/>`_ | Caching and indexing: `Redis <https://redis.io/>`_
Accolades CLI Accolades CLI
@ -26,7 +26,7 @@ Accolades CLI
*Suggested using:* *Suggested using:*
| CLI compositor: `Click <https://click.palletsprojects.com/>`_ | CLI compositor: `Click <https://click.palletsprojects.com/>`_
| HTTP library: `Requests <https://requests.readthedocs.io/>`_ | HTTP library: `Requests <https://requests.readthedocs.io/>`_
| Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ | Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ or `Tomllib <https://docs.python.org/3/library/tomllib.html>`_
Liberation Liberation
---- ----
@ -49,4 +49,4 @@ Messages Consumer
| Listener: `Fedora Messaging <https://fedora-messaging.readthedocs.io/en/stable/>`_ | Listener: `Fedora Messaging <https://fedora-messaging.readthedocs.io/en/stable/>`_
| CLI compositor: `Click <https://click.palletsprojects.com/>`_ | CLI compositor: `Click <https://click.palletsprojects.com/>`_
| HTTP library: `Requests <https://requests.readthedocs.io/>`_ | HTTP library: `Requests <https://requests.readthedocs.io/>`_
| Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ | Configuration parsing: `PyYAML <https://pyyaml.org/wiki/PyYAML>`_ or `Tomllib <https://docs.python.org/3/library/tomllib.html>`_