Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(processWorker): add documentation for processes #368

Merged
merged 3 commits into from
Jul 29, 2024

Conversation

Phil91
Copy link
Member

@Phil91 Phil91 commented Jul 25, 2024

Description

Add documentation for the processes and each process step

Why

To give an overview and explanation of the available processes and their functionality.

Issue

Refs: #351

Checklist

  • I have followed the contributing guidelines
  • I have performed IP checks for added or updated 3rd party libraries
  • I have created and linked IP issues or requested their creation by a committer
  • I have added copyright and license headers, footers (for .md files) or files (for images)
  • I have performed a self-review of my own code
  • I have successfully tested my changes locally
  • I have added tests that prove my changes work
  • I have checked that new and existing tests pass locally with my changes
  • I have commented my code, particularly in hard-to-understand areas

Copy link

@Phil91 Phil91 merged commit c003275 into main Jul 29, 2024
6 checks passed
@Phil91 Phil91 deleted the docs/351-process-worker branch July 29, 2024 14:01
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't it be more useful to add a chapter "retrigger" in the other pages" and then split this list up ?
this would provide a better overview on the topic of interest and what of these steps are retriggerable ?


## VALIDATE_DID_DOCUMENT

The process step `VALIDATE_DID_DOCUMENT` retrieves the did from the database and validates it via an universalREsolver to check that the structure is correct.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

REsolver ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sdFactory or sd Factory . can we align on one format. preferably the one we use everywhere

@@ -0,0 +1,25 @@
# Summary

The mailing process handles the sending of e-mails to users it therefor retrieves all entries of the `mailing_informations` with status `PENDING`. The process steps are the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mailing process is responsible for sending emails to users. Therefore, it retrieves all entries from the mailing_informations table with the status PENDING.

The network registration process handles the synchronization of users, the handling of the callback logic for the osp and the user removal. The process steps are the following:

```mermaid
flowchart TD
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the connection missing ?
i assume it should be ?
A-->B
B--> |request successful| D
B--> |request not successful| E
D --> F
E --> F

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants