issue #97: grammatical errors

Technology-and-the-government-of-Canada/Generative-AI-Guidance.md

@@ -23,8 +23,8 @@ that can:
   generative AI. Issues range from biased or inaccurate outputs to breaches of
   privacy and security protocols.
 * Vigilance against potential misuse by threat actors is necessary to safeguard
-  institutional integrity, with adherence to the Canadian Centre for Cyber
-  Security’s guidelines.
+  institutional integrity, with adherence to the Canadian Center for
+  Cybersecurity’s guidelines.
 * Generative AI must be used in compliance with strict privacy, security,
   intellectual property, and human rights regulations.
 * Overreliance on AI can impede critical human judgment and skills, alongside

Tooling/Apps/GitHub/GitHub-Copilot.md

@@ -2,7 +2,7 @@
 
 ## Full-time employees - Requesting GitHub Copilot Access
 
-Send an email to <[email protected]> to get a license.
+Email <[email protected]> to get a license.
 
 ## Interns - Requesting GitHub Copilot Access
 
@@ -18,7 +18,7 @@ have it. Get student benefits as Individuals.
 ![alt text](images/developer.png)
 ![alt text](images/individuals.png)
 1. Fill out the request form with the required information. Make sure to use
-your student email address and have a valid document or a picture of you student
+your student email address and have a valid document or a picture of your student
 card to send in the verification section.
 ![alt text](images/proof.png)
 
@@ -33,7 +33,7 @@ card to send in the verification section.
 Once you get the confirmation that your request has been approved, follow these
 steps :
 
-1. Open VS Code on your computer or a codespace in GitHub.
+1. Open VS Code on your computer or a Codespace in GitHub.
 
 1. Go to the "Extensions". Shortcut is `Ctrl+Shift+X`.
 
@@ -55,7 +55,7 @@ generate code suggestions as you type. Use suggestions by pressing `Tab` to
 accept them. If a suggestion is not accurate, you can modify it before
 accepting.
 
-There is also a chat section that is similar to chatGPT.
+There is also a chat section that is similar to ChatGPT.
 
 ![alt text](images/chat.png)
 

Tooling/Apps/GitHub/GitHub.md

@@ -1,25 +1,25 @@
-# Github
+# GitHub
 
 ## Executive summary
 
-AI Lab is adopting an OpenSource, OpenData, OpenModel approach and Github is the
+AI Lab is adopting an Open Source, Open Data, Open Model approach and GitHub is the
 best platform to create collaboration with our internal and external partners to
 develop new products that have wide applicability and are deployable
 cross-cloud.
 
 These applications are developed and tested with publically available data (such
 as the information published on our public website).
 
-AI Lab Github repositories are all public and licensed under the MIT licenses.
+AI Lab GitHub repositories are all public and licensed under the MIT licenses.
 
