Skip to content

Commit 247a999

Browse files
authored
Merge branch '6.0' into create-an-emergency-user
2 parents b9157e3 + 0642955 commit 247a999

File tree

5 files changed

+36
-13
lines changed

5 files changed

+36
-13
lines changed

docs/_static/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"[markdown]": {
3+
"editor.formatOnSave": false
4+
}
5+
}

docs/contributing/documentation/authors.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -337,16 +337,34 @@ We follow [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/styl
337337
Key concepts from that guide include the following.
338338

339339
- Documentation should be informational, but friendly.
340-
- Address the reader by using "you" instead of "the user", or by using the collective "we" and "our".
340+
- Address the reader by using "you" and "your" instead of "the user" or "the user's".
341+
- When giving instructions, use the [imperative](https://learn.microsoft.com/en-us/style-guide/grammar/verbs#mood-of-verbs).
342+
- Use the [active voice](https://learn.microsoft.com/en-us/style-guide/grammar/verbs#active-and-passive-voice) whenever possible, avoiding the passive voice.
341343
- Headings should be "Sentence cased", not "Title Cased".
342344

343345
The Plone Documentation Team adopted additional guidelines.
344346

345347
- Use one sentence per line.
346348
Keep sentences short and understandable.
347-
This will greatly improve the editing and maintenance of your documentation.
348-
- Do not follow the PEP8 maximum line length standard.
349-
Documentation is narrative text and images, not Python code.
349+
350+
Never break a single sentence across multiple lines.
351+
Documentation is narrative text and images, not code.
352+
Do not follow the PEP8 maximum line length standard.
353+
Similarly, never use English semantic line breaks.
354+
English semantic rules are difficult to understand and enforce.
355+
356+
Not following this guidance makes pull request reviews needlessly difficult, often resulting in noisy diffs.
357+
358+
The reviewer can't give targeted feedback for a single sentence when there are multiple sentences on one line.
359+
360+
When a single sentence is broken across multiple lines, the reviewer may not know that they can submit [one suggestion for multiple lines](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request).
361+
Instead, they either make a comment or a single suggestion leaving the author to manually edit the lines.
362+
This in turn deprives you of the easy option to commit the suggestion to the pull request by a single click of a button in the GitHub user interface.
363+
364+
Following this guidance will greatly improve the editing and maintenance of your documentation.
365+
366+
- Have the file [`.vscode/settings.json`](/_static/settings.json) in the root of your project to prevent VSCode from reformatting files with the `.md` extension.
367+
350368
- Use dashes `-` in filenames and avoid underscores.
351369
- Images should be no wider than 740 pixels to fit within the documentation's main view port.
352370
This avoids scaling and reducing legibility of images.
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
myst:
33
html_meta:
4-
"description": "Standardize project configuration in Plone with plone/meta"
5-
"property=og:description": "Standardize project configuration in Plone with plone/meta"
6-
"property=og:title": "Standardize project configuration in Plone with plone/meta"
7-
"keywords": "Plone 6, standardize, project, configuration, development, plone/meta"
4+
"description": "Standardize project configuration in Plone with plone.meta"
5+
"property=og:description": "Standardize project configuration in Plone with plone.meta"
6+
"property=og:title": "Standardize project configuration in Plone with plone.meta"
7+
"keywords": "Plone 6, standardize, project, configuration, development, plone.meta"
88
---
99

1010
# Standardize Python project configuration
@@ -19,10 +19,10 @@ It does not cover the following.
1919

2020
Plone consists of hundreds of projects.
2121
To lessen the effort of configuring a new project in the Plone GitHub organization, and to keep these projects current with latest configuration practices, the Plone community agreed upon a trusted set of configuration items.
22-
The Plone community manages these configuration items using the [`plone/meta`](https://github.com/plone/meta) project.
22+
The Plone community manages these configuration items using the [`plone.meta`](https://github.com/plone/meta) project.
2323

24-
You can follow these practices in your own projects, or suggest new or alternative configuration items through the `plone/meta` repository, sharing them with the rest of the Plone community.
24+
You can follow these practices in your own projects, or suggest new or alternative configuration items through the `plone.meta` repository, sharing them with the rest of the Plone community.
2525

2626
```{seealso}
2727
See also [`plone/meta` documentation](https://github.com/plone/meta?tab=readme-ov-file#setup) for setup and usage.
28-
```
28+
```

0 commit comments

Comments
 (0)