Merge remote-tracking branch 'origin/doc' into doc

# Conflicts: # docs/src/02_architecture_constraints.adoc
Arquisoft · Mar 1, 2024 · ac0529b · ac0529b
2 parents a6e209f + 0d374c2
commit ac0529b
Show file tree

Hide file tree

Showing 41 changed files with 188 additions and 667 deletions.
diff --git a/.github/workflows/deploy-doc.yml b/.github/workflows/deploy-doc.yml
@@ -0,0 +1,42 @@
+name: Deploy Pages
+on:
+  push:
+    branches: [ doc ]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+
+    - name: Install Asciidoctor and Asciidoctor-diagram
+      run: gem install asciidoctor asciidoctor-diagram
+
+    - name: Install Graphviz
+      run: sudo apt-get install graphviz
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14.x'
+
+    - name: Install npm dependencies in docs
+      run: cd docs && npm install
+
+    - name: Build project
+      run: cd docs && npm run build
+
+    - name: Deploy to GitHub Pages
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        cd docs
+        npx gh-pages -d build -r https://x-access-token:${GITHUB_TOKEN}@github.com/Arquisoft/wiq_es05b.git
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/images/01_2_iso-25010-topics-EN.drawio.png b/docs/images/01_2_iso-25010-topics-EN.drawio.png
diff --git a/docs/images/jordi-hurtado-happy.jpg → docs/images/01_jordi_hurtado_happy.jpg b/docs/images/jordi-hurtado-happy.jpg → docs/images/01_jordi_hurtado_happy.jpg
diff --git a/docs/images/03_business_context.drawio.png b/docs/images/03_business_context.drawio.png
diff --git a/docs/images/03_technical_context.drawio.png b/docs/images/03_technical_context.drawio.png
diff --git a/docs/images/04_technical_context.drawio.png b/docs/images/04_technical_context.drawio.png
diff --git a/docs/images/05_building_blocks-EN.png b/docs/images/05_building_blocks-EN.png
diff --git a/docs/images/05_level1.drawio.png b/docs/images/05_level1.drawio.png
diff --git a/docs/images/05_level2.drawio.png b/docs/images/05_level2.drawio.png
diff --git a/docs/images/05_level3.drawio.png b/docs/images/05_level3.drawio.png
diff --git a/docs/images/06_login.drawio.png b/docs/images/06_login.drawio.png
diff --git a/docs/images/06_question.drawio.png b/docs/images/06_question.drawio.png
diff --git a/docs/images/06_signup.drawio.png b/docs/images/06_signup.drawio.png
diff --git a/docs/images/07_overview.drawio.png b/docs/images/07_overview.drawio.png
diff --git a/docs/images/08-Crosscutting-Concepts-Structure-EN.png b/docs/images/08-Crosscutting-Concepts-Structure-EN.png
diff --git a/docs/images/10_quality_tree.drawio.png b/docs/images/10_quality_tree.drawio.png
diff --git a/docs/images/10_quality_tree.png b/docs/images/10_quality_tree.png
diff --git a/docs/images/12_legend.drawio.png b/docs/images/12_legend.drawio.png
diff --git a/docs/images/diagram-login.drawio.png b/docs/images/diagram-login.drawio.png
diff --git a/docs/images/diagram-question.drawio.png b/docs/images/diagram-question.drawio.png
diff --git a/docs/images/diagram-register.drawio copy.png b/docs/images/diagram-register.drawio copy.png
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -6,7 +6,7 @@
 // configure EN settings for asciidoc
 include::src/config.adoc[]
 
-= image:arc42-logo.png[arc42] Template
+= image:arc42-logo.png[arc42] WIQ 05b
 :revnumber: 8.2 EN
 :revdate: January 2023
 :revremark: (based upon AsciiDoc version)
@@ -34,17 +34,6 @@ include::src/about-arc42.adoc[]
 // horizontal line
 ***
 
-[role="arc42help"]
-****
-[NOTE]
-====
-This version of the template contains some help and explanations.
-It is used for familiarization with arc42 and the understanding of the concepts.
-For documentation of your own system you use better the _plain_ version.
-====
-****
-
-
 // numbering from here on
 :numbered:
 

diff --git a/docs/prototypes/about_view.drawio.png b/docs/prototypes/about_view.drawio.png
diff --git a/docs/prototypes/game_menu_view.drawio.png b/docs/prototypes/game_menu_view.drawio.png
diff --git a/docs/prototypes/home_view.drawio.png b/docs/prototypes/home_view.drawio.png
diff --git a/docs/prototypes/login_view.drawio.png b/docs/prototypes/login_view.drawio.png
diff --git a/docs/prototypes/signup_view.drawio.png b/docs/prototypes/signup_view.drawio.png
diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc
@@ -3,19 +3,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 [[section-introduction-and-goals]]
 == Introduction and Goals
 
