Skip to content

Commit a0e45d4

Browse files
authored
Check typos on prs (#220)
1 parent 4467243 commit a0e45d4

File tree

7 files changed

+33
-6
lines changed

7 files changed

+33
-6
lines changed

.github/workflows/deploy.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ jobs:
1515
with:
1616
submodules: "true"
1717
lfs: true
18+
19+
- name: Check spelling
20+
uses: crate-ci/typos@master
21+
1822
- uses: julia-actions/setup-julia@latest
1923
with:
2024
version: 1.9.4

.github/workflows/pullrequest.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Release drafter
3+
4+
on:
5+
pull_request:
6+
branches:
7+
- master
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+

_typos.toml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[default.extend-words]
2+
# Don't correct the surname "Teh"
3+
CLOS = "CLOS"
4+
leafs = "leafs"
5+
nd = "nd"
6+
7+
[files]
8+
extend-exclude = ["*.svg", "*.drawio", "allocate.yml"]

docs/src/development/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This section contains language-agnostic topics that all metal-stack projects are
4040

4141
The code base is owned by the entire team and every member is allowed to contribute changes to any of the projects. This is considered as collective code ownership[^1].
4242

43-
As a matter of fact, there are persons in a project, which already have experience with the sources. These are defined directly in the repository's [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file. If you want to merge changes into the master branch, it is advisable to include code owners into the proecess of discussion and merging.
43+
As a matter of fact, there are persons in a project, which already have experience with the sources. These are defined directly in the repository's [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file. If you want to merge changes into the master branch, it is advisable to include code owners into the process of discussion and merging.
4444

4545
### Microservices
4646

docs/src/development/proposals/MEP1/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ In order to replicate certain data which must be available across all partitions
8282
Postgres does not have a multi datacenter with replication in both directions, it just can make the remote instance store the same data.
8383
- CockroachDB
8484

85-
Is a Postgresql compatible database enginge on the wire. CockroachDB gives you both, ACID and geo replication with writes allowed from all connected members. It is even possible to configure [Follow the Workload](https://www.cockroachlabs.com/docs/stable/topology-follow-the-workload) and [Geo Partitioning and Replication](https://www.cockroachlabs.com/docs/v19.2/topology-geo-partitioned-replicas).
85+
Is a Postgresql compatible database engine on the wire. CockroachDB gives you both, ACID and geo replication with writes allowed from all connected members. It is even possible to configure [Follow the Workload](https://www.cockroachlabs.com/docs/stable/topology-follow-the-workload) and [Geo Partitioning and Replication](https://www.cockroachlabs.com/docs/v19.2/topology-geo-partitioned-replicas).
8686

8787
If we migrate all metal-api entities to be stored the same way we store masterdata, we could use cockroachdb to store all metal entities in one ore more databases spread across all partitions and still ensure consistency and high availability.
8888

docs/src/development/proposals/MEP8/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ type Disk struct {
116116
// Raid is optional, if given the devices must match.
117117
// TODO inherit GPTType from underlay device ?
118118
type Raid struct {
119-
// ArryName of the raid device, most often this will be /dev/md0 and so forth
120-
ArryName string
119+
// ArrayName of the raid device, most often this will be /dev/md0 and so forth
120+
ArrayName string
121121
// Devices the devices to form a raid device
122122
Devices []Device
123123
// Level the raidlevel to use, can be one of 0,1,5,10

docs/src/installation/troubleshoot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ If the new switch should have the same ID as the old one you should perform a sw
246246
To find detailed information about the procedure of a switch replacement use `metalctl switch replace --help`.
247247
Basically, what you need to do is mark the switch for replacement via `metalctl switch replace`, then physically replace the switch with the new one and configure it.
248248
The last step is to deploy metal-core on the switch.
249-
Once metal-core registers the new switch at the metal-api, the old switches configuration and machine connections will be transfered to the new one.
249+
Once metal-core registers the new switch at the metal-api, the old switches configuration and machine connections will be transferred to the new one.
250250
Note that the replacement only works if the new switch has the same ID as the old one.
251251
Otherwise metal-core will simply register a new switch and leave the old one untouched.
252252

@@ -268,7 +268,7 @@ The metal-api will think that a machine is connected to three switches.
268268
This, however, should not cause any problems.
269269
Just move on to step 6 and delete the old switch from the metal-api afterwards.
270270
If the case just described really occurs, then `metalctl switch delete <old-switch-id>` will throw an error, because deleting a switch with existing machine connections might be dangerous.
271-
If, apart from that, the migration was successfull, then the old switch can be safely deleted with `metalctl switch delete <old-switch-id> --force`.
271+
If, apart from that, the migration was successful, then the old switch can be safely deleted with `metalctl switch delete <old-switch-id> --force`.
272272

273273
#### Preconditions for Migration and Replacement
274274

0 commit comments

Comments
 (0)