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/contributing/documentation/authors.md
+38-6Lines changed: 38 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,15 +53,12 @@ Open `/_build/html/index.html` in a web browser.
53
53
54
54
### American English spelling, grammar, and syntax, and style guide
55
55
56
-
Spellings are enforced through [`Vale`](https://vale.sh/).
56
+
[Vale](https://vale.sh/) is a linter for narrative text.
57
+
It checks spelling, English grammar, and style guides.
57
58
Plone uses American English.
58
59
59
-
Spelling is configured in {file}`Makefile`, {file}`.vale.ini`, and in files in `styles/Vocab/Plone/`.
60
-
61
-
Authors should add new words and proper names using correct casing to {file}`styles/Vocab/Plone/accept.txt`, sorted alphabetically and case-insensitive.
62
-
63
60
Vale also provides English grammar and syntax checking, as well as a Style Guide.
64
-
We follow the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
61
+
The Plone Documentation Team selected the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) for its ease of use—especially for non-native English readers and writers—and attention to non-technical audiences.
65
62
66
63
To perform all these checks, run the following command.
67
64
@@ -74,6 +71,41 @@ We also understand that contributors might not be fluent in English.
74
71
We encourage contributors to make a reasonable effort, and to request a review of their pull request from community members who are fluent in English to fix grammar and syntax.
75
72
Please ask!
76
73
74
+
```{note}
75
+
More corrections to spellings and Vale's configuration are welcome by submitting a pull request.
76
+
This is an easy way to become a contributor to Plone.
77
+
See {ref}`authors-advanced-vale-usage-label` for details.
78
+
```
79
+
80
+
81
+
(authors-advanced-vale-usage-label)=
82
+
83
+
#### Advanced Vale usage
84
+
85
+
To have Vale check only a specific file or directory of files, you can issue [Vale commands](https://vale.sh/manual/) with options in a shell session.
86
+
To allow this, you must either:
87
+
88
+
- activate your Python virtual environment
89
+
- use the virtual environment path, such as `bin/vale`
90
+
- install Vale using operating system's package manager
91
+
92
+
The Vale `Makefile` command automatically installs Vale into your Python virtual environment—which is also created via any documentation `Makefile` commands—when you invoke it for the first time.
93
+
94
+
Vale has [integrations](https://vale.sh/docs/integrations/guide/) with various IDEs.
95
+
Integration might require installing Vale using operating system's package manager.
This file allows overriding rules or changing their severity.
105
+
- {file}`Makefile` passes options to the `vale` command, such as the files Vale checks.
106
+
- Plone documentation uses a custom spelling dictionary, with accepted and rejected spellings in `styles/Vocab/Plone`.
107
+
Authors should add new words and proper names using correct casing to {file}`styles/Vocab/Plone/accept.txt`, sorted alphabetically and case-insensitive.
Plone documentation uses a file located at the root of the repository, `.vale.ini`, to configure Vale.
50
-
This file allows overriding rules or changing their severity.
51
-
52
-
The Plone Documentation Team selected the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) for its ease of use—especially for non-native English readers and writers—and attention to non-technical audiences.
53
-
54
-
```{note}
55
-
More corrections to spellings and Vale's configuration are welcome by submitting a pull request.
56
-
This is an easy way to become a contributor to Plone.
0 commit comments