-[role="arc42help"]
-****
-Describes the relevant requirements and the driving forces that software architects and development team must consider. 
-These include
-
-* underlying business goals, 
-* essential features, 
-* essential functional requirements, 
-* quality goals for the architecture and
-* relevant stakeholders and their expectations
-****
-
-WIQ is a project forked from the University of Oviedo latest base repo offered by the Software Architecture course. The development team (es05b) is formed by the following engineering students:
+WIQ (Wikidata Infinite Quest) is a project forked from the University of Oviedo latest base repo offered by the Software Architecture course. The development team (es05b) is formed by the following engineering students:
 
 * Donato Martín, [email protected]
 * Luna Valdés, [email protected]
@@ -29,35 +17,12 @@ This is basically a Trivial Pursuit like game inspired in spanish TV show "Saber
 * Different question categories
 * A history of past games
 
+.El presentador Jordi Hurtado RTVE. Imagen de "www.elconfidencial.com".
+image::01_jordi_hurtado_happy.jpg[Jordi Hurtado, 1600, 900, align="center"]
 
-image::jordi-hurtado-happy.jpg["Jordi Hurtado"]
 
 === Requirements Overview
 
-[role="arc42help"]
-****
-.Contents
-Short description of the functional requirements, driving forces, extract (or abstract)
-of requirements. Link to (hopefully existing) requirements documents
-(with version number and information where to find it).
-
-.Motivation
-From the point of view of the end users a system is created or modified to
-improve support of a business activity and/or improve the quality.
-
-.Form
-Short textual description, probably in tabular use-case format.
-If requirements documents exist this overview should refer to these documents.
-
-Keep these excerpts as short as possible. Balance readability of this document with potential redundancy w.r.t to requirements documents.
-
-
-.Further Information
-
-See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 documentation.
-
-****
-
 Users will be able to interact with our system in a lot of different ways.
 
 * A fun Q&A game
@@ -69,26 +34,6 @@ More information can be obtained following this https://docs.google.com/document
 
 === Quality Goals
 
-[role="arc42help"]
-****
-.Contents
-The top three (max five) quality goals for the architecture whose fulfillment is of highest importance to the major stakeholders. 
-We really mean quality goals for the architecture. Don't confuse them with project goals.
-They are not necessarily identical.
-
-Consider this overview of potential topics (based upon the ISO 25010 standard):
-
-image::01_2_iso-25010-topics-EN.drawio.png["Categories of Quality Requirements"]
-
-.Motivation
-You should know the quality goals of your most important stakeholders, since they will influence fundamental architectural decisions. 
-Make sure to be very concrete about these qualities, avoid buzzwords.
-If you as an architect do not know how the quality of your work will be judged...
-
-.Form
-A table with quality goals and concrete scenarios, ordered by priorities
-****
-
 The following table describes the project's quality goals in a descending order.
 
 |=== 
@@ -109,49 +54,31 @@ The following table describes the project's quality goals in a descending order.
 | *_Testability_*
 | The performance of the system is needed to be tested covering as many use cases as possible so all the other goals will be met.
 
-| *_Accessibility_*
-| The project should be accesible and fun for all types of user, a game must always be as open as the development capabilities allow.
-
 |=== 
 
 === Stakeholders
 
-[role="arc42help"]
-****
-.Contents
-Explicit overview of stakeholders of the system, i.e. all person, roles or organizations that
-
-* should know the architecture
-* have to be convinced of the architecture
-* have to work with the architecture or with code
-* need the documentation of the architecture for their work
-* have to come up with decisions about the system or its development
-
-.Motivation
-You should know all parties involved in development of the system or affected by the system.
-Otherwise, you may get nasty surprises later in the development process.
-These stakeholders determine the extent and the level of detail of your work and its results.
-
-.Form
-Table with role names, person names, and their expectations with respect to the architecture and its documentation.
-****
-
-[options="header",cols="1,2,2"]
-
 |===
-
-|Role/Name|Description|Expectations
-
-| _Development Team_
-| Donato Martín, Luna Valdés, Álvaro García, Rubén Rubio and David Álvarez 
+| Role/Name | Description | Expectations
+
+| *_Development Team_*
+a| 
+* Donato Martín
+* Luna Valdés
+* Álvaro García
+* Rubén Rubio
+* David Álvarez 
 | The engineering students are expected to improve communication, teamwork and coding skills adopting a developer role in this project.
 
-| _Teachers_
-| José Emilio Labra and Cristian Augusto Alonso
+| *_Teachers_*
+a|
+- José Emilio Labra
+- Cristian Augusto Alonso
 | Teachers are in charge of supervising the developers work aswell as helping them solve environment, development issues or any other that may arise.
 
