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

Documentation parts 1-4 #11

Merged
merged 14 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
📝 Documentation part 3 (technical context diagram added)
  • Loading branch information
coral2742 committed Feb 3, 2024
commit 6dc9526b88ae64928e2c0a13347d45647bedf5cd
Binary file modified docs/images/03-BusinessContextDiagram-Lucidchart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,54 @@ The agents involved in the WIQ system environment are the following:

* *Question's API*: is given by the system to provide information about the questions generated.



****


=== Technical Context

[role="arc42help"]
****
.Technical Context Diagram

:imagesdir: ../images
image::03-TechnicalContextDiagram-Lucidchart.png[Technical Context Diagram]


.WIQ
[cols="1,2,3"]
|===

| Channels
| Type
| Input/Output

| SSH
| Input
| User -> Frontend Web

| HTTP/REST
| Output
| WIQ -> User's API

| HTTP/REST
| Output
| WIQ -> Question's API

| HTTP/REST
| Input
| Database -> Wikidata

| HTTP
| Input
| Database -> WIQ

| HTTP
| Output
| WIQ -> Database

|===