Skip to content

Commit 81e2079

Browse files
authored
Merge branch '6.0' into rohnsha0-control-panel
2 parents 9fcd80f + 8941111 commit 81e2079

File tree

14 files changed

+100
-116
lines changed

14 files changed

+100
-116
lines changed

Makefile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ docs/volto: ## Setup Volto docs
7373
@echo "Documentation of volto initialized."
7474
@echo
7575

76+
ln-seven: ## Toggle the symlink to Seven
77+
rm docs/volto
78+
ln -s ../submodules/volto/docs ./docs/volto
79+
@echo "Symlink to Volto changed to Seven."
80+
@echo
81+
82+
ln-volto: ## Toggle the symlink to Volto
83+
rm docs/volto
84+
ln -s ../submodules/volto/docs/source ./docs/volto
85+
@echo "Symlink to Seven changed to Volto."
86+
@echo
87+
7688
.PHONY: deps
7789
deps: venv/bin/python docs/volto docs/plone.restapi venv/plone.api-install ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, create symlinks to the source files, and finally install plone.api.
7890

docs/_inc/_hardware-requirements.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/_inc/_install-pipx.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/backend/subscribers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Here, the event handler code will only be executed if the object is a content ty
6060
If you want this to be interface agnostic, insert an asterix `*` as a wildcard instead.
6161

6262
The third line defines the event on which this should happen, which is `IObjectCreatedEvent`.
63-
For more available possible events to use as a trigger, see {ref}`subscribers-event-handlers`.
63+
For more available possible events to use as a trigger, see {ref}`subscribers-event-types-label`.
6464

6565
The fourth line gives the path to the callable function to be executed.
6666

docs/contributing/documentation/authors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ The Plone Documentation Team adopted additional guidelines.
371371
To make that work in Volto, set your browser width to 1180 pixels.
372372
You will notice that the drag and trash icons for each block move inside the block from outside.
373373

374-
If you create images wider than 740 pixels, then you must use image display enhancement as described in {ref}`enhance-images-label`.
374+
If you create images wider than 740 pixels, then you must use image display enhancement as described in {ref}`enhance-media-label`.
375375
- In user documentation, provide screenshots of each step where the interface changes.
376376
It is painstaking, but worth the effort.
377377
Provide sufficient detail of what each option is and does.

docs/contributing/documentation/myst-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ MyST extends {term}`Markdown` by incorporating all the features of {term}`reStru
2222
Contributors are welcome to use either Markdown or MyST syntax.
2323

2424
MyST may be more familiar to reStructuredText authors.
25-
MyST allows the use of a {term}`fence` and `{rst-eval}` to evaluate native reStructuredText.
25+
MyST allows the use of a {term}`fence` and `{eval-rst}` to evaluate native reStructuredText.
2626
This may be useful when Markdown does not provide sufficient flexibility, such as for `figure`.
2727

2828

docs/contributing/index.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ To contribute to any project in Plone, you must follow the policies of the [Plon
2020
This chapter covers policies that apply to all Plone projects.
2121
Other chapters cover any variations and additional policies for each project.
2222

23+
2324
(contributing-sign-and-return-the-plone-contributor-agreement-label)=
2425

2526
## Sign and return the Plone Contributor Agreement
@@ -77,6 +78,7 @@ Someone will help identify in which of the dozens of repositories that make up P
7778
```{include} /_inc/_continuous-integration.md
7879
```
7980

81+
8082
(contributing-change-log-label)=
8183

8284
## Change log entry
@@ -102,11 +104,11 @@ When making a change to its documentation, set up, continuous integration, or ot
102104

103105
The change log entry's format must be `###.type`, where `###` is the referenced GitHub issue or pull request number, `.` is the literal extension delimiter, and `type` is one of the following strings.
104106

105-
- `breaking` for breaking changes
106-
- `bugfix` for bug fixes
107-
- `documentation` for documentation
108-
- `feature` for new features
109-
- `internal` for internal changes
107+
- `breaking` for breaking changes
108+
- `bugfix` for bug fixes
109+
- `documentation` for documentation
110+
- `feature` for new features
111+
- `internal` for internal changes
110112

111113
A package configures the types it allows in a file `towncrier.toml` located at the root of its package directory.
112114

@@ -156,6 +158,25 @@ To standarize the developer experience across packages, a configuration tool is
156158

