Skip to content

Commit 8f92fa0

Browse files
authored
Merge branch '6.0' into create-an-emergency-user
2 parents c695357 + 8b10d26 commit 8f92fa0

File tree

13 files changed

+40
-21
lines changed

13 files changed

+40
-21
lines changed

.vscode/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/_inc/_continuous-integration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Plone project repositories use {term}`continuous integration` (CI) to run tests, ensure code quality, or provide previews for every contribution.
2+
Plone uses GitHub workflows, Jenkins, Cypress, Read the Docs, and other services for CI.
3+
All of a project's CI jobs must pass before a contribution may be accepted.
4+
5+
```{seealso}
6+
{doc}`/contributing/core/continuous-integration`
7+
```

docs/backend/annotations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Annotations store arbitrary values on Python objects—such as a Plone site or HTTP request—for storage and caching purposes."
5+
"property=og:description": "Annotations store arbitrary values on Python objects—such as a Plone site or HTTP request—for storage and caching purposes."
6+
"property=og:title": "Annotations"
7+
"keywords": "Annotations, plone.memoize, cache, portal, content object"
88
---
99

1010
(backend-annotations-label)=

docs/backend/upgrading/version-specific-migration/upgrade-to-python3.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ myst:
1414

1515
This chapter provides instructions and tips for porting Plone projects to Python 3.
1616

17-
```{seealso}
18-
If you want to upgrade add-ons to Python 3, the list of all Plone packages that still need to be ported can be found on the GitHub project board [Python 3 porting state for Plone add-ons](https://github.com/orgs/collective/projects/1).
19-
```
2017

2118
## Principles
2219

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,21 @@
125125
"**/CONTRIBUTORS.rst",
126126
"**/LICENSE.rst",
127127
"**/README.rst",
128+
"**/eggs",
129+
"_inc/.*",
128130
"plone.restapi/.*",
129131
"plone.restapi/bin",
132+
"plone.restapi/develop-eggs",
130133
"plone.restapi/docs/source/glossary.md", # There can be only one Glossary.
134+
"plone.restapi/eggs",
131135
"plone.restapi/ideas",
132136
"plone.restapi/include",
133137
"plone.restapi/lib",
134138
"plone.restapi/news",
139+
"plone.restapi/parts",
135140
"plone.restapi/performance",
136141
"plone.restapi/src",
142+
"plone.restapi/var",
137143
"volto/contributing/branch-policy.md",
138144
"volto/contributing/install-docker.md",
139145
"volto/contributing/install-git.md",

docs/contributing/core/continuous-integration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Otherwise GitHub workflows do not run automatically, and require a member with w
2727
GitHub workflows should pass before running Jenkins checks and before merging an open pull request.
2828

2929

30+
## `mr-roboto`
31+
32+
[`mr-roboto`](https://github.com/plone/mr.roboto) enforces the requirement of a signed Plone Contributor Agreement from a new contributor, and being assigned to a Plone team on GitHub.
33+
It also suggests to run Jenkins for many Plone packages.
34+
35+
3036
## Jenkins
3137

3238
[Jenkins](https://jenkins.plone.org) is the authoritative source to see whether the complete test suite passes for any Plone version under development.

docs/contributing/core/index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -292,14 +292,10 @@ This enables automatic closing of the related issue when the pull request is mer
292292
This also creates a hyperlink to the original issue for easy reference.
293293

294294

295-
## Jenkins and mr.roboto
295+
## Continuous integration
296296

297-
Plone has a continuous integration ({term}`CI`) setup and follows CI rules.
298-
299-
When you push a change to a Plone package, there may be GitHub workflows that run automatically.
300-
The CI package [mr.roboto](https://github.com/plone/mr.roboto) will perform some checks and suggest that you run Jenkins after all other CI runs.
301-
302-
See {doc}`continuous-integration` for more information.
297+
```{include} /_inc/_continuous-integration.md
298+
```
303299

304300

305301
## Additional material

docs/contributing/documentation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ After your Plone Contributor Agreement has been approved, and you have been adde
111111
112112
1. Clarify the scope of work that needs to be done.
113113
Check for previous work, assignment to another developer, or whether the requirements have changed.
114-
1. [Assign yourself to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users).
114+
1. [Assign yourself to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users).
115115
This signals to other developers that you are working on the issue.
116116
117117
From here, you can either make {ref}`contributing-quick-edits-label` or {ref}`contributing-large-edits-label`.

docs/contributing/first-time.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ Once you have completed, tested, and linted your code, and created a {ref}`contr
260260
This also creates a hyperlink to the original issue for easy reference.
261261

262262
```{seealso}
263-
[Linking a pull request to an issue using a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
263+
[Linking a pull request to an issue using a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
264264
```
265265

266266
1. **Request a review.**

docs/contributing/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ All contributors to the Plone Documentation follow the Code of Conduct.
6060

6161
First-time contributors should read and follow our guide {doc}`first-time`.
6262

63+
6364
(contributing-continuous-integration-label)=
6465

6566
## Continuous integration
6667

67-
Plone project repositories use continuous integration (CI) to run tests, ensure code quality, or provide previews for every contribution.
68-
Plone uses GitHub Actions, Jenkins, Cypress, Netlify, and other services for CI.
69-
All of a project's CI jobs must pass before a contribution may be accepted.
68+
```{include} /_inc/_continuous-integration.md
69+
```
7070

7171
(contributing-change-log-label)=
7272

0 commit comments

Comments
 (0)