-Github provides generous free resources for opensource projects, allowing us to
-stick to their [Github free for organizations
+GitHub provides generous free resources for open source projects, allowing us to
+stick to their [GitHub free for organizations
 plan](https://docs.github.com/en/get-started/learning-about-github/githubs-plans#github-free-for-organizations)
 
-- including 3,000 GitHub Actions minutes per month of Continuous Integration /
+- Including 3,000 GitHub Actions minutes per month of Continuous Integration /
 Continuous Deployment resources.
 
-## Why Github?
+## Why GitHub?
 
 - [ADR-004: Open Source
   Development](https://github.com/ai-cfia/dev-rel-docs/blob/main/adr/004-open-source-development.md)
@@ -30,27 +30,27 @@ Continuous Deployment resources.
 
 - [Automated code security and
   analysis](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security)
-  - One of the highest risk is pulling in a compromised external library into
+  - One of the highest risks is pulling in a compromised external library into
     our infrastructure
-  - This is not exclusive risk to Github; it's quite possible that a dependency
+  - This is not exclusive risk to GitHub; it's quite possible that a dependency
     installed in an app internally could pull in a compromised external
     dependency
-  - Github code scanning also integrates with [Azure DevOps
+  - GitHub code scanning also integrates with [Azure DevOps
     itself](https://learn.microsoft.com/en-us/azure/devops/repos/security/configure-github-advanced-security-features?view=azure-devops&tabs=yaml)
-- [Github Actions](https://docs.github.com/en/actions): rich library of
+- [GitHub Actions](https://docs.github.com/en/actions): rich library of
   automated workflows, including AI bot reviews.
-  - [Our Github workflows](https://github.com/ai-cfia/github-workflows/)
+  - [Our GitHub workflows](https://github.com/ai-cfia/github-workflows/)
   - Already deploying to Google GCP (free credits), preparing to deploy to a
     free credits account on Azure
-- [Github Codespaces](https://docs.github.com/en/codespaces/overview):
+- [GitHub Codespaces](https://docs.github.com/en/codespaces/overview):
   development in a web browser in the cloud using the same Visual Studio Code
   environment we find on the desktop.
   - This allows our collaborators (most of whom are interns) to quick ramp up
     start developing, reducing the time to contribute from days to hours.
-- [Github Copilot](https://github.com/features/copilot): AI-supported code
+- [GitHub Copilot](https://github.com/features/copilot): AI-supported code
   writing improving developer productivity 10x to 100x
 
-## Github and Security
+## GitHub and Security
 
 - Multifactor authentication is required for all organization members
 - Dependabot (dependency scanning and repos) has been enabled on all repos
@@ -87,7 +87,7 @@ Continuous Deployment resources.
 
 Steps:
 
-- Our ongoing opensource products are being deployed to GCP
+- Our ongoing open source products are being deployed to GCP
 - Deploy to Azure free account
 - Deploy to our Azure Sandbox (through artifact registry)
 - Deploy to Azure
@@ -101,4 +101,4 @@ Steps:
 
 1. Billing
 
-1. Deployment from Github to our Sandbox (and Artifacts registry)
+1. Deployment from GitHub to our Sandbox (and Artifacts registry)

Tooling/Apps/GitHub/Github-Codespaces.md

@@ -1,17 +1,17 @@
-# Github Codespaces
+# GitHub Codespaces
 
 ## What is Codespaces
 
-Github Codespaces is a cloud-based development environment that uses a container
+GitHub Codespaces is a cloud-based development environment that uses a container
 to provide you with common languages, tools, and utilities for development. You
-can add plugins and extensions within a codespace to personalize your experience
+can add plugins and extensions within a Codespace to personalize your experience
 in Visual Studio Code (VSC).
 
-When you want to use a codespace, go on the branch you want to open :
+When you want to use a Codespace, go on the branch you want to open :
 
 ![alt text](images/ai-lab.png)
 
-Then, click on code and open a new codespace if it's the first time you open the
+Then, click on code and open a new Codespace if it's the first time you open the
 branch or open the already existing one if you already worked on it before !
 
 ![alt text](images/branch.png)
@@ -25,33 +25,33 @@ locally, we open up on the cloud.
 
 ### Less security risks
 
-Because no software is installed locally and every code base is containerized by
+Because no software is installed locally, and every code base is containerized by
 default, this creates a faster.
 
 ### Limitations from local network
 
-Note that firewall at work blocks outgoing port 5432 (Postgresql). A ticket is
+Note that firewall at work blocks outgoing port 5432 (PostgreSQL). A ticket is
 opened with security to unblock the port to our sandbox and also provide
 instructions to connect through VPN for our dev and prod environment.
 
-For now, the workaround is to connect through GitHub codespaces which is outside
+For now, the workaround is to connect through GitHub Codespaces which is outside
 our firewall, so the connection works.
 
-To learn more about codespaces, you can read up on the [Github documentation on
+To learn more about Codespaces, you can read up on the [GitHub documentation on
 Codespaces](https://github.com/features/codespaces)
 
 ## Secrets management
 
 To connect to external services such as the database, you need passwords and API
 keys. Typically, locally we'd create an ```.env``` environment but in
-Codespaces, you need to use secrets. You can refer to the [Github documentation
+Codespaces, you need to use secrets. You can refer to the [GitHub documentation
 on
 secrets](https://docs.github.com/en/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces#adding-a-secret)
 
 This procedure is exactly how to do it, you can read the rest of the page if you
 want to know more.
 
-To know which values you are supposed to put inside of these secrets, you need
+To know which values you are supposed to put inside these secrets, you need
 to go on [Azure portal](https://portal.azure.com/#home) and go to "all
 resources" then find "ailabpostgres" and click on it.
 

Tooling/Apps/GitHub/Managing-GitHub-Projects.md

@@ -23,8 +23,8 @@ A project should include all related issues from connected repositories.
 Ideally, it should not track PRs.
 
 - The default view should be a table sorted by priority, showing issues marked
-  as 'Todo' or 'In Progress' (filter: `status:Todo,"In Progress"` ). It should
-  show relevant issues that give an good idea of project's status.
+  as 'Todo' or 'In Progress' (filter: `status:Todo,"In Progress"`). It should
+  show relevant issues that give a good idea of project's status.
 - A second table view serves as our backlog, filtering out tasks marked as
   'Todo', 'In Progress', or 'Done' (filter: `-status:Todo,"In Progress",Done`).
 - We also maintain at least one board view for status tracking and a Roadmap

Tooling/Apps/SQL/PostgreSQL-Command-Line.md

@@ -26,8 +26,8 @@ PGOPTIONS=--search_path=schema_name psql -U username -d database_name -a -f 2023
 ```
 
 This command sets the search path to a specific schema and executes an SQL file.
-Replace `schema_name` with the name of your schema, `username` with your user
-name, `database_name` with the name of your database, and replace
+Replace `schema_name` with the name of your schema, `username` with your
+username, `database_name` with the name of your database, and replace
 `2023-11-28-create-histogram.sql` with your SQL file name.
 
 ### Execute SQL file and output to CSV
@@ -40,7 +40,7 @@ psql -U username -d database_name \
 ```
 
 This command executes an SQL file and outputs the result to a CSV file. Replace
-`username` with your user name, `database_name` with the name of your database,
+`username` with your username, `database_name` with the name of your database,
 `2023-11-30-select-chunk-score.sql` with your SQL file name, and `result.html`
 with the name of the output file.
 

Tooling/Apps/Visual-Studio-Code/Installation.md

@@ -22,8 +22,6 @@
 
 ## VS Code Settings
 
-see
-
 If you're working on an existing project, its [Dev
 Container](https://containers.dev/) should already have configured within the
 rest of the necessary extensions. Look inside the `devcontainer.json` file in

Tooling/Apps/Visual-Studio-Code/Troubleshooting.md

@@ -34,10 +34,13 @@ Once the downloads are complete, run the following command: `code .`
 This will open up new VS code window
 
 Then find Command Palette (or Ctrl+Shift+p)
+
 ![alt text](images/command.png)
 
 Then find this is the search bar
+
 ![alt text](images/bar.png)
 
 Finally confirm this is shown in the bottom left corner of VS code
+
 ![alt text](images/dev.png)

Tooling/Apps/Visual-Studio-Code/Unit-Tests.md

@@ -3,9 +3,9 @@
 ## Why Write Unit Tests?
 
 - **Ensure Code Quality:** Unit tests help maintain code quality by verifying
-  that each units of code function correctly.
+  that each unit of code function correctly.
 
-- **Detect Bugs Early:** Writing tests allows to catch and fix bugs early in the
+- **Detect Bugs Early:** Writing tests allows catching and fixing bugs early in the
   development process, reducing issues in the future.
 
 - **Facilitate Refactoring:** When changes are made to code, unit tests act as a
@@ -32,13 +32,14 @@ resolution of issues specific to each functionality.
 
 To get started on testing your project in Visual Studio Code, click on the
 following icon on the left:
+
 ![alt text](images/icon.png)
 
 Then, click on "Configure Python Tests", select unittest and the test folder of
 your project. It is usually named "tests".
 
 ![alt text](images/testing.png)
 
-If your tests require to connect to a database or an api, you should include the
+If your tests require connecting to a database or an API, you should include the
 `SetUp(self)` and `TearDown(self)` functions as they will be called before and
 after each test.

Tooling/Core-concepts/Environment-variables.md

@@ -12,7 +12,7 @@ between development, testing, and production environments.
 ## Accessing and Setting Environment Variables
 
 * **In Code**: Programming languages provide mechanisms to access environment
-variables. For example, in Python, the os module is commonly used:
+variables. For example, in Python, the OS module is commonly used:
 
 ```python
 import os

Tooling/Diagrams/Mermaid-Diagrams.md

@@ -13,7 +13,7 @@ development." (Mermaid Doc, 2024)
 In short, mermaid help developer create diagram to document their work. Mermaid
 is also integrated into Azure DevOps and GitHub. Using Mermaid can help
 developer to document their issues easily without having to create a diagram on
-another platform first. Mermaid support a wide variety of diagram such as:
+another platform first. Mermaid supports a wide variety of diagram such as:
 
 * sequence diagram
 * flowchart
@@ -23,7 +23,7 @@ another platform first. Mermaid support a wide variety of diagram such as:
 
 ## How to use Mermaid
 
-In VS code (or codespace) you will need to install these extensions:
+In VS Code (or Codespace) you will need to install these extensions:
 
 * Mermaid Preview
 * Markdown Preview Mermaid Support
@@ -64,17 +64,17 @@ From top to bottom
      graph TD;
      A[Top]-->B[Down]
 :::
-Even if display is similar, GitHub support another syntaxe.
+Even if display is similar, GitHub support another syntax.
 
 ```markdwon
   mermaid
     Flowchart TD;
     Top --> Down
 ```
 
-_the mermaid code need to be encapsulate in _**```**_ cotation._
+_The mermaid code need to be encapsulated in _**```**_ citation._
 
-### sequence diagram
+### Sequence diagram
 
 ```markdown
    :::mermaid
@@ -92,7 +92,7 @@ _the mermaid code need to be encapsulate in _**```**_ cotation._
          Christie->>Josh: See you later!
 :::
 
-Again this syntaxe will result in a similar display on GitHub :
+Again this syntax will result in a similar display on GitHub :
 
 ```markdwon
 mermaid
@@ -102,6 +102,6 @@ mermaid
         Alice-)John: See you later!
 ```
 
-the mermaid code need to be encapsulate in _**```**_ cotation.
+The mermaid code need to be encapsulated in _**```**_ citation.
 
 For more features on mermaid, visit the doc. [:point_up:](#mermaid-diagrams)

Tooling/Why-OpenSource-development.md → Tooling/Why-Open-Source-development.md

@@ -1,4 +1,4 @@
-# Why OpenSource development at the CFIA AI Lab
+# Why Open Source development at the CFIA AI Lab
 
 ## Summary
 
@@ -70,9 +70,9 @@ development while mitigating any potential risks.
 
 ## Specifics to our situation
 
-### Dependency to OpenSource
+### Dependency to Open Source
 
-We already depend heavily on opensource tools with open development and
+We already depend heavily on open source tools with open development and
 user-contributed work, whether it is [Visual Studio
 Code](https://github.com/microsoft/vscode), [Bicep configuration
 files](https://github.com/Azure/bicep), [Jupyter
@@ -82,8 +82,8 @@ notebooks](https://github.com/jupyter),
 
 ### Tooling
 
-Github, the OpenSource platform of choice, is owned by Microsoft, our technology
-partner and is the premier platform for opensource development.
+GitHub, the Open Source platform of choice, is owned by Microsoft, our technology
+partner and is the premier platform for open source development.
 
 ### Alpha deployment: [alpha.canada.ca](https://alpha.canada.ca/en/index.html)
 
@@ -95,8 +95,8 @@ experiments in one place, to make it easier for the government to collaborate
 and share its experiments. They are publicly available in the spirit of working
 in the open.
 
-To be deployed on alpha.canada.ca, a web application or service needs to meet
-the following criteria:
+To be deployed on [alpha.canada.ca](https://alpha.canada.ca/en/index.html), a
+web application or service needs to meet the following criteria:
 
 * hosted on public cloud infrastructure
 * open source on a publicly-visible repository
@@ -110,9 +110,9 @@ the following criteria:
 Standards](https://www.canada.ca/en/government/system/digital-government/government-canada-digital-standards.html)
 require us to do development in the open.
 
-* "Share evidence, research and decision making openly. Make all non-sensitive
+* "Share evidence, research and decision-making openly. Make all non-sensitive
   data, information, and new code developed in delivery of services open to the
-  outside world for sharing and reuse under an open licence."
+  outside world for sharing and reuse under an open license."
 * "Collaborating widely allows us to learn lessons from others to minimize
   mistakes and reduce rework by identifying and sharing existing solutions. The
   problems that government solves are often unique, though they are not unique