157159
See the [tool documentation](https://github.com/plone/meta) for more information.
158160

161+
162+
(contributing-guidance-for-merging-pull-requests-label)=
163+
164+
## Guidance for merging pull requests
165+
166+
- If you have any doubt, don't merge, but ask.
167+
- All {doc}`CI checks <core/continuous-integration>` must pass, unless there is a good reason to ignore it.
168+
If you ignore a check, then write the good reason either in a comment or in the merge message.
169+
- Get at least one approval from another Plone contributor, preferably a member of the GitHub Team for the repository.
170+
- If the pull request has documentation, ask for a review from `@plone/documentation-team`.
171+
- Usually the merge message populates with all the commit messages, but some repositories aren't configured to do this.
172+
It's helpful to include a descriptive message in the merge request.
173+
- After merging, look for any linked issues that should be closed, and close them.
174+
Sometimes the contributor forgets to include `closes #123` in the description, which would automatically close the related issue.
175+
- If the change is a bugfix, make sure that it is not merged to an older release branch unless it is also merged in separate pull request to `main`.
176+
- Thank the contributor.
177+
- 🍻
178+
179+
159180
(contributing-specific-contribution-policies-for-projects-label)=
160181

161182
## Specific contribution policies of projects

docs/glossary.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,13 @@ pyenv
9999
Python version management.
100100
[pyenv](https://github.com/pyenv/pyenv) lets you easily switch between multiple versions of Python.
101101
102+
uv
103+
[uv](https://docs.astral.sh/uv/) is a Python package and project manager, written in Rust.
104+
105+
`uvx`
106+
`uvx` is an alias for `uv tool run`, implemented in {term}`uv`.
107+
It executes and installs command-line tools provided by Python packages in an ephemeral environment, similar to {term}`pipx`.
108+
102109
pm2
103110
[PM2](https://pm2.keymetrics.io/) is a daemon process manager.
104111
@@ -463,7 +470,7 @@ Slate
463470
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`, offering enhanced {term}`WYSIWYG` functionality and behavior.
464471
465472
WYSIWYG
466-
WYSIWYG is an acronym for "what you see is what you get", referring to software that allows content to be edited in a form that resembles its appearance when printed or displayed as a finished product.
473+
WYSIWYG is an acronym for "what you see is what you get", referring to software that allows content to be edited in a form that resembles its appearance when printed or displayed as a finished product.
467474
468475
TinyMCE
469476
The rich text {term}`WYSIWYG` editor used in {term}`Classic UI`.
@@ -563,7 +570,7 @@ ZODB
563570
[A native object database for Python](https://zodb.org/en/latest/).
564571
565572
`FileStorage`
566-
`FileStorage` is a Python class in {term}`ZODB` that saves data in a file.
573+
`FileStorage` is a Python class in {term}`ZODB` that saves data in a file.
567574
568575
```{seealso}
569576
https://zodb.org/en/latest/reference/storages.html#filestorage
@@ -868,7 +875,7 @@ schema enhancer
868875
variation
869876
A variation is a common development pattern that provides alternative views for the same data.
870877
For example, a teaser block can present data as `title + link`, `title + description + link`, or `title + image + link`.
871-
878+
872879
An advanced variation can enhance the block by adding data fields to the block.
873880
For example, a listing block variation can show news items with `title + link`.
874881
Extending this example, a developer can add a boolean field to the block that toggles the display of the link.
@@ -880,7 +887,7 @@ Higher-Order Component
880887
HOCs are not part of the React API, per se.
881888
They are a pattern that emerges from React's compositional nature.
882889
Concretely, a higher-order component is a function that takes a component and returns a new component.
883-
890+
884891
```{important}
885892
Higher-order components are not commonly used in modern React code.
886893
```

docs/i18n-l10n/contributing-translations.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ You will need to work in one repository for Plone core, and optionally another o
2828
## Prerequisites
2929

3030
Request write access to https://github.com/collective/plone.app.locales to be able to commit your translation directly.
31-
3231
To do so, [join the collective GitHub organization](https://collective.github.io/).
3332

34-
Optionally sign the [Plone Contributor Agreement](https://plone.org/foundation/contributors-agreement) for translating Volto.
33+
Because translation strings do not constitute an original "work", translators are not required to sign the [Plone Contributor Agreement (PCA)](https://plone.org/foundation/contributors-agreement) to contribute translations to either Plone or Volto.
3534

3635

3736
(contributing-plone-core-translations-translate-plone-classic-ui-label)=
@@ -75,10 +74,7 @@ The process of translating the Volto frontend is the following.
7574
- To update a translation, translate your language's `po` file found at `locales/{language_code}/LC_MESSAGES/volto.po`.
7675
- To create a new translation, create a new directory at `locales/{language_code}/LC_MESSAGES/`, copy the file `locales/volto.pot` to `locales/{language_code}/LC_MESSAGES/volto.po` (note to drop the trailing `t`), and start translating.
7776

78-
4. Run `make i18n` to convert your `po` files into `json`.
79-
Volto loads these `json` files to provide translated text strings in the interface.
80-
81-
5. Commit your changes, and create a pull request.
77+
4. Commit your changes, and create a pull request.
8278

8379
```{seealso}
8480
{doc}`Volto frontend development internationalization </volto/development/i18n>`
@@ -98,17 +94,13 @@ Plone gets free hosting at the [Hosted](https://hosted.weblate.org/) platform th
9894

9995
Translators will need to create an account on Weblate with an email and password.
10096
Authentication with GitHub and other third-party accounts might not work.
97+
You can [configure your Weblate account to receive notifications](https://hosted.weblate.org/accounts/profile/#notifications) either automatically whenever you make a contribution to a project or manually watch specific projects.
10198

10299
Translators can go to the [Plone project in Weblate](https://hosted.weblate.org/projects/plone/).
103100

104101
You will see several components listed.
105102
The `volto` component is for the package `volto`, whose repository is at https://github.com/plone/volto.
106103

107-
```{note}
108-
At this moment Volto translations can't be contributed using Weblate.
109-
The Volto Team are working on this issue, and hope to fix it as soon as possible.
110-
```
111-
112104
All other components are for the package `plone.app.locales`, whose repository is at https://github.com/collective/plone.app.locales.
113105

114106
See the Weblate documentation, [Translating using Weblate](https://docs.weblate.org/en/latest/user/translating.html), for how to use it to write translations.
@@ -117,7 +109,7 @@ When you save a translation, then it is committed on a branch used only for tran
117109

118110
[See recent commits to the package `plone.app.locales`](https://github.com/collective/plone.app.locales/commits/master/).
119111

120-
Maintainers will periodically create a pull request from the changes, and merge it.
112+
Maintainers will periodically review the pull request that Weblate creates automatically, and merge it.
121113

122114

123115
(contributing-plone-core-translations-support-label)=

0 commit comments

Comments
 (0)