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

Rework the documentation layout and naming schemes

Browse source 
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
This commit is contained in:
Akashdeep Dhar 2024-03-27 10:41:46 +05:30
parent 3fafdac29c
commit 8602f421d8
2 changed files with 43 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/webhook2fedmsg/index.rst
View file

@ -61,15 +61,12 @@ Following it the design document for webhook2fedmsg.
Implementation
--------------
There are two ways with which we can go about implementing the project. Each
of these methods show a variety of advantages to the users with varying
requirements from the team building and maintaining the project.
The implementation details of the project can be found here.
.. toctree::
:maxdepth: 1
:maxdepth: 3
api_service
web_service
the_action_plan
The Good Points
---------------

43
docs/webhook2fedmsg/api_service.rst → docs/webhook2fedmsg/the_action_plan.rst
View file

@ -1,7 +1,7 @@
.. _api_service:
.. _the_action_plan:
Interaction using API service
=============================
The Action Plan
===============
Elements involved
-----------------
@ -9,9 +9,31 @@ Elements involved
This implementation of the Webhook To Fedora Messaging service project requires
the involvement of the following entities.
Frontend service
^^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
frsv
1. The frontend service is expected to allow for the operations of managing per
user account details using a supported browser.
2. It is recommended to use progressive web framework like ReactJS or VueJS to
detach the frontend and backend system elements.
3. The deployment is suggested to be done either in the same device as the API
service or at least in the same network.
4. The service should be exposed on the public internet and needs to be behind
Fedora Account System authentication check.
Database service
^^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
dber
1. The database service is expected to allow for creating, reading, updating
and deleting webhook forwarding requests per user.
2. It is recommended to use an structured database management service like
@ -24,6 +46,11 @@ Database service
API service
^^^^^^^^^^^
.. toctree::
:maxdepth: 1
apis
1. The API service is expected to manage requests for creating messages on the
Fedora Messaging bus for the interacting users.
2. It is recommended to use an asynchronous web framework like FastAPI or
@ -36,6 +63,11 @@ API service
API documentation
^^^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
apid
1. The API documentation is expected to elucidate how a contributor can
leverage the API service to send messages on the bus.
2. It is recommended to let the choice be dependent on the API service
@ -48,6 +80,11 @@ API documentation
Message producer
^^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
mpro
1. The message producer is expected to interact with the Fedora Messaging bus
by sending messages requested by the API service.
2. The Fedora Messaging library is a good fit for interacting with the service