Merge branch '6.0' into gforcada-patch-1

Author: stevepiercy

.github/ISSUE_TEMPLATE/new-issue-form.yml

@@ -17,6 +17,6 @@ body:
     id: description
     attributes:
       label: Description
-      description: Include include screenshots and any other helpful information.
+      description: Include screenshots and any other helpful information.
     validations:
       required: true

Makefile

@@ -7,8 +7,8 @@ SPHINXOPTS      ?=
 PAPER           ?=
 
 # Internal variables.
-SPHINXBUILD     = $(realpath bin/sphinx-build)
-SPHINXAUTOBUILD = $(realpath bin/sphinx-autobuild)
+SPHINXBUILD     = "$(realpath bin/sphinx-build)"
+SPHINXAUTOBUILD = "$(realpath bin/sphinx-autobuild)"
 DOCS_DIR        = ./docs/
 BUILDDIR        = ../_build
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -235,7 +235,7 @@ netlify:
 	ln -s ../submodules/volto/docs/source ./docs/volto
 	ln -s ../submodules/plone.restapi ./docs/plone.restapi
 	ln -s ../submodules/plone.api/docs ./docs/plone.api
-	cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html && cp ./netlify_robots.txt $(BUILDDIR)/html/robots.txt
 
 .PHONY: storybook
 storybook:

docs/classic-ui/images.md

@@ -114,7 +114,7 @@ tag = scale_util.tag(
     scale=None,
     height=None,
     width=None,
-    direction="thumbnail"
+    mode="scale"
 )
 ```
 
@@ -233,20 +233,44 @@ image_scale = scaling_util.publishTraverse(context.REQUEST, groups[1])
 ```
 
 
-(classic-ui-images-scaling-direction-label)=
+(classic-ui-images-scaling-mode-label)=
 
-## Scaling `direction`
+## Scaling `mode`
 
-The default direction is `thumbnail`.
+```{versionchanged} 6.0
+Added `mode` to replace the deprecated `direction`.
+Added new option names for `mode` to align with CSS `background-size` values, and deprecated previous names `keep`, `thumbnail`, `scale-crop-to-fit`, `down`, `scale-crop-to-fill`, and `up`.
+```
+
+Scaling is intended for the optimal display of images in a web browser.
+
+To scale an image, you can use the `mode` parameter to control the scaling output.
+You must use either `width` or `height`, or both.
+
+Three different scaling options are supported.
+They correspond to the CSS [`background-size`](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size) values.
+
+The possible options for `mode` are listed below, where the default option is `scale`.
+
+`scale`
+:   This is the default option.
+    `scale` scales to the requested dimensions without cropping.
+    The resulting image may have a different size than requested.
+    This option requires both `width` and `height` to be specified.
+    It does not scale up.
+
+    Deprecated option names: `keep`, `thumbnail`.
+
+`contain`
+:   `contain` starts by scaling the image either to the smaller dimension when you give both `width` and `height`, or to the only given dimension, then crops to the other dimension if needed.
+
+    Deprecated option names: `scale-crop-to-fit`, `down`.
 
-Other options are:
+`cover`
+:   `cover` scales the image either to the larger dimension when you give both `width` and `height`, or to the only given dimension, up to the size you specify.
+    Despite the deprecated option name, it does not crop.
 
-* `down`
-* `keep`
-* `scale-crop-to-fill`
-* `scale-crop-to-fit`
-* `thumbnail`
-* `up`
+    Deprecated option names: `scale-crop-to-fill`, `up`.
 
 
 (classic-ui-images-permissions-label)=

docs/classic-ui/index.md

@@ -53,6 +53,7 @@ forms
 icons
 images
 layers
+mockup
 portlets
 recipes
 static-resources

docs/classic-ui/mockup.md

