From 573b57ac22f2083b346cc1ee0f23f671345b5cc5 Mon Sep 17 00:00:00 2001 From: uo287545 Date: Sun, 18 Feb 2024 22:50:58 +0100 Subject: [PATCH 1/2] Italics on tables fixed --- docs/src/05_building_block_view.adoc | 2 +- docs/src/12_glossary.adoc | 20 ++++++++------------ 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index f1d8c553..19c8830f 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -85,7 +85,7 @@ fulfill system requirements related to the automatic generation of questions. Contained Building Blocks:: -[cols="e,2e" options="header"] +[cols="1,2" options="header"] |=== | Name | Description diff --git a/docs/src/12_glossary.adoc b/docs/src/12_glossary.adoc index d255eb3d..2c4861ad 100644 --- a/docs/src/12_glossary.adoc +++ b/docs/src/12_glossary.adoc @@ -30,22 +30,18 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation. **** -[cols="e,2e" options="header"] +[cols="1,2" options="header"] |=== -| Term |Definition +| Term | Definition -|WikiData -|A collaborative platform that provides structured data for Wikimedia projects, including Wikipedia. +|WikiData |A collaborative platform that provides structured data for Wikimedia projects, including Wikipedia. -|IDE (Integrated Development Environment) -|A software application that provides comprehensive facilities to programmers for software development. +|IDE (Integrated Development Environment) |A software application that provides comprehensive facilities to programmers for software development. -|Docker -|An open-source platform designed to automate the deployment of applications inside lightweight, portable containers. +|Docker |An open-source platform designed to automate the deployment of applications inside lightweight, portable containers. -|Microservices -|An architectural style that structures an application as a collection of small, independent services. +|Microservices |An architectural style that structures an application as a collection of small, independent services. + +|API (Application Programming Interface) |A set of protocols and tools for building software applications, allowing them to communicate with each other. -|API (Application Programming Interface) -|A set of protocols and tools for building software applications, allowing them to communicate with each other. |=== From 3dd35d29144947ff8434961ec8bea6210e22fd09 Mon Sep 17 00:00:00 2001 From: uo288061 Date: Tue, 20 Feb 2024 18:24:50 +0100 Subject: [PATCH 2/2] Changes to points 11 and 12 of the documentation, following the advice from the correction. --- docs/src/08_concepts.adoc | 3 --- docs/src/11_technical_risks.adoc | 10 ++++++++-- docs/src/12_glossary.adoc | 8 ++++---- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/src/08_concepts.adoc b/docs/src/08_concepts.adoc index 91dee5ee..30611946 100644 --- a/docs/src/08_concepts.adoc +++ b/docs/src/08_concepts.adoc @@ -9,9 +9,6 @@ The following concepts provide a foundation for the design and implementation of The domain model for our game includes entities such as `Question`, `Category`, `Player`, and `GameSession`. These are crucial for representing the game's data and logic. The model serves as the basis for interactions within the application and between the application and the database. -.Explanation: -The `Question` entity encapsulates details of the trivia questions. `Category` classifies these questions into various topics. `Player` represents users and their interactions with the game, while `GameSession` maintains the state of play, including scores and progress. - === Hexagonal Architecture Our application is structured using hexagonal architecture principles, which prioritize the separation of core logic from peripheral concerns like user interface and external API interactions. diff --git a/docs/src/11_technical_risks.adoc b/docs/src/11_technical_risks.adoc index 09856e79..dda9511e 100644 --- a/docs/src/11_technical_risks.adoc +++ b/docs/src/11_technical_risks.adoc @@ -27,13 +27,19 @@ See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 do [cols="1,2,3a", options="header"] |=== -| Priority | Risk/Debt | Description +| Priority | Risk | Description | High | Migration to Java | Migration from the current project language, JavaScript (JS), to Java | Medium | IDE Configuration | Version compatibility, extensions and other preferences to work perfectly without conflicts | Medium | Database | Discuss which database is best for the project | Low | Docker | Know how docker works, what it is for, how it is used and what its alternatives could be. -| Low | Microservices | Research about microservices and what they can contribute to the project |=== + +[cols="1,2,3a", options="header"] +|=== +| Priority | Debt | Description +| Low | Microservices | Research about microservices and what they can contribute to the project + +|== diff --git a/docs/src/12_glossary.adoc b/docs/src/12_glossary.adoc index 2c4861ad..1795a1b6 100644 --- a/docs/src/12_glossary.adoc +++ b/docs/src/12_glossary.adoc @@ -36,12 +36,12 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation. |WikiData |A collaborative platform that provides structured data for Wikimedia projects, including Wikipedia. -|IDE (Integrated Development Environment) |A software application that provides comprehensive facilities to programmers for software development. +|Question | Entity that encapsulates details of the trivia questions. -|Docker |An open-source platform designed to automate the deployment of applications inside lightweight, portable containers. +|Category | Classifies questions into various topics, each question can only belong to one category. -|Microservices |An architectural style that structures an application as a collection of small, independent services. +|Player | Represents users and their interactions with the game -|API (Application Programming Interface) |A set of protocols and tools for building software applications, allowing them to communicate with each other. +|GameSession | Maintains the state of play, including scores and progress. |===