You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/spell-and-style-checking.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Note that we have only started using vale recently (May 2023), and have only use
8
8
9
9
Further note that we are not sure yet which documentation is best to keep here versus keeping it centrally in the [isc-styles][]. So we might consolidate this documentation at a later point.
10
10
11
-
## How to check **Learning Path** content using vale (locally)
11
+
## Running the checks for the Learning Path content locally
12
12
13
13
To run the vale checks locally, you need to install:
14
14
@@ -25,7 +25,7 @@ Then run vale on the files that you want to check, e.g.:
25
25
26
26
This will run the checks on all markdown and asciidoc files below the `/project-leader` folder.
27
27
28
-
Any issues found will be shown in the terminal and would look like this:
28
+
Any issues found will be shown in the terminal like this:
29
29
30
30
```bash
31
31
project-leader/outline.md
@@ -37,22 +37,24 @@ Any issues found will be shown in the terminal and would look like this:
37
37
'consollidating'?
38
38
```
39
39
40
-
## How to check new Learning Path content coming in via Pull Requests
40
+
## Checking new Learning Path content coming in via Pull Requests
41
41
42
42
This happens automatically, using GitHub Actions and this workflow [vale.yml](.github/workflows/vale.yml).
43
43
44
44
Output looks like this:
45
45
46
46

47
47
48
-
You should only have to adapt that workflow when adding entirely new sections to the Learning Path.
48
+
Note that this highlighting will only be done for any issues found in lines that were changed in the given Pull Request. The idea here is that a contributor should only have to review style issues in the content that they have added themselves.
49
+
50
+
You should only have to adapt the GitHub Actions workflow in [vale.yml](.github/workflows/vale.yml) when adding entirely new sections to the Learning Path.
49
51
50
52
## How to add exceptions to the spell checker?
51
53
52
54
There may be times where the Learning Path wants to use spelling differently from what is defined in [isc-styles][]. (Note that we hope that this will be the exception, as otherwise it won't make sense to maintain the styles centrally).
53
55
54
56
To do so, add the exceptions that you want to make to [accept.txt](.github/vale/Vocab/Base/accept.txt) or [reject.txt](.github/vale/Vocab/Base/reject.txt)
55
57
56
-
TBD - I think this needs to be described in more detail
58
+
TBD - I think this needs to be described in more detail. Especially when to add exceptions locally, and when to add them to the isc-styles repo.
0 commit comments