diff --git a/adr/001-ailab-using-adr.en-ca.md b/adr/001-ailab-using-adr.en-ca.md index adb566b..0386868 100644 --- 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 -#### Atlassian +### Atlassian Atlassian. (n. d.). DACI: Decision Documentation. Retrieved from -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 + -#### Henderson +### Henderson Henderson, J. P. (n. d.). Architecture Decision Record (ADR). Retrieved from -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 + -#### 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/ + -#### 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 -#### American Psychological Association +### American Psychological Association American Psychological Association. (n. d.). Reference Examples. Retrieved from -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 + diff --git a/adr/001-ailab-using-adr.fr-ca.md b/adr/001-ailab-using-adr.fr-ca.md index b8a28b8..83fef28 100644 --- 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 -#### Atlassian +### Atlassian Atlassian. (n. d.). DACI: Decision Documentation. Retrieved from -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 + -#### Henderson +### Henderson Henderson, J. P. (n. d.). Architecture Decision Record (ADR). Retrieved from -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 + -#### 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/ + -#### 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 -#### American Psychological Association +### American Psychological Association American Psychological Association. (n. d.). Reference Examples. Retrieved from -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 + diff --git a/adr/002-database-structure.md b/adr/002-database-structure.md index cb2b4db..1f9db3c 100644 --- 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. -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) - +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) - +#### Matillion -* Blog. (2020, Décembre 16). Matillion. [What is Data Consolidation?, - https://www.matillion.com/](https://www.matillion.com/blog/what-is-data-consolidation) - +Blog. (2020, Décembre 16). Matillion. [What is Data Consolidation?, +https://www.matillion.com/] +(https://www.matillion.com/blog/what-is-data-consolidation) diff --git a/adr/003-database-choice.md b/adr/003-database-choice.md index 91d2a05..8fb9abf 100644 --- a/adr/003-database-choice.md +++ b/adr/003-database-choice.md @@ -20,7 +20,7 @@ reduce operational costs. ## Decision The AI Lab decided to adopt PostgreSQL ([PostgreSQL Tutorial, -n.d.](#ref-tutorial) and [P. G. D. Group, 2023](#ref-postgres)) as our DBMS due +n.d.](#tutorial) and [P. G. D. Group, 2023](#postgres)) as our DBMS due to its open source nature and the presence of a large and active community. This guarantees regular updates, bug fixes, and a rich array of extensions and plugins such as pgvector and PostGIS, making it exceptionally well-suited for @@ -32,7 +32,7 @@ applications. Through other commercial versions such as [Citus](https://www.citusdata.com/) (now owned by Microsoft) or [Timescale](https://www.timescale.com/), Postgresql -is the top database for big data ([Stack Overflow, n.d.](#ref-survey)). We use +is the top database for big data ([Stack Overflow, n.d.](#survey)). We use Azure Flexible Postgresql which comes with better integration with Azure cloud. While PostgreSQL has several advantages, it's important to consider the cons as @@ -49,15 +49,15 @@ Pros: PostgreSQL stands out as a great DBMS solution that offers traditional database benefits with an emphasis on reliability and maturity ([T. Brown, -2023](#ref-database)). Notably, it's also available as a Database-as-a-Service +2023](#database)). Notably, it's also available as a Database-as-a-Service in Azure. Here are some key advantages of PostgreSQL: - Open Source and Community Support: Its open source nature and a community of thousands of people ensure regular updates, bug fixes, and a lot of extensions and plugins. There are more than a dozen mailing lists available as well as associated archives. For example, you can find monthly reviews of third party - software's update. ([PostgreSQL announce, n.d.](#ref-announce), [PostgreSQL - general, n.d.](#ref-general), and [PostgreSQL hackers, n.d.](#ref-hackers)) + software's update. ([PostgreSQL announce, n.d.](#announce), [PostgreSQL + general, n.d.](#general), and [PostgreSQL hackers, n.d.](#hackers)) - Security Features: Role-based access control, SSL/TLS support, and data encryption. - Reliability: Highly reliable and has a proven track record for handling @@ -65,10 +65,10 @@ in Azure. Here are some key advantages of PostgreSQL: Consistency, Isolation, Durability) properties, ensuring data integrity. For example, Microsoft used an analytics dashboard, which tracks quality of Windows updates analyzing 20K types of metrics from over 1.2 billion Windows - devices ([TECHCOMMUNITY.MICROSOFT.COM, 2023](#ref-architecture)). + devices ([TECHCOMMUNITY.MICROSOFT.COM, 2023](#architecture)). - Diverse Data Types and Extensions: Supports a wide variety of data types (for example smallint, integer, decimal, numeric, real, serial...) and has powerful - extensions such as pgvector ([B. Bytes, 2023](#ref-pgvector)) which is crucial + extensions such as pgvector ([B. Bytes, 2023](#pgvector)) which is crucial for handling vector data in our AI applications. Also provides robust support for spatial and geographic data through PostGIS. @@ -104,15 +104,15 @@ Pros: engineering. - Performance: Provide high speed and low latency, well-suited for performance-intensive situations ([K. Velusamy & S. Goyal, - 2023](#ref-compare2)). + 2023](#compare2)). Cons: - Detailed information: While it provides auto-indexing functionality, it can sometimes be a little mysterious and may require intentional thought - ([TrustRadius, n.d.](#ref-compare1)). + ([TrustRadius, n.d.](#compare1)). - Not a relational database: Doesn't support transactions between documents and - has a 10 000 collection limit ([R. Arciola, 2022](#ref-cosmos)). + has a 10 000 collection limit ([R. Arciola, 2022](#cosmos)). - No local emulator: To test code, deployment to Azure is required. Can quickly become time consuming. - Expensive: Licensing costs. Also gets expensive if it’s used for scenarios @@ -144,31 +144,63 @@ PostgreSQL for our projects. ## References -- Brown, T. (2023, January 19). Why more and more - enterprises are choosing postgresql as their go-to database!. EDB. - -- Bytes, B. (2023, July 27). Postgres pgvector - extension - vector database with PostgreSQL / Langchain Integration. YouTube. - -- Group, P. G. D. (2023, October 31). PostgreSQL. - -- Pgsql-announce. PostgreSQL. (n.d.-a). - -- Pgsql-general. PostgreSQL. (n.d.-b). - -- Pgsql-hackers. PostgreSQL. (n.d.-c). - -- Stack overflow developer survey 2023. Stack Overflow. - (n.d.). - -- What is postgresql?. PostgreSQL Tutorial. (n.d.). - -- Azure cosmos DB vs PostgreSQL. TrustRadius. (n.d.). - -- Velusamy, K., & Goyal, S. (2023, July 7). Azure - cosmos DB vs PostgreSQL : Compare differences. Whizlabs Blog. - -- Arciola, R. (2022, April 20). Azure cosmos DB: Fast, - Globally Distributed, NoSQL Cloud Database for your internet of anything. - LinkedIn. - +### Database + +Brown, T. (2023, January 19). Why more and more +enterprises are choosing postgresql as their go-to database!. EDB. + + +### Pgvector + +Bytes, B. (2023, July 27). Postgres pgvector +extension - vector database with PostgreSQL / Langchain Integration. YouTube. + + +### Postgres + +Group, P. G. D. (2023, October 31). PostgreSQL. + + +### Announce + +Pgsql-announce. PostgreSQL. (n.d.-a). + + +### General + +Pgsql-general. PostgreSQL. (n.d.-b). + + +### Hackers + +Pgsql-hackers. PostgreSQL. (n.d.-c). + + +### Survey + +Stack overflow developer survey 2023. Stack Overflow. +(n.d.). + + +### Tutorial + +What is postgresql?. PostgreSQL Tutorial. (n.d.). + + +### Compare1 + +Azure cosmos DB vs PostgreSQL. TrustRadius. (n.d.). + + +### Compare2 + +Velusamy, K., & Goyal, S. (2023, July 7). Azure +cosmos DB vs PostgreSQL : Compare differences. Whizlabs Blog. + + +### Cosmos + +Arciola, R. (2022, April 20). Azure cosmos DB: Fast, +Globally Distributed, NoSQL Cloud Database for your internet of anything. +LinkedIn. + diff --git a/adr/004-open-source-development.md b/adr/004-open-source-development.md index 5700c71..062daf5 100644 --- a/adr/004-open-source-development.md +++ b/adr/004-open-source-development.md @@ -192,39 +192,53 @@ guidelines, will be instituted to mitigate these risks. ## References -* Microsoft’s Open Source Program. Microsoft Open Source. (n.d.). -[https://opensource.microsoft.com/program/#program-using](https://opensource.microsoft.com/program/#program-using) - +### Ref1 -* The Open Source Definition. Open Source Initiative. (2023, February 22). -[https://opensource.org/osd/](https://opensource.org/osd/) +Microsoft’s Open Source Program. Microsoft Open Source. (n.d.). +[https://opensource.microsoft.com/program/#program-using] +(https://opensource.microsoft.com/program/#program-using) -* Homepage. Free Software Foundation. (n.d.). -[https://www.fsf.org/](https://www.fsf.org/) +### Ref2 -* microsoft/vscode. (n.d.). GitHub. -[https://github.com/microsoft/vscode](https://github.com/microsoft/vscode) +The Open Source Definition. Open Source Initiative. (2023, February 22). +[https://opensource.org/osd/](https://opensource.org/osd/) -* Azure. (n.d.). GitHub. -[https://github.com/Azure/bicep](https://github.com/Azure/bicep) +### Ref3 -* Project Jupyter. (n.d.). GitHub. -[https://github.com/jupyter](https://github.com/jupyter) +Homepage. Free Software Foundation. (n.d.). +[https://www.fsf.org/](https://www.fsf.org/) -* Openssl. (n.d.). GitHub. -[https://github.com/openssl/openssl](https://github.com/openssl/openssl) +### Ref4 -* Git. (n.d.). GitHub. [https://github.com/git/git](https://github.com/git/git) - +microsoft/vscode. (n.d.). GitHub. +[https://github.com/microsoft/vscode](https://github.com/microsoft/vscode) -* Alpha canada.ca - Canada.ca. (n.d.). +### Ref5 + +Azure. (n.d.). GitHub. +[https://github.com/Azure/bicep](https://github.com/Azure/bicep) + +### Ref6 + +Project Jupyter. (n.d.). GitHub. +[https://github.com/jupyter](https://github.com/jupyter) + +### Ref7 + +Openssl. (n.d.). GitHub. +[https://github.com/openssl/openssl](https://github.com/openssl/openssl) + +### Ref8 + +Git. (n.d.). GitHub. [https://github.com/git/git](https://github.com/git/git) + +### Ref9 + +Alpha canada.ca - Canada.ca. (n.d.). [https://alpha.canada.ca/en/index.html](https://alpha.canada.ca/en/index.html) - -* Secretariat, T. B. O. C. (2021, August 13). Government of Canada Digital +### Ref10 + +Secretariat, T. B. O. C. (2021, August 13). Government of Canada Digital Standards. Canada.ca. [https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html](https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html) - diff --git a/adr/005-choosing-web-development-framework.md b/adr/005-choosing-web-development-framework.md index a1e8c7f..ad0de35 100644 --- a/adr/005-choosing-web-development-framework.md +++ b/adr/005-choosing-web-development-framework.md @@ -188,37 +188,57 @@ globally recognized, credible, and accessible source of AI knowledge. ## References -* Homepage. (n.d.). Docusaurus. [https://docusaurus.io/](https://docusaurus.io/) +### Ref1 -* Secretariat, T. B. O. C. (2021, August 13). Government of Canada Digital - Standards. - Canada.ca. [https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html](https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html) - +Homepage. (n.d.). Docusaurus. [https://docusaurus.io/](https://docusaurus.io/) -* i18n - Introduction. (2023, October 31). -Docusaurus. [https://docusaurus.io/docs/i18n/introduction](https://docusaurus.io/docs/i18n/introduction) +### Ref2 -* Internationalization and localization. (n.d.). -Wikipedia. [https://en.wikipedia.org/wiki/Internationalization_and_localization](https://en.wikipedia.org/wiki/Internationalization_and_localization) - +Secretariat, T. B. O. C. (2021, August 13). Government of Canada Digital +Standards. +Canada.ca. [https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html](https://www.canada.ca/en/government/system/digital-governmentgovernment-canada-digital-standards.html) -* Math Equations. (2023, October 31). -Docusaurus. [https://docusaurus.io/docs/markdown-features/math-equations](https://docusaurus.io/docs/markdown-features/math-equations) - +### Ref3 -* Plugins. (2023, October 31). -Docusaurus. [https://docusaurus.io/docs/advanced/plugins](https://docusaurus.io/docs/advanced/plugins) +i18n - Introduction. (2023, October 31). +Docusaurus. [https://docusaurus.io/docs/i18n/introduction] +(https://docusaurus.io/docs/i18n/introduction) -* Search engine optimization (SEO). (2023, October 31). +### Ref4 + +Internationalization and localization. (n.d.). +Wikipedia. [https://en.wikipedia.org/wiki/Internationalization_and_localization] +(https://en.wikipedia.org/wiki/Internationalization_and_localization) + +### Ref5 + +Math Equations. (2023, October 31). +Docusaurus. [https://docusaurus.io/docs/markdown-features/math-equations] +(https://docusaurus.io/docs/markdown-features/math-equations) + +### Ref6 + +Plugins. (2023, October 31). +Docusaurus. [https://docusaurus.io/docs/advanced/plugins] +(https://docusaurus.io/docs/advanced/plugins) + +### Ref7 + +Search engine optimization (SEO). (2023, October 31). Docusaurus. [https://docusaurus.io/docs/seo](https://docusaurus.io/docs/seo) - -* Homepage. (n.d.). Jekyll. [https://jekyllrb.com/](https://jekyllrb.com/) - +### Ref8 + +Homepage. (n.d.). Jekyll. [https://jekyllrb.com/](https://jekyllrb.com/) + +### Ref9 + +Homepage. (n.d.). Hugo. [https://gohugo.io/](https://gohugo.io/) + +### Ref10 -* Homepage. (n.d.). Hugo. [https://gohugo.io/](https://gohugo.io/) - +Homepage. (n.d.). Gatsby. [https://www.gatsbyjs.com/](https://www.gatsbyjs.com/) -* Homepage. (n.d.). Gatsby. [https://www.gatsbyjs.com/](https://www.gatsbyjs.com/) +### Ref11 -* Homepage. (n.d.). Wordpress. [https://wordpress.com/](https://wordpress.com/) +Homepage. (n.d.). Wordpress. [https://wordpress.com/](https://wordpress.com/) diff --git a/adr/006-database-change-management.md b/adr/006-database-change-management.md index 90589af..eb6ea99 100644 --- a/adr/006-database-change-management.md +++ b/adr/006-database-change-management.md @@ -35,7 +35,8 @@ To address the context and requirements, the following approach is adopted: version control. Semantic Versioning helps developers and users understand the nature of the changes in a new version of a software package, making it easier to manage dependencies and assess compatibility. It usually is in this format - : x.x.x (MAJOR.MINOR.PATCH) with each x being a number. ([PostgreSQL wiki, n.d.](#ref-changes)) + : x.x.x (MAJOR.MINOR.PATCH) with each x being a number. + ([PostgreSQL wiki, n.d.](#changes)) In our case, we use louis_x.x.x - a MAJOR release would break the database, it includes modifying @@ -238,4 +239,8 @@ complexities and potential challenges. ## References -* Change management tools and techniques. Change management tools and techniques - PostgreSQL wiki. (n.d.). +### Changes + +Change management tools and techniques. Change management tools and techniques +- PostgreSQL wiki. (n.d.). + diff --git a/adr/007-code-hosting-platform.md b/adr/007-code-hosting-platform.md index a2b0e9c..7cfc37b 100644 --- a/adr/007-code-hosting-platform.md +++ b/adr/007-code-hosting-platform.md @@ -203,16 +203,23 @@ Features](https://comparecamp.com/bitbucket-review-pricing-pros-cons-features/) [Capterra * Bitbucket Reviews 2023](https://www.capterra.com/p/166497/Bitbucket/reviews/) -[https://about.gitlab.com/customers/iron-mountain/](https://about.gitlab.com/customers/iron-mountain/) - -[The state of open source software](https://octoverse.github.com/) +### Ref1 [Government of Canada Digital Standards: -Playbook](https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html) +Playbook](https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html) + +### Ref2 + +[The state of open source software] +(https://octoverse.github.com/) + +### Ref3 + +[https://about.gitlab.com/customers/iron-mountain/] +(https://about.gitlab.com/customers/iron-mountain/) + +### Ref4 [GitHub -TrustRadius](https://www.trustradius.com/products/github/reviews?qs=pros-and-cons#reviews) +TrustRadius] +(https://www.trustradius.com/products/github/reviews?qs=pros-and-cons#reviews) diff --git a/adr/008-naming-convention.md b/adr/008-naming-convention.md index 7316ea7..6db12ff 100644 --- a/adr/008-naming-convention.md +++ b/adr/008-naming-convention.md @@ -29,8 +29,8 @@ researchers, developers. - **Convention**: Use lowercase and separate words with dashes. - **Example**: `my-repo-name` - **Reference**: - - [Tilburg. Best Practices for Naming Git Branches.](#ref-tilburg) - - [Branching. Digitaljhelms.](#ref-digitaljhelms) + - [Tilburg. Best Practices for Naming Git Branches.](#tilburg) + - [Branching. Digitaljhelms.](#digitaljhelms) ### Files @@ -62,8 +62,8 @@ researchers, developers. - **Convention**: End with `-rg` followed by the name in lowercase, separating words with dashes. `-rg` stand for `resource group`. - **Example**: `resource-group-rg` **Reference**: - - [Microsoft. Azure Naming Best Practices](#ref-microsoft-1) - - [Microsoft. Azure Resource Abbreviations](#ref-microsoft-2) + - [Microsoft. Azure Naming Best Practices](#microsoft-1) + - [Microsoft. Azure Resource Abbreviations](#microsoft-2) ### Azure resources @@ -100,12 +100,12 @@ researchers, developers. effectively. For more information, you can check the ADR-006 about How we manage changes in databases. - **Reference**: - - [Semver.org, Semantic Versioning 2.0.0](#ref-semver) - - [Pypi.org, semver](#ref-pypi) - - [CFIA, ADR-006](#ref-adr-006) - - [Ovid. Database Naming Standards](#ref-ovid) - - [Rootsoft. Database Naming Convention](#ref-rootsoft) - - [Vertabelo. Worst Database Naming Conventions](#ref-vertabelo) + - [Semver.org, Semantic Versioning 2.0.0](#semver) + - [Pypi.org, semver](#rpypi) + - [CFIA, ADR-006](#adr-006) + - [Ovid. Database Naming Standards](#ovid) + - [Rootsoft. Database Naming Convention](#rootsoft) + - [Vertabelo. Worst Database Naming Conventions](#vertabelo) ### Database Table, Column and View @@ -182,32 +182,59 @@ understand and work with the various components and resources. It promotes consistency and clarity in communication and documentation. ## References -* How we manage changes in databases. (2023, November 6). CFIA AI-Lab. - [github.com/ai-cfia/dev-rel-docs/](https://github.com/ai-cfia/dev-rel-docs/blob/main/adr/006-database-change-management.md) -* Database Naming Standards. (2022, March 21). Ovid. - [https://dev.to/ovid/database-naming-standards](https://dev.to/ovid/database-naming-standards-2061) -* Database Naming Convention. (2017, June 15). RootSoft. - [https://github.com/RootSoft/Database-Naming-Convention](https://github.com/RootSoft/Database-Naming-Convention) -* Worst Database Naming Conventions. (2021, August 31). Vertabelo - [https://vertabelo.com/blog/database-naming-convention](https://vertabelo.com/blog/database-naming-convention) -* Best Practices for Naming Git Branches. (n.d.). Tilburg Science Hub. - [https://tilburgsciencehub.com/](https://tilburgsciencehub.com/topics/automation/version-control/advanced-git/naming-git-branches/) -* Branching. (n.d.). Digitaljhelms. - [https://gist.github.com/digitaljhelms/4287848](https://gist.github.com/digitaljhelms/4287848) -* Azure Naming Best Practices. (2023, March, 26). Microsoft. - [https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming) -* Azure Resource Abbreviations. (2023, April 17). Microsoft. - [https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations) -* Semantic Versioning 2.0.0 (n.d.). Semver.org. - [https://semver.org/](https://semver.org/) -* Semver 3.0.2 (2023, October 9). Pypi.org. - [https://pypi.org/project/semver/](https://pypi.org/project/semver/) + +### Adr 006 + +How we manage changes in databases. (2023, November 6). CFIA AI-Lab. +[github.com/ai-cfia/dev-rel-docs/](https://github.com/ai-cfia/dev-rel-docs/blob/main/adr/006-database-change-management.md) + +### Ovid + +Database Naming Standards. (2022, March 21). Ovid. +[https://dev.to/ovid/database-naming-standards] +(https://dev.to/ovid/database-naming-standards-2061) + +### Rootsoft + +Database Naming Convention. (2017, June 15). RootSoft. +[https://github.com/RootSoft/Database-Naming-Convention] +(https://github.com/RootSoft/Database-Naming-Convention) + +### Vertabelo + +Worst Database Naming Conventions. (2021, August 31). Vertabelo +[https://vertabelo.com/blog/database-naming-convention] +(https://vertabelo.com/blog/database-naming-convention) + +### Tilburg + +Best Practices for Naming Git Branches. (n.d.). Tilburg Science Hub. +[https://tilburgsciencehub.com/] +(https://tilburgsciencehub.com/topics/automation/version-control/advanced-git/naming-git-branches/) + +### Digitaljhelms + +Branching. (n.d.). Digitaljhelms. +[https://gist.github.com/digitaljhelms/4287848] +(https://gist.github.com/digitaljhelms/4287848) + +### Microsoft-1 + +Azure Naming Best Practices. (2023, March, 26). Microsoft. +[https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/readyazure-best-practices/resource-naming) + +### Microsoft-2 + +Azure Resource Abbreviations. (2023, April 17). Microsoft. +[https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations] +(https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/readyazure-best-practices/resource-abbreviations) + +### Semver + +Semantic Versioning 2.0.0 (n.d.). Semver.org. +[https://semver.org/](https://semver.org/) + +### Pypi + +Semver 3.0.2 (2023, October 9). Pypi.org. +[https://pypi.org/project/semver/](https://pypi.org/project/semver/)