@@ -0,0 +1,18 @@
+---
+myst:
+  html_meta:
+    "description": "Mockup together with Patternslib are used to build the UI toolkit for Classic UI, a frontend for Plone."
+    "property=og:description": "Mockup together with Patternslib are used to build the UI toolkit for Classic UI, a frontend for Plone."
+    "property=og:title": "Mockup"
+    "keywords": "Mockup, Patternslib, Classic UI, frontend, Plone"
+---
+
+(mockup-label)=
+
+# Mockup
+
+{term}`Mockup` together with {term}`Patternslib` are used to build the UI toolkit for {term}`Classic UI`, a frontend for Plone.
+
+View the [interactive documentation of Mockup](https://plone.github.io/mockup/).
+
+For more information, visit the [Mockup repository on GitHub](https://github.com/plone/mockup).

docs/classic-ui/theming/barceloneta.md

@@ -25,7 +25,7 @@ To create an add-on package with a Plone Classic UI theme, you need to install t
 -   [Python (>=3.8)](https://www.python.org/)
 -   [plonecli](https://pypi.org/project/plonecli/)
 
-Read more about how to install pre-requisites in {doc}`/install/install-from-packages`.
+Read more about how to install pre-requisites in {doc}`/install/create-project`.
 
 
 (classic-ui-theming-barceloneta-create-a-classic-ui-theme-add-on-package-label)=

docs/conf.py

@@ -49,6 +49,7 @@
     "sphinx.ext.todo",
     "sphinx_copybutton",
     "sphinx_design",
+    "sphinx_reredirects",
     "sphinx_sitemap",
     "sphinxcontrib.httpdomain",  # plone.restapi
     "sphinxcontrib.httpexample",  # plone.restapi
@@ -92,11 +93,14 @@
     r"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors#Identifying_the_issue",
     r"https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-version-10-0",  # volto
     # Ignore unreliable sites
+    r"https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi",  # TODO retest with latest Sphinx when upgrading theme. chromewebstore recently changed its URL and has "too many redirects".
+    r"https://chromewebstore.google.com/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd",  # TODO retest with latest Sphinx when upgrading theme. chromewebstore recently changed its URL and has "too many redirects".
+    r"https://stackoverflow.com",  # volto and documentation  # TODO retest with latest Sphinx.
     r"https://web.archive.org/",  # volto
     r"https://www.youtube.com/playlist",  # volto, TODO remove after installing sphinxcontrib.youtube
 ]
 linkcheck_anchors = True
-linkcheck_timeout = 5
+linkcheck_timeout = 10
 linkcheck_retries = 1
 
 # The suffix of source filenames.
@@ -127,6 +131,11 @@
     "plone.restapi/performance",
     "plone.restapi/src",
     "volto/contributing/branch-policy.md",
+    "volto/contributing/install-docker.md",
+    "volto/contributing/install-git.md",
+    "volto/contributing/install-make.md",
+    "volto/contributing/install-nodejs.md",
+    "volto/contributing/install-operating-system.md",
 ]
 
 suppress_warnings = [
@@ -216,6 +225,16 @@
 notfound_template = "404.html"
 
 
+# -- sphinx-reredirects configuration ----------------------------------
+# https://documatt.com/sphinx-reredirects/usage.html
+redirects = {
+    "contributing/plone-api": "/plone.api/contribute/index.html",
+    "contributing/plone-restapi": "/plone.restapi/docs/source/contributing/index.html",
+    "contributing/volto": "/volto/contributing/index.html",
+    "install/install-from-packages": "/install/create-project.html",
+}
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -322,9 +341,9 @@ def source_replace(app, docname, source):
 # Dict of replacements.
 source_replacements = {
     "{PLONE_BACKEND_MINOR_VERSION}": "6.0",
-    "{PLONE_BACKEND_PATCH_VERSION}": "6.0.8",
+    "{PLONE_BACKEND_PATCH_VERSION}": "6.0.10.1",
     "{NVM_VERSION}": "0.39.5",
-    "{SUPPORTED_PYTHON_VERSIONS}": "3.8, 3.9, 3.10, or 3.11",
+    "{SUPPORTED_PYTHON_VERSIONS}": "3.8, 3.9, 3.10, 3.11, or 3.12",
 }
 
 

docs/contributing/documentation/authors.md

@@ -298,4 +298,5 @@ The Plone Documentation Team adopted additional guidelines.
 ## General documentation writing references
 
 -   [Write the Docs - Documentation Guide](https://www.writethedocs.org/guide/)
+-   [Creating effective technical documentation](https://developer.mozilla.org/en-US/blog/technical-writing/), Dipika Bhattacharya, Technical Writer at Mozilla Developer Network
 -   [A Guide to Em Dashes, En Dashes, and Hyphens](https://www.merriam-webster.com/grammar/em-dash-en-dash-how-to-use)

docs/contributing/documentation/index.md

@@ -15,6 +15,10 @@ This document describes how to contribute to Plone Documentation.
 
 Contributions to the Plone Documentation are welcome.
 
+```{seealso}
+To set up and build the documentation locally, see {doc}`setup-build`.
+```
+
 
 (contributing-permission-to-publish-label)=
 

docs/contributing/documentation/setup-build.md

@@ -11,7 +11,7 @@ myst:
 
 # Building and checking the quality of documentation
 
-This document covers how to build the Plone Documentation and check it for quality.
+This document covers how to set up and build the Plone Documentation and check it for quality.
 
 
 (setup-build-installation-label)=
@@ -20,14 +20,28 @@ This document covers how to build the Plone Documentation and check it for quali
 
 Installation of Plone 6 Documentation includes pre-requisites and the repository itself.
 
+```{include} ../../volto/contributing/install-operating-system.md
+```
+-   {ref}`setup-build-installation-python-label` {SUPPORTED_PYTHON_VERSIONS}
+-   {ref}`setup-build-installation-gnu-make-label`
+-   {ref}`setup-build-installation-graphviz-label`
+
 
 (setup-build-installation-python-label)=
 
 ### Python
 
-Python 3.8 or later is required.
-A more recent Python is preferred.
-Use your system's package manager or [pyenv](https://github.com/pyenv/pyenv) to install an appropriate version of Python.
+Installing Python is beyond the scope of this documentation.
+However, it is recommended to use a Python version manager, {term}`pyenv` that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
+Plone requires Python version {SUPPORTED_PYTHON_VERSIONS}.
+
+
+(setup-build-installation-gnu-make-label)=
+
+### GNU make
+
+```{include} ../../volto/contributing/install-make.md
+```
 
 
 (setup-build-installation-graphviz-label)=