Skip to content

Commit 400e4e6

Browse files
committed
docs: fix english typos
Signed-off-by: Ethan Perruzza <[email protected]>
1 parent 07465ea commit 400e4e6

File tree

21 files changed

+79
-79
lines changed

21 files changed

+79
-79
lines changed

content/about/opensource.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In practice, open source is both a **legal framework** for collaborative work, a
1717

1818
## OSRD and Open Source
1919

20-
Applied to OSRD, Open Source has **multiple avantages** :
20+
Applied to OSRD, Open Source has **multiple advantages** :
2121
- the algorithms and know-how developed with the project are free for all
2222
- development cost and results are shared between actors
2323
- it makes interoperability between software systems easier by helping make the landscape more homogeneous and standardized

content/about/use-case/_index.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ OSRD is meant to fulfill a range of use-cases related to railway planning:
1414
- [short term capacity management](#short-term-capacity-management)
1515

1616

17-
![produits OSRD](osrd_product.en.png)
17+
![OSRD product](osrd_product.en.png)
1818

1919

2020
## Timetabling

content/blog/news/2023/opendata-fosdem.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Learn more about [Inspire data model](https://inspire.ec.europa.eu/file/1723/dow
4848
- Calculate a new field using the following formula to get the length of each track in kilometers:
4949

5050
"length" = $length / 1000
51-
- Select electrified parts of the network using the "other_tages" field:
51+
- Select electrified parts of the network using the "other_tags" field:
5252

5353
"other_tags" like '%"electrified"=>"yes"%'
5454
or "other_tags" like '%"electrified"=>"contact_line"%'

content/docs/explanation/running_time_calculation/allowances.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ weight: 50
1010

1111
</font>
1212

13-
As explained in the [calcul du Max Effort Profile](../pipeline/#calculation-of-the-max-effort-profile), the **basic running time** represents the most stretched run normally achievable, i.e. the fastest possible run of the given equipment on the given route. The train accelerates to the maximum, travels as fast as possible according to the different speed limits and driving capabilities, and brakes to the maximum.
13+
As explained in the [calculation of the Max Effort Profile](../pipeline/#calculation-of-the-max-effort-profile), the **basic running time** represents the most stretched run normally achievable, i.e. the fastest possible run of the given equipment on the given route. The train accelerates to the maximum, travels as fast as possible according to the different speed limits and driving capabilities, and brakes to the maximum.
1414

1515
This basic run has a major disadvantage: if a train leaves 10 minutes late, it will arrive at best 10 minutes late, because by definition it is impossible for it to run faster than the basic run. Therefore, trains are scheduled with one or more allowances added. The allowances are a relaxation of the train's route, an addition of time to the scheduled timetable, which inevitably results in a lowering of running speeds.
1616

content/docs/guides/contribute/contribute-code/commit-conventions.en.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Ideally:
2727
- the title should be self-explanatory: no need to read anything else to understand it
2828
- the commit title is all lower-case
2929
- the title is clear to a reader not familiar with the code
30-
- the body of the commit contains a detailled description of the change
30+
- the body of the commit contains a detailed description of the change
3131

3232
{{% alert title="" color="info"%}}
33-
An automated check is performed to enforce as much as possible this formating.
33+
An automated check is performed to enforce as much as possible this formatting.
3434
{{% /alert %}}
3535

3636
### Counter-examples of commit titles
@@ -74,6 +74,6 @@ Now, go in `Files` -> `Preferences` -> `Settings`, search for and activate
7474
the **Always Sign Off** setting.
7575

7676
Finally, when you'll commit your changes via the VS Code interface, your commits
77-
will automaticaly be signed-off.
77+
will automatically be signed-off.
7878

7979
*[Continue towards sharing your changes ‣]({{< ref "share-changes">}})*

content/docs/guides/contribute/contribute-code/frontend-conventions.en.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Last but not least, a **common** directory offering :
4141

4242
_In progress_
4343

44-
`projects/{nom du projet}/studies/{nom de l'étude}/scenarios/{nom du scenario}`
44+
`projects/{project's name}/studies/{study's name}/scenarios/{scenario's name}`
4545

4646
### Styles & SCSS
4747

@@ -150,7 +150,7 @@ In the store, you will see the `editoastApi` key containing the cached data of a
150150

151151
Here for example, the `getProjects` endpoint is called.
152152

153-
RTK stores the endpoint's name, as well as the call's parameters, to form an unique key `nomDuEndpoint({ paramètres })`. (here `getProjects({"ordering":"LastModifiedDesc","pageSize":1000})`).
153+
RTK stores the endpoint's name, as well as the call's parameters, to form an unique key `nomDuEndpoint({ parameter })`. (here `getProjects({"ordering":"LastModifiedDesc","pageSize":1000})`).
154154

155155
```js
156156
{
@@ -164,7 +164,7 @@ RTK stores the endpoint's name, as well as the call's parameters, to form an uni
164164
}
165165
```
166166

167-
In this second example, the same endpoint has been called with the ssame `projectId` parameter, but a different `studyId` parameter.
167+
In this second example, the same endpoint has been called with the same `projectId` parameter, but a different `studyId` parameter.
168168

169169
##### Serialization of keys in the cache
170170

content/docs/guides/contribute/contribute-code/tests.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Tests"
33
linkTitle: "Tests"
44
weight: 6
5-
description: "Recommandations for testing purpose"
5+
description: "Recommendations for testing purpose"
66
---
77

88
## Back-end

content/docs/guides/contribute/install-docker.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ It uses colima for virtualizing linux.
4949
{{% alert color="info" %}}
5050
If you're using rancher desktop, please either:
5151
- uninstall the application
52-
- select `Manual` in `Preferences` > `Application` > `Environement`
52+
- select `Manual` in `Preferences` > `Application` > `Environnement`
5353
{{% /alert %}}
5454

5555
{{% alert color="info" %}}

content/docs/railway-wiki/signalling/spacing/ertms/etcs.en.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ In order to compute any of these curves, a number of things are needed:
3434
- `T_traction_cutoff`: the time it take to cut off traction
3535
- braking model, either lambda or gamma:
3636
- lambda (braking weight/mass)
37-
- gamma (contant deceleration at a given speed)
37+
- gamma (constant deceleration at a given speed)
3838
- correction factors (k\_dry and k\_wet for gamma braking) for braking curves
3939

4040
### Infrastructure
4141

4242
- corrected gradients (it incorporates curvature)
43-
- odometry balises location
43+
- odometry balise locations
4444

4545
## Processes
4646

@@ -53,7 +53,7 @@ In order to compute any of these curves, a number of things are needed:
5353
### Speed / distance targets
5454

5555
- `EOA` end of movement authority: the location until which the train is allowed to move
56-
- `SvL` supervized location: the protected location
56+
- `SvL` supervised location: the protected location
5757

5858

5959
### Curves
@@ -69,4 +69,4 @@ All the curves below are cut below a given release speed:
6969
- `FLOI` (also called `SBI`, the intervention curve) the minimum of `SBI1` and `SBI2`
7070
- `WARNING` (warning curve) computed as a shift of `FLOI` by `Twarning`
7171
- `PS` (permitted speed curve): shift of `WARNING` by time `Tdriver`
72-
- `INDICATION` is a shift of `PS` by time `Tindication`
72+
- `INDICATION` is a shift of `PS` by time `Tindication`

content/docs/reference/design-docs/auth/_index.en.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and stakeholders. After some interviews, we believe the overall needs to be as f
1616
- some users are supposed to only view results of operational studies
1717
- some users only get access to part of the app
1818
- not everyone can have access to the admin panel
19-
- it could be nice to be able to roll experimental features out incrementaly
19+
- it could be nice to be able to roll experimental features out incrementally
2020
- controlling access to data
2121
- some infrastructures shall only be changed by automated import jobs
2222
- users might want to control who can mess with what they're currently working on
@@ -207,10 +207,10 @@ DELETE /authn/group/{group_id}
207207
## Authorization
208208

209209
As shown in the overall architecture section, to determine if a subject is
210-
allowed to conduct an action on a ressource, two checks are performed:
210+
allowed to conduct an action on a resource, two checks are performed:
211211

212212
1. We check that the **roles** of the subject allows the action.
213-
2. We check that the subject has the **minimum privileges** on the ressource(s) that are required to perform the action.
213+
2. We check that the subject has the **minimum privileges** on the resource(s) that are required to perform the action.
214214

215215
### Roles
216216

@@ -249,7 +249,7 @@ Given these builtin roles, application roles may look like:
249249
Roles are _hierarchical_. This is a necessity to ensure that, for example, if we are to introduce a new action related to scenarios, each subject with the role "exploitation studies" gets that new role automatically.
250250
We'd otherwise need to edit the appropriate existing roles.
251251

252-
Their hierarchy could ressemble:
252+
Their hierarchy could resemble:
253253

254254
```mermaid
255255
%%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
@@ -304,7 +304,7 @@ Permission checks are performed as follows:
304304
enum EffectivePrivLvl {
305305
Owner, // all operations allowed, including granting access and deleting the resource
306306
Writer, // can change the resource
307-
Creator, // can create new subresources
307+
Creator, // can create new sub resources
308308
Reader, // can read the resource
309309
MinimalMetadata, // is indirectly aware that the resource exists
310310
}
@@ -486,7 +486,7 @@ Back-end:
486486
- ensures that role / permission checks were performed. Implement two modules: log on missing check, abort on missing check.
487487
- injects which checks were performed into response headers so it can be tested
488488
- introduce the concept of rolling stock collections to enable easier rolling stock permission checking
489-
- write a migration guide to help OSRD developpers navigate the authorization APIs
489+
- write a migration guide to help OSRD developers navigate the authorization APIs
490490

491491
Front-end:
492492

@@ -563,13 +563,13 @@ We considered two patterns for permission management endpoints:
563563
We found that:
564564

565565
- having separate set of endpoints per resource types brought extra back-end and front-end complexity
566-
- the only constraint of unified permission management endpoints is that all resource types need globaly unique IDs
567-
- the globaly unique ID constraint is less costly than the extra complexity of separate endpoints
566+
- the only constraint of unified permission management endpoints is that all resource types need globally unique IDs
567+
- the globally unique ID constraint is less costly than the extra complexity of separate endpoints
568568

569569
### Dynamically enforce permission checks
570570

571571
Ideally, there would be static checks enforcing permission checks.
572-
However, we found no completly fool proof way to statically do so.
572+
However, we found no completely fool proof way to statically do so.
573573

574574
Instead, we decided that all permission checks will be registered
575575
with a middleware, which will either log or raise an error when a

0 commit comments

Comments
 (0)