-| _Users_
-| Final users of WIQ
+| *_Users_*
+a|
+- Final users of WIQ
 | They are just expected to use this project as it is intended to work.
 
 |===
diff --git a/docs/src/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc
@@ -35,6 +35,7 @@ Therefore, we have chosen to adhere to them
 [options="header",cols="2,7"]
 |===
 | Constraint | Explanation
+
 |*_Docker_*
 | The app will be running in a Docker Host
 due to interoperability, security, and ease of deployment.
@@ -44,9 +45,7 @@ due to interoperability, security, and ease of deployment.
 | A JavaScript framework used for constructing visual interfaces.
 |*_Git/GitHub_*
 | Our development process will leverage Git for version control and GitHub as a remote repository. This combination empowers us to:
-collaborate effectively, maintain a clean codebase and assign tasks efficiently.
-
-
+collaborate effectively, maintain a clean codebase and assign tasks
 |===
 
 [options="header",cols="2,7"]
@@ -61,7 +60,7 @@ collaborate effectively, maintain a clean codebase and assign tasks efficiently.
 |*_Time_*
 | Deadline at the end of the semester,
 the time is divided among two hours per week of in-class work, multiple meetings with team members, and individual self-work.
-During this period, we have four deliverables, all of which will receive professor feedback
+
 |*_Testing_*
 | Various scenarios will be explored to assess the application's functionality accurately. Diverse testing techniques
 will be employed to achieve comprehensive coverage, aiming for the highest possible quality assurance.
@@ -78,8 +77,7 @@ in developing a real-world application.
 
 | Constraint | Explanation
 
-|*_Performance_*
-| As the game is under development, performance optimization becomes a key objective. Achieving fast and efficient gameplay is crucial|*_Clean Code_*
+|*_Clean Code_*
 |The code composing the application must prioritize clarity and cleanliness, facilitating comprehension and ease of
 maintenance in the long term
 

diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc
@@ -3,32 +3,6 @@ ifndef::imagesdir[:imagesdir: ../images]
 [[section-system-scope-and-context]]
 == System Scope and Context
 
-
-[role="arc42help"]
-****
-.Contents
-System scope and context - as the name suggests - delimits your system (i.e. your scope) from all its communication partners
-(neighboring systems and users, i.e. the context of your system). It thereby specifies the external interfaces.
-
-If necessary, differentiate the business context (domain specific inputs and outputs) from the technical context (channels, protocols, hardware).
-
-.Motivation
-The domain interfaces and technical interfaces to communication partners are among your system's most critical aspects. Make sure that you completely understand them.
-
-.Form
-Various options:
-
-* Context diagrams
-* Lists of communication partners and their interfaces.
-
-
-.Further Information
-
-See https://docs.arc42.org/section-3/[Context and Scope] in the arc42 documentation.
-
-****
-
-
 === Business Context
 
 [role="arc42help"]
@@ -51,11 +25,12 @@ The title of the table is the name of your system, the three columns contain the
 
 **Business Context diagram**
 
-image::03_business_context.png["Business Context diagram"]
 
-[options="header",cols="1,3,3"] 
-|===  
-|Communication partners |Inputs | Outputs
+
+image::03_business_context.drawio.png["Diagram of business context", align="center"]
+
+|===
+| Communication partners | Inputs | Outputs
 
 | *_WIQ_*
 | Interaction with wikidata to get the questions and answers and with the user to know their response
@@ -68,33 +43,17 @@ image::03_business_context.png["Business Context diagram"]
 | *_Wikidata_*
 | Request for questions and answers
 | Questions and answers 
-|===
 
-image::03_business_context.png["Diagram of business context"]
+|===
 
 === Technical Context
 
-[role="arc42help"]
-****
-.Contents
-Technical interfaces (channels and transmission media) linking your system to its environment. In addition a mapping of domain specific input/output to the channels, i.e. an explanation which I/O uses which channel.
-
-.Motivation
-Many stakeholders make architectural decision based on the technical interfaces between the system and its context. Especially infrastructure or hardware designers decide these technical interfaces.
-
-.Form
-E.g. UML deployment diagram describing channels to neighboring systems,
-together with a mapping table showing the relationships between channels and input/output.
-
-****
-
 **Technical Context diagram**
 
-image::04_technical_context.png["Technical Context diagram"]
+image::03_technical_context.drawio.png["Technical Context diagram", align="center"]
 
-[options="header",cols="1,3,3"] 
 |===  
-|Communication partners |Inputs | Outputs
+| Communication partners | Inputs | Outputs
 
 | *_WIQ_*
 | Questions and user outputs