From cc6ffd22874ece141024f95c43a6f78215a02805 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 24 Nov 2024 04:57:36 -0800 Subject: [PATCH] Add supported web browsers (#1792) * Add supported web browsers. Closes #1280. https://github.com/plone/volto/pull/6501 must be merged before this PR can be merged. * Add supported web browsers. Closes #1280. https://github.com/plone/volto/pull/6501 must be merged before this PR can be merged. * Ignore failing linkcheck anchor for `https://browsersl.ist/#` * Update Bootstrap version --- docs/_inc/_install-browser-reqs-classic-ui.md | 16 ++++++++++++++++ docs/_inc/_install-browser-reqs-volto.md | 10 ++++++++++ docs/admin-guide/install-buildout.md | 7 +++++++ docs/admin-guide/install-pip.md | 7 +++++++ docs/conf.py | 1 + docs/install/create-project-cookieplone.md | 6 ++++++ docs/install/create-project.md | 9 +++++++++ 7 files changed, 56 insertions(+) create mode 100644 docs/_inc/_install-browser-reqs-classic-ui.md create mode 100644 docs/_inc/_install-browser-reqs-volto.md diff --git a/docs/_inc/_install-browser-reqs-classic-ui.md b/docs/_inc/_install-browser-reqs-classic-ui.md new file mode 100644 index 000000000..3c5834310 --- /dev/null +++ b/docs/_inc/_install-browser-reqs-classic-ui.md @@ -0,0 +1,16 @@ +You can view the list of supported browsers for Classic UI at [Browserslist](https://browsersl.ist/#q=%3E%3D+0.5%25%0Alast+2+major+versions%0Anot+dead%0AChrome+%3E%3D+60%0AFirefox+%3E%3D+60%0AFirefox+ESR%0AiOS+%3E%3D+12%0ASafari+%3E%3D+12%0Anot+Explorer+%3C%3D+11). + +The supported web browsers for Classic UI are set according to [Bootstrap](https://getbootstrap.com/docs/5.3/getting-started/browsers-devices/#supported-browsers). +The following code snippet is the [browserslist configuration for Bootstrap 5.3.3](https://github.com/twbs/bootstrap/blob/v5.3.3/.browserslistrc). + +```shell +>= 0.5% +last 2 major versions +not dead +Chrome >= 60 +Firefox >= 60 +Firefox ESR +iOS >= 12 +Safari >= 12 +not Explorer <= 11 +``` diff --git a/docs/_inc/_install-browser-reqs-volto.md b/docs/_inc/_install-browser-reqs-volto.md new file mode 100644 index 000000000..b5db8d42a --- /dev/null +++ b/docs/_inc/_install-browser-reqs-volto.md @@ -0,0 +1,10 @@ +You can view the list of supported browsers for Volto at [Browserslist](https://browsersl.ist/#q=%3E1%25%0Alast+4+versions%0AFirefox+ESR%0Anot+dead). + +These browsers are set according to the `browserslist` key in Volto's [`package.json`](https://github.com/plone/volto/blob/1aff8d0451f5cb375ca9f5afe9b2b72a0555afd8/packages/volto/package.json#L170-L176) file, whose content is below. + +```shell +>1% +last 4 versions +Firefox ESR +not dead +``` diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index ca821795f..a3470cb14 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -22,6 +22,13 @@ For other installation options, see {ref}`get-started-install-label`. (install-buildout-prerequisites)= + +## Supported web browsers + +```{include} /_inc/_install-browser-reqs-classic-ui.md +``` + + ## Prerequisites for installation - For Plone 6.0, Python {{SUPPORTED_PYTHON_VERSIONS_PLONE60}} diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index 38a586931..ec9346b8f 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -20,6 +20,13 @@ It provides a basic installation without many additional tools to help with deve For other installation options, see {ref}`get-started-install-label`. ``` + +## Supported web browsers + +```{include} /_inc/_install-browser-reqs-classic-ui.md +``` + + (install-pip-prerequisites)= ## Prerequisites for installation diff --git a/docs/conf.py b/docs/conf.py index 4a98309a3..5c135ba78 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,6 +102,7 @@ r"https://coveralls.io/repos/github/plone/plone.restapi/badge.svg\?branch=main", # plone.restapi r"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors#Identifying_the_issue", # volto r"https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-version-10-0", # volto + r"https://browsersl.ist/#", # Ignore unreliable sites r"https://web.archive.org/", r"http://z3c.pt", # fluke where Sphinx interprets this as a URL diff --git a/docs/install/create-project-cookieplone.md b/docs/install/create-project-cookieplone.md index 1a9757195..a4cad156b 100644 --- a/docs/install/create-project-cookieplone.md +++ b/docs/install/create-project-cookieplone.md @@ -33,6 +33,12 @@ For other installation options, see {ref}`get-started-install-label`. Plone 6 has both hardware requirements and software prerequisites. +### Supported web browsers + +```{include} /_inc/_install-browser-reqs-volto.md +``` + + (create-project-cookieplone-hardware-requirements-label)= ### Hardware requirements diff --git a/docs/install/create-project.md b/docs/install/create-project.md index bed68a466..7736aecc7 100644 --- a/docs/install/create-project.md +++ b/docs/install/create-project.md @@ -30,6 +30,15 @@ This template creates a web application using Plone with the Volto frontend, alo Plone 6.0 has both hardware requirements and software prerequisites. +### Supported web browsers + +```{include} /_inc/_install-browser-reqs-volto.md +``` + +```{include} /_inc/_install-browser-reqs-classic-ui.md +``` + + (install-packages-hardware-requirements-label)= ### Hardware requirements