Skip to content

Commit

Permalink
Merge branch 'main' into a11y-notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ichim-david authored Nov 26, 2024
2 parents 9a75ab1 + 2d47989 commit eff59ed
Show file tree
Hide file tree
Showing 37 changed files with 1,832 additions and 133 deletions.
8 changes: 5 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,15 @@ The release process calls `towncrier`.
It is a Python library that uses the Python utility `pipx`.
This utility allows you to call and execute Python modules without installing them as a prerequisite in your system.
It works similar to the NodeJS `npx` utility.
On macOS, you can install `pipx` into your system:

Install {term}`pipx` for your active Python, and ensure it is on your `$PATH`.
Carefully read the console output for further instructions, if needed.

```shell
brew install pipx
python3 -m pip install pipx
pipx ensurepath
```

Or follow detailed instructions in the `pipx` documentation for [Installation](https://pypa.github.io/pipx/installation/).

## Running the release process

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 4 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"sphinx_copybutton",
"sphinx_examples",
"sphinxcontrib.video",
"sphinxcontrib.youtube",
"sphinxext.opengraph",
]

Expand All @@ -89,11 +90,8 @@
# Ignore github.com pages with anchors
r"https://github.com/.*#.*",
# Ignore other specific anchors
# 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://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",
# r"https://stackoverflow.com", # volto and documentation # TODO retest with latest Sphinx.
]
linkcheck_anchors = True
linkcheck_timeout = 5
Expand All @@ -117,7 +115,7 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
"spelling_wordlist.txt",
"contributing/branch-policy.md",
"_inc/*",
]

suppress_warnings = [
Expand Down Expand Up @@ -179,15 +177,15 @@
"path_to_docs": "docs",
"repository_branch": "main",
"repository_url": "https://github.com/plone/volto",
"search_bar_text": "Search", # TODO: Confirm usage of search_bar_text in plone-sphinx-theme
"search_bar_text": "Search",
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
}

# Announce that we have an opensearch plugin
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_use_opensearch
html_use_opensearch = "https://6.docs.plone.org" # TODO: Confirm usage of opensearch in theme
html_use_opensearch = "https://6.docs.plone.org"

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
2 changes: 1 addition & 1 deletion docs/source/configuration/volto-slate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ myst:

