Skip to content

Commit

Permalink
issue #85: fixed some markdown linting errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasCardin committed May 1, 2024
1 parent 52ee2e2 commit 9ed04cf
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Design-UX/DESIGN-UX-PHILOSOPHY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Design Philosophy and UX Concept for CFIA Projects

### User-Centric Design
## User-Centric Design

Our frontend development is guided by a user-first approach, ensuring a simple
and intuitive search experience across all CFIA projects. This focus enhances
Expand Down
20 changes: 11 additions & 9 deletions TypeScript-AppVersion/APPVERSION-SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ npm i @saithodev/ts-appversion
Before building the application, you need to run the TS-AppVersion script. This
can be achieved using "prestart" and "prebuild" scripts in your package.json:

**Getting Started**
## Getting Started

package.json:

Expand Down Expand Up @@ -48,14 +48,16 @@ The script (npm i @saithodev/ts-appversion) generates a TypeScript file
various version-related variables extracted from the package.json and Git
repository (if available). These variables include:

version
name
description
versionDate
versionLong
gitTag
gitCommitHash
gitCommitDate
```text
version
name
description
versionDate
versionLong
gitTag
gitCommitHash
gitCommitDate
```

## Environment-Related Versions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Integrating Environment Variables in TypeScript React Project
# Integrating Environment Variables in TypeScript React Project

### Overview

Check failure on line 3 in TypeScript-EnvironmentVariables/ENVIRONMENT-VARIABLES-SETUP.md

View workflow job for this annotation

GitHub Actions / markdown-check / markdown-check

Heading levels should only increment by one level at a time

TypeScript-EnvironmentVariables/ENVIRONMENT-VARIABLES-SETUP.md:3 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md001.md

Expand Down
4 changes: 2 additions & 2 deletions TypeScript-React-Setup-Guide/REACTSETUP.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Creating a TypeScript + SWC React App with Vite, ESLint, and Prettier
# Creating a TypeScript + SWC React App with Vite, ESLint, and Prettier

This guide walks you through the steps to set up a React app using Vite with
TypeScript and SWC, and further enhancing it with ESLint for code linting and
Expand Down Expand Up @@ -79,7 +79,7 @@ TypeScript and modern JavaScript.

## Step 3: In the .eslintrc.cjs file, replace the existing content with the following configuration

```
```javascript
module.exports = {
root: true,
env: { browser: true, es2020: true },
Expand Down
16 changes: 8 additions & 8 deletions postmortems/incident-1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nachet backend classification not working (incident #1)

### Owner
## Owner

Jonathan Lopez (@SonOfLope) and Thomas Cardin (@ThomasCardin)

Expand Down Expand Up @@ -58,7 +58,7 @@ team lead.
2. Classify button following the load button click: Regenerating the API Key of
the Azure AI Model used inside nachet.

### Impact
### Impact by teams

User impact

Expand All @@ -79,7 +79,7 @@ Revenue Impact
- The time of developers and DevSecOps personnel.
- The time of the tech lead.

### Root Causes
### Root Causes (step)

1. To test the classification, it was necessary to upload an image by clicking
on the "load" button. This resulted in a 413 Request Entity Too Large error.
Expand All @@ -101,19 +101,19 @@ maximum upload limite to the nachet backend.

## Action Items

### Nachet backend team (NBT):
### Nachet backend team (NBT)

|Action items|Type|Priority|Owner|Tracking bug|
|--------|-------|-------|-------|-------|
|Instrument the application|mitigate|P0|NBT|[issue 50](#ref50)|

### Nachet frontend team (NFT):
### Nachet frontend team (NFT)

|Action items|Type|Priority|Owner|Tracking bug|
|--------|-------|-------|-------|-------|
|Instrument the application|mitigate|P0|NFT|[issue 88](#ref88)|

### DevSecOps Team (DT):
### DevSecOps Team (DT)

|Action items|Type|Priority|Owner|Tracking bug|
|--------|-------|-------|-------|-------|
Expand Down Expand Up @@ -202,9 +202,9 @@ the model and the one in production.

nachet

- nachet-backend: https://github.com/ai-cfia/nachet-backend
- nachet-backend: <https://github.com/ai-cfia/nachet-backend>

- nachet-frontend: https://github.com/ai-cfia/nachet-frontend
- nachet-frontend: <https://github.com/ai-cfia/nachet-frontend>

## Supporting information

Expand Down

0 comments on commit 9ed04cf

Please sign in to comment.