issue #85: fixed some markdown linting errors

ai-cfia · May 1, 2024 · 0bf68f5 · 0bf68f5
1 parent 5ad3d05
commit 0bf68f5
Show file tree

Hide file tree

Showing 9 changed files with 304 additions and 196 deletions.
diff --git a/adr/001-ailab-using-adr.en-ca.md b/adr/001-ailab-using-adr.en-ca.md
@@ -28,7 +28,7 @@ process to enable collective deliberation and decision-making.
   pages, commonly used for documentation ([Lebar, 2022](#lebar)).
 - Request for Comment (RFC): A process that enables collective deliberation on a
   particular issue or proposed feature, often formalized and version-controlled
-  ([Calçado, 2018](#calcado)).
+  ([Calçado, 2018](#calçado)).
 - Confluence: A collaboration software program developed by Atlassian that
   functions as an enterprise wiki and project management tool ([Atlassian,
   n.d.](#atlassian)).
@@ -60,7 +60,7 @@ version-controlled and easily accessible record of important architectural
 decisions. Each ADR will detail the reasoning, background, and consequences of
 significant architectural choices, not trivial decisions.
 
-#### Example of decisions that could be addressed by ADR
+### Example of decisions that could be addressed by ADR
 
 - Which database engine should we use and why?
 - Should we move to a microservices architecture?
@@ -73,7 +73,7 @@ significant architectural choices, not trivial decisions.
 - Which message broker to use for asynchronous operations?
 - What is our strategy for data backup and recovery?
 
-#### Example of decisions that should not be addressed by ADR
+### Example of decisions that should not be addressed by ADR
 
 - What color should the login button be?
 - How do we implement a specific function in code?
@@ -201,7 +201,7 @@ Cons:
 - Prone to becoming outdated.
 - Inadequate for tracking decision history.
 
-### [Request for Comments (RFC)](#calcado)
+### [Request for Comments (RFC)](#calçado)
 
 Pros:
 
@@ -251,52 +251,52 @@ Cons:
 
 ## References
 
-#### Ayers
+### Ayers
 
 Ayers, D. (10 mai 2019). Communicating and Documenting Architectural Decisions.
-Retrieved from https://www.youtube.com/watch?v=rwfXkSjFhzc
+Retrieved from <https://www.youtube.com/watch?v=rwfXkSjFhzc>
 
-#### Atlassian
+### Atlassian
 
 Atlassian. (n. d.). DACI: Decision Documentation. Retrieved from
-https://www.atlassian.com/software/confluence/templates/decision
+<https://www.atlassian.com/software/confluence/templates/decision>
 
-#### Calçado
+### Calçado
 
 Calçado, P. (19 novembre 2018). A Structured RFC Process. Retrieved from
-https://philcalcado.com/2018/11/19/a_structured_rfc_process.html
+<https://philcalcado.com/2018/11/19/a_structured_rfc_process.html>
 
-#### Henderson
+### Henderson
 
 Henderson, J. P. (n. d.). Architecture Decision Record (ADR). Retrieved from
-https://github.com/joelparkerhenderson/architecture-decision-record
+<https://github.com/joelparkerhenderson/architecture-decision-record>
 
-#### LeBar
+### LeBar
 
 LeBar, Z. (5 mars 2022). What Are Wikis, and Why Should You Use Them?
 Retrieved from
-https://business.tutsplus.com/tutorials/what-are-wikis-and-why-should-you-use-them--cms-19540
+<https://business.tutsplus.com/tutorials/what-are-wikis-and-why-should-you-use-them--cms-19540>
 
-#### Microsoft
+### Microsoft
 
 Microsoft. (20 mars 2020). Record Architecture Decisions.
 Code With Engineering Playbook. Retrieved from
-https://microsoft.github.io/code-with-engineering-playbook/design/design-reviews/decision-log/doc/adr/0001-record-architecture-decisions/
+<https://microsoft.github.io/code-with-engineering-playbook/design/design-reviews/decision-log/doc/adr/0001-record-architecture-decisions/>
 
-#### Monday
+### Monday
 
 Monday.com. (n. d.). How to Use a Project Decision Log
 for Optimal Results.
-Retrieved from https://monday.com/blog/project-management/decision-log/
+Retrieved from <https://monday.com/blog/project-management/decision-log/>
 
-#### American Psychological Association
+### American Psychological Association
 
 American Psychological Association. (n. d.).
 Reference Examples. Retrieved from
-https://apastyle.apa.org/style-grammar-guidelines/references/examples
+<https://apastyle.apa.org/style-grammar-guidelines/references/examples>
 
-#### Library of Congress
+### Library of Congress
 
 Library of Congress. (2017, December 21). Codes for the
 Representation of Names of Languages. Retrieved from
-https://www.loc.gov/standards/iso639-2/php/code_list.php
+<https://www.loc.gov/standards/iso639-2/php/code_list.php>
diff --git a/adr/001-ailab-using-adr.fr-ca.md b/adr/001-ailab-using-adr.fr-ca.md
@@ -30,7 +30,7 @@ délibération collective et la prise de décision.
   2022](#lebar)).
 - Demande de Commentaires (RFC) : Une méthode permettant des discussions
   collectives sur un problème ou une fonctionnalité proposée, souvent formalisée
-  et contrôlée par version ([Calçado, 2018](#calcado)).
+  et contrôlée par version ([Calçado, 2018](#calçado)).
 - Confluence : Un logiciel de collaboration développé par Atlassian, servant de
   wiki d'entreprise et d'outil de gestion de projet ([Atlassian,
   s.d.](#atlassian)).
@@ -65,7 +65,7 @@ décisions architecturales importantes. Chaque ADR détaillera le raisonnement,
 contexte et les conséquences de choix architecturaux significatifs, mais pas des
 décisions triviales.
 
-#### Exemples de décisions qui pourraient être abordées par un ADR
+### Exemples de décisions qui pourraient être abordées par un ADR
 
 - Quel moteur de base de données devrions-nous utiliser et pourquoi ?
 - Devrions-nous passer à une architecture de microservices ?
@@ -79,7 +79,7 @@ décisions triviales.
 - Quel courtier de messages utiliser pour les opérations asynchrones ?
 - Quelle est notre stratégie pour la sauvegarde et la récupération des données ?
 
-#### Exemples de décisions qui ne devraient pas être abordées par un ADR
+### Exemples de décisions qui ne devraient pas être abordées par un ADR
 
 - De quelle couleur devrait être le bouton de connexion ?
 - Comment implémentons-nous une fonction spécifique dans le code ?
@@ -214,7 +214,7 @@ Inconvénients :
 - Risque de devenir obsolète.
 - Inadéquat pour suivre l'historique des décisions.
 
-### [Demande de Commentaires (RFC)](#calcado)
+### [Demande de Commentaires (RFC)](#calçado)
 
 Avantages :
 
@@ -267,52 +267,52 @@ Inconvénients :
 
 ## Références
 
-#### Ayers
+### Ayers
 
 Ayers, D. (10 mai 2019). Communicating and Documenting Architectural Decisions.
-Retrieved from https://www.youtube.com/watch?v=rwfXkSjFhzc
+Retrieved from <https://www.youtube.com/watch?v=rwfXkSjFhzc>
 
-#### Atlassian
+### Atlassian
 
 Atlassian. (n. d.). DACI: Decision Documentation. Retrieved from
-https://www.atlassian.com/software/confluence/templates/decision
+<https://www.atlassian.com/software/confluence/templates/decision>
 
-#### Calçado
+### Calçado
 
 Calçado, P. (19 novembre 2018). A Structured RFC Process. Retrieved from
-https://philcalcado.com/2018/11/19/a_structured_rfc_process.html
+<https://philcalcado.com/2018/11/19/a_structured_rfc_process.html>
 
-#### Henderson
+### Henderson
 
 Henderson, J. P. (n. d.). Architecture Decision Record (ADR). Retrieved from
-https://github.com/joelparkerhenderson/architecture-decision-record
+<https://github.com/joelparkerhenderson/architecture-decision-record>
 
-#### LeBar
+### LeBar
 
 LeBar, Z. (5 mars 2022). What Are Wikis, and Why Should You Use Them?
 Retrieved from
-https://business.tutsplus.com/tutorials/what-are-wikis-and-why-should-you-use-them--cms-19540
+<https://business.tutsplus.com/tutorials/what-are-wikis-and-why-should-you-use-them--cms-19540>
 
-#### Microsoft
+### Microsoft
 
 Microsoft. (20 mars 2020). Record Architecture Decisions.
 Code With Engineering Playbook. Retrieved from
-https://microsoft.github.io/code-with-engineering-playbook/design/design-reviews/decision-log/doc/adr/0001-record-architecture-decisions/
+<https://microsoft.github.io/code-with-engineering-playbook/design/design-reviews/decision-log/doc/adr/0001-record-architecture-decisions/>
 
-#### Monday
+### Monday
 
 Monday.com. (n. d.). How to Use a Project Decision Log
 for Optimal Results.
-Retrieved from https://monday.com/blog/project-management/decision-log/
+Retrieved from <https://monday.com/blog/project-management/decision-log/>
 
-#### American Psychological Association
+### American Psychological Association
 
 American Psychological Association. (n. d.).
 Reference Examples. Retrieved from
-https://apastyle.apa.org/style-grammar-guidelines/references/examples
+<https://apastyle.apa.org/style-grammar-guidelines/references/examples>
 
-#### Library of Congress
+### Library of Congress
 
 Library of Congress. (2017, December 21). Codes for the
 Representation of Names of Languages. Retrieved from
-https://www.loc.gov/standards/iso639-2/php/code_list.php
+<https://www.loc.gov/standards/iso639-2/php/code_list.php>
diff --git a/adr/002-database-structure.md b/adr/002-database-structure.md
@@ -47,7 +47,6 @@ name "Agence canadienne d'inspection des aliments", and the Canadian flag, which
 signifies the national scope and authority of the
 organization.](./002-database-structure-diagram.png)
 
-
 ## Executive Summary
 
 This Architecture Decision Record (ADR) describes our plan to promote sharing
@@ -120,7 +119,7 @@ Cons:
 - **Potential data conflicts:** Separate databases may result in data conflicts,
   especially when different teams or products need to update the same data
   simultaneously. These conflicts can lead to data inconsistencies and errors.
-  [Toptal - Database Design Bad Practices](#ref-toptal)
+  [Toptal - Database Design Bad Practices](#toptal)
 
 In summary, while the "Separate Databases (Current Setup)" option provides
 initial clarity, it has serious disadvantages, such as redundancy, decreased
@@ -134,13 +133,13 @@ Pros:
 - **Enhanced teamwork:** By using a single consolidated database, teams can
   collaborate more effectively. By having only one database, sharing and
   accessing data becomes simpler, which can lead to improved cross-functional
-  cooperation. [Budibase - How to Integrate Multiple Databases](#ref-budibase)
+  cooperation. [Budibase - How to Integrate Multiple Databases](#budibase)
 
 - **Elimination of repeated data:** This approach eliminates the need for
   redundant data. All information is stored in one place, reducing data
   duplication and ensuring data consistency. If I create a file in one database,
   I can access it in another without the need to recreate it. [Matillion - What
-  is Data Consolidation?](#ref-matillon)
+  is Data Consolidation?](#matillon)
 
 - **Greater flexibility in product management:** A consolidated database
   provides greater flexibility in managing different products. It allows for
@@ -161,16 +160,16 @@ Cons:
   leading to temporary challenges. This required the team to have a good
   planning or prototype about schema and clear relationships between databases.
 
-## Consequences:
+## Consequences
 
-### Positive Consequences:
+### Positive Consequences
 
 - Collaboration will be better because teams will operate more smoothly and
   promote stronger cross-functional cooperation.
 - By eliminating redundant data, the single database will produce information
   that is more accurate and dependable.
 
-### Negative Consequences:
+### Negative Consequences
 
 - Renaming and moving files will necessitate a significant initial effort.
 - Adapting to the new structure may temporarily complicate the development
@@ -181,16 +180,20 @@ Cons:
 Any documentation, research, or data that support the decision can be cited
 here. This can include academic papers, blog posts, or internal documents.
 
-<a id="ref-toptal"></a>Toptal, J. P. (n.d.)
+#### Toptal
+
+Blog. (n.d.). Toptal. [Database Design Bad Practices,
+https://www.toptal.com/]
+(https://www.toptal.com/database/database-design-bad-practices)>
+
+#### Budibase
 
-* Blog. (n.d.). Toptal. [Database Design Bad Practices,
-  https://www.toptal.com/](https://www.toptal.com/database/database-design-bad-practices)
-  <a id="ref-toptal"></a>
+Blog. (2022, Mai 22). Budibase. [How to Integrate Multiple Databases,
+https://budibase.com/]
+(https://budibase.com/blog/data/how-to-integrate-multiple-databases)
 
-* Blog. (2022, Mai 22). Budibase. [How to Integrate Multiple Databases,
-  https://budibase.com/](https://budibase.com/blog/data/how-to-integrate-multiple-databases)
-  <a id="ref-budibase"></a>
+#### Matillion
 
-* Blog. (2020, Décembre 16). Matillion. [What is Data Consolidation?,
-  https://www.matillion.com/](https://www.matillion.com/blog/what-is-data-consolidation)
-  <a id="ref-matillon"></a>
+Blog. (2020, Décembre 16). Matillion. [What is Data Consolidation?,
+https://www.matillion.com/]
+(https://www.matillion.com/blog/what-is-data-consolidation)