`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate` and integrated into the core system.
It offers enhanced WYSIWYG functionality and behavior.
See a [brief elevator pitch for `volto-slate`](https://www.youtube.com/watch?v=SOz-rk5e4_w).
See a [brief elevator pitch for `volto-slate`](https://www.youtube-nocookie.com/embed/SOz-rk5e4_w?privacy_mode=1).

We believe that Volto's rich text form editor (the Volto Composite Page editor) needs strong integration between the rich text capabilities and the rest of the Volto blocks.
Some examples of the kind of strong integration we have in mind:
Expand Down
12 changes: 6 additions & 6 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Volto has the following folder structure.

To set up a Volto core development environment, your system must satisfy the following prerequisites.

```{include} ./install-operating-system.md
```{include} ../_inc/_install-operating-system.md
```

- {term}`nvm`
Expand All @@ -94,7 +94,7 @@ When developing a project using Plone, Yarn or other package managers may be use

### nvm

```{include} ./install-nvm.md
```{include} ../_inc/_install-nvm.md
```


Expand All @@ -103,7 +103,7 @@ When developing a project using Plone, Yarn or other package managers may be use
We recommend that you install Node.js using nvm.
Alternatively you can install Node.js using Homebrew or other package installer.

```{include} ./install-nodejs.md
```{include} ../_inc/_install-nodejs.md
```


Expand Down Expand Up @@ -136,19 +136,19 @@ Compare the output to the [latest pnpm release number](https://www.npmjs.com/pac

### Make

```{include} ./install-make.md
```{include} ../_inc/_install-make.md
```


### Docker

```{include} ./install-docker.md
```{include} ../_inc/_install-docker.md
```


### Git

```{include} ../contributing/install-git.md
```{include} ../_inc/_install-git.md
```


Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The Volto Team reviews pull requests only from people with a GitHub account who

## Branch policy

```{include} ./branch-policy.md
```{include} ../_inc/_branch-policy.md
```


Expand Down
1 change: 0 additions & 1 deletion docs/source/contributing/language-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ You can adjust this file according to the environments you want to target.
">1%",
"last 4 versions",
"Firefox ESR",
"not ie 11",
"not dead"
],
```
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/version-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ We do not guarantee that outdated browsers, such as Internet Explorer 11, are su

## Branch policy

```{include} ./branch-policy.md
```{include} ../_inc/_branch-policy.md
```


Expand Down
18 changes: 18 additions & 0 deletions docs/source/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,24 @@ myst:

<!-- towncrier release notes start -->

## 18.1.1 (2024-11-21)

### Bugfix

- Do not break toolbar if layout id is not registered in layoutViewsNamesMapping. @cekk [#6485](https://github.com/plone/volto/issues/6485)
- Replace _all_ spaces with `-` in `BodyClass` classes, instead of with `-` or `` depending on the content type or section. @giuliaghisini [#6487](https://github.com/plone/volto/issues/6487)

### Internal

- Update instructions to install `pipx` in `RELEASING.md`. @stevepiercy [#6496](https://github.com/plone/volto/issues/6496)

### Documentation

- More privacy concerning youtube links and fixing link check warnings for youtube playlist links. @stevepiercy @ksuess [#4203](https://github.com/plone/volto/issues/4203)
- Remove conflicting `searchtools.js` file from documentation to allow default Sphinx search in main Plone documentation. @stevepiercy [#6482](https://github.com/plone/volto/issues/6482)
- Add support for sphinxcontrib-youtube. @stevepiercy [#6486](https://github.com/plone/volto/issues/6486)
- Refactor documentation includes to align with main documentation pattern. @stevepiercy [#6495](https://github.com/plone/volto/issues/6495)

## 18.1.0 (2024-11-11)

### Feature
Expand Down
50 changes: 28 additions & 22 deletions docs/source/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ On the [Plone Training website](https://training.plone.org), you'll find Volto-d

- [Mastering Plone 6 Development](https://training.plone.org/mastering-plone/)
The comprehensive training on Plone 6 with best practice tips for developers and integrators.
- [Customizing Volto Light Theme](https://training.plone.org/customizing-volto-light-theme/index.html)
- [Volto Customization for JavaScript Beginners](https://training.plone.org/volto-customization/index.html)
- [Volto Hands-On](https://training.plone.org/voltohandson/index.html)
- [Volto Add-ons Development](https://training.plone.org/voltoaddons/index.html)
- [Effective Volto](https://training.plone.org/effective-volto/index.html)
Expand All @@ -30,7 +32,11 @@ On the [Plone Training website](https://training.plone.org), you'll find Volto-d

You can watch the talk during the World Plone Day 2021:

<iframe width="560" height="315" src="https://www.youtube.com/embed/kHec4MXH8vo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
```{youtube} kHec4MXH8vo
:privacy_mode:
:url_parameters: ?privacy_mode=1
:width: 100%
```


## Presentations at Plone Conferences (PloneConf) and other events
Expand All @@ -40,43 +46,43 @@ In recent years the React based Volto frontend for Plone has been presented in m

### PloneConf 2023

- [State of Plone Keynote](https://www.youtube.com/watch?v=jl19wuC0wtw&%3Blist=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&%3Bindex=1)
- [Piero Nicolli - Theming Volto in 2024](https://www.youtube.com/watch?v=LkPOsIn1jYY&%3Blist=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&%3Bindex=6)
- [Víctor Fernández de Alba - Breaking boundaries: Plone as headless CMS](https://www.youtube.com/watch?v=43LVtjYyo28&list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=7)
- [Rob Gietema - How to build a site using Nick](https://www.youtube.com/watch?v=ZbdYvNAnamM&list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=18)
- [Alok Kumar - Is your Volto add-on developer friendly?](https://www.youtube.com/watch?v=E6fH3NhR2Hc&list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=20)
- [Dylan Jay and Jefferson Bledsoe - How to implement a Gov Design System in Plone 6](https://www.youtube.com/watch?v=_XmKc7jNIE8&list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=25)
- [Víctor Fernández de Alba - Volto-light-theme: Volto Theming, Reimagined](https://www.youtube.com/watch?v=t2X2NO62J-8)
- [State of Plone Keynote](https://www.youtube-nocookie.com/embed/jl19wuC0wtw?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=1&privacy_mode=1)
- [Piero Nicolli - Theming Volto in 2024](https://www.youtube-nocookie.com/embed/LkPOsIn1jYY?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=6&privacy_mode=1)
- [Víctor Fernández de Alba - Breaking boundaries: Plone as headless CMS](https://www.youtube-nocookie.com/embed/43LVtjYyo28?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=7&privacy_mode=1)
- [Rob Gietema - How to build a site using Nick](https://www.youtube-nocookie.com/embed/ZbdYvNAnamM?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=18&privacy_mode=1)
- [Alok Kumar - Is your Volto add-on developer friendly?](https://www.youtube-nocookie.com/embed/E6fH3NhR2Hc?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=20&privacy_mode=1)
- [Dylan Jay and Jefferson Bledsoe - How to implement a Gov Design System in Plone 6](https://www.youtube-nocookie.com/embed/_XmKc7jNIE8?list=PLGN9BI-OAQkSXMXVBXLWQAQr0AF2xM_NU&index=25&privacy_mode=1)
- [Víctor Fernández de Alba - Volto-light-theme: Volto Theming, Reimagined](https://www.youtube-nocookie.com/embed/t2X2NO62J-8)


### PloneConf 2022

[PloneConf 2022 full Playlist on Youtube](https://www.youtube.com/playlist?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
[PloneConf 2022 full Playlist on Youtube](https://www.youtube-nocookie.com/embed/playlist?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)

Plone 6 site presentations:

- [Rai Way: Plone6 supporting the world of italian information, sports and entertainment](https://www.youtube.com/watch?v=hHHGlSjf5O4&list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [How Plone Powers Hundreds of Websites at one of the Largest Research Institutions in Europe](https://www.youtube.com/watch?v=bxWt-GEmPcc&%3Blist=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [Rai Way: Plone6 supporting the world of italian information, sports and entertainment](https://www.youtube-nocookie.com/embed/hHHGlSjf5O4?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)
- [How Plone Powers Hundreds of Websites at one of the Largest Research Institutions in Europe](https://www.youtube-nocookie.com/embed/bxWt-GEmPcc?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)

Developer/integrator talks:

- [Anatomy of a Volto project](https://www.youtube.com/watch?v=JtNufyFlgc8&list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [Creating a Volto Theme](https://www.youtube.com/watch?v=AMHN74Jr27Y&%3Blist=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [A Deep Dive Into Internals Of Volto](https://www.youtube.com/watch?v=sMeTDRgp3uI&list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [DevOps Bird's Eye View on the Plone 6 Backend](https://www.youtube.com/watch?v=L5PvGwWC9P4&%3Blist=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z)
- [Anatomy of a Volto project](https://www.youtube-nocookie.com/embed/JtNufyFlgc8?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)
- [Creating a Volto Theme](https://www.youtube-nocookie.com/embed/AMHN74Jr27Y?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)
- [A Deep Dive Into Internals Of Volto](https://www.youtube-nocookie.com/embed/sMeTDRgp3uI?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)
- [DevOps Bird's Eye View on the Plone 6 Backend](https://www.youtube-nocookie.com/embed/L5PvGwWC9P4?list=PLGN9BI-OAQkQxqQcCZeJefMC8XlA_qv3Z&privacy_mode=1)


### Previous PloneConfs

- [PloneConf 2021 full Playlist on YouTube](https://www.youtube.com/playlist?list=PLGN9BI-OAQkQDLQinBwdEXpebDTQCwdGi)
- [PloneConf 2020 full Playlist on YouTube](https://www.youtube.com/playlist?list=PLGN9BI-OAQkTJPayNdKIZ8lLDm5RVOLV3)
- [PloneConf 2021 full Playlist on YouTube](https://www.youtube-nocookie.com/embed/playlist?list=PLGN9BI-OAQkQDLQinBwdEXpebDTQCwdGi&privacy_mode=1)
- [PloneConf 2020 full Playlist on YouTube](https://www.youtube-nocookie.com/embed/playlist?list=PLGN9BI-OAQkTJPayNdKIZ8lLDm5RVOLV3&privacy_mode=1)


## World Plone Day 2022

World Plone Day is a 24-hour streaming event, with the goal was to promote and educate the public about the benefits of using Plone and of being part of the Plone community. [Full World Plone Day 2022 playlist on Youtube](https://www.youtube.com/playlist?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL)
World Plone Day is a 24-hour streaming event, with the goal was to promote and educate the public about the benefits of using Plone and of being part of the Plone community. [Full World Plone Day 2022 playlist on Youtube](https://www.youtube-nocookie.com/embed/playlist?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL&privacy_mode=1)

- [Plone 6 Volto's Seamless Mode](https://www.youtube.com/watch?v=Mj8pHRBls-w&list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL)
- [Volto add ons separator and carousel](https://www.youtube.com/watch?v=eyTMI5TYcVg&list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL)
- [Weekly Volto Live – Retrospective](https://www.youtube.com/watch?v=WT6OjkSrB20&%3Blist=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL)
- [Migrating from Classic to Volto](https://www.youtube.com/watch?v=09fg456T90s&list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL)
- [Plone 6 Volto's Seamless Mode](https://www.youtube-nocookie.com/embed/Mj8pHRBls-w?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL&privacy_mode=1)
- [Volto add ons separator and carousel](https://www.youtube-nocookie.com/embed/eyTMI5TYcVg?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL&privacy_mode=1)
- [Weekly Volto Live – Retrospective](https://www.youtube-nocookie.com/embed/WT6OjkSrB20?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL&privacy_mode=1)
- [Migrating from Classic to Volto](https://www.youtube-nocookie.com/embed/09fg456T90s?list=PLGN9BI-OAQkQmEqf6O8jeyoFY1b2hD1uL&privacy_mode=1)
2 changes: 2 additions & 0 deletions docs/source/user-manual/copy-paste-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This will select all the blocks between the start and end blocks, allowing you t

````{only} not text
```{video} ../_static/user-manual/blocks/block-copy-cut.mp4
:alt: Copy or cut a block in Volto
```
````

Expand All @@ -44,5 +45,6 @@ Also if you hold the {kbd}`ctrl` key while clicking the paste button, it keeps t

````{only} not text
```{video} ../_static/user-manual/blocks/block-paste.mp4
:alt: Paste a block in Volto
```
````
6 changes: 6 additions & 0 deletions packages/components/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

<!-- towncrier release notes start -->

## 2.2.0 (2024-11-21)

### Feature

- Update RAC to 1.5.0 @sneridagh [#6498](https://github.com/plone/volto/issues/6498)

## 2.1.1 (2024-11-05)

### Internal
Expand Down
8 changes: 4 additions & 4 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
}
],
"license": "MIT",
"version": "2.1.1",
"version": "2.2.0",
"repository": {
"type": "git",
"url": "http://github.com/plone/components.git"
Expand Down Expand Up @@ -110,11 +110,11 @@
"vitest-axe": "^0.1.0"
},
"dependencies": {
"@react-aria/utils": "^3.25.3",
"@react-spectrum/utils": "^3.11.11",
"@react-aria/utils": "^3.26.0",
"@react-spectrum/utils": "^3.12.0",
"@storybook/test": "^8.0.4",
"clsx": "^2.1.1",
"react-aria-components": "^1.4.0"
"react-aria-components": "^1.5.0"
},
"peerDependencies": {
"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';
import { Disclosure } from './Disclosure';
import {
Button,
UNSTABLE_DisclosurePanel as DisclosurePanel,
DisclosurePanel as DisclosurePanel,
} from 'react-aria-components';

import type { Meta, StoryObj } from '@storybook/react';
Expand Down
5 changes: 1 addition & 4 deletions packages/components/src/components/Disclosure/Disclosure.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
import * as React from 'react';
import {
UNSTABLE_Disclosure as RACDisclosure,
Disclosure as RACDisclosure,
type DisclosureProps,
} from 'react-aria-components';

/**
* A Disclosure is used to show or hide content that is not visible by default.
*
* NOTE: This component is in alpha in RAC thus it's unstable and is subjects of change
* in the API, behavior, and appearance.
*/
export function Disclosure(props: DisclosureProps) {
return <RACDisclosure {...props} />;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import * as React from 'react';
import { DisclosureGroup } from './DisclosureGroup';
import {
Button,
UNSTABLE_Disclosure as Disclosure,
UNSTABLE_DisclosurePanel as DisclosurePanel,
Disclosure as Disclosure,
DisclosurePanel as DisclosurePanel,
} from 'react-aria-components';

import type { Meta, StoryObj } from '@storybook/react';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
import * as React from 'react';
import {
UNSTABLE_DisclosureGroup as RACDisclosureGroup,
DisclosureGroup as RACDisclosureGroup,
type DisclosureGroupProps,
} from 'react-aria-components';

/**
* A DisclosureGroup is used to group Disclosures together to create an accordion.
*
* NOTE: This component is in alpha in RAC thus it's unstable and is subjects of change
* in the API, behavior, and appearance.
*/
export function DisclosureGroup(props: DisclosureGroupProps) {
return <RACDisclosureGroup {...props} />;
Expand Down
6 changes: 6 additions & 0 deletions packages/providers/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

<!-- towncrier release notes start -->

## 1.0.0-alpha.6 (2024-11-21)

### Feature

- Update RAC to 1.5.0 @sneridagh [#6498](https://github.com/plone/volto/issues/6498)

## 1.0.0-alpha.5 (2024-11-05)

### Internal
Expand Down
4 changes: 2 additions & 2 deletions packages/providers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
],
"funding": "https://github.com/sponsors/plone",
"license": "MIT",
"version": "1.0.0-alpha.5",
"version": "1.0.0-alpha.6",
"repository": {
"type": "git",
"url": "https://github.com/plone/volto.git"
Expand Down Expand Up @@ -65,7 +65,7 @@
"@plone/components": "workspace:*",
"@plone/registry": "workspace:*",
"@tanstack/react-query": "^5.59.0",
"react-aria-components": "^1.4.0"
"react-aria-components": "^1.5.0"
},
"devDependencies": {
"@arethetypeswrong/cli": "^0.16.4",
Expand Down
Loading

0 comments on commit eff59ed

Please sign in to comment.