Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize README, merging content into authoritative locations #5511

Merged
merged 15 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/readme-link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Check links in all README.mds with awesome_bot
# https://github.com/dkhamsing/awesome_bot
name: readme-link-check

on:
push:
branches: [ '*' ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up Ruby 3.2
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2
- name: Check links in README.md with awesome_bot
run: |
gem install awesome_bot
awesome_bot --request-delay 1 --allow-dupe --white-list http://localhost:8080/Plone,http://localhost:3000,https://github.com/kitconcept/volto-blocks-grid.git --files README.md,packages/client/README.md,packages/components/README.md,packages/generator-volto/README.md,packages/registry/README.md,packages/scripts/README.md,packages/types/README.md,packages/volto-slate/README.md
189 changes: 102 additions & 87 deletions README.md

Large diffs are not rendered by default.

47 changes: 45 additions & 2 deletions docs/source/contributing/version-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,65 @@ The following table describes the compatibility between versions of `volto-gener
| 6.x | 16.x.x |


## Plone and Plone REST API
(version-policy-plone-python-and-plone-rest-api-compatibility)=

## Plone, Python, and Plone REST API compatibility

Volto is the default UI for Plone 6.
It will work for all released Plone 6 versions.

Volto relies on [Plone core (`Products.CMFPlone`)](https://github.com/plone/Products.CMFPlone) and [Plone REST API](https://github.com/plone/plone.restapi).
We will always support the [latest major Plone release](https://plone.org/download/releases) and the version of Plone REST API that ships with it.

Volto should work on old Plone versions as well, since Plone REST API supports Plone back to version 4.3 (including Archetypes).
The versions of Python that are supported in Volto depend on the version of Plone that you use.

| Plone | Python | Volto |
| ----- | ------------ | ------------ |
| 6.0 | 3.8-3.11 | 16.0 or 17.0 |
| 5.2 | 2.7, 3.6-3.8 | 15.0 |

On Plone 6, we recommend using the known good set (KGS) of package versions that are specified in the Plone release.

On Plone 5, Volto is currently tested with the following packages pinned to specific versions, and we recommend using the same versions, which are:

- `plone.restapi` 9.2.0
- `plone.rest` 3.0.1
- `plone.volto` 4.1.0

For the Plone 5 series, the [latest released version of Plone 5](https://plone.org/download/releases) is recommended.

Volto should work on older Plone versions as well, since Plone REST API supports Plone back to version 4.3 (including Archetypes).

We do not support or test Plone versions that were released before Volto existed.

```{seealso}
See also [Plone REST API Python and Plone compatability](https://github.com/plone/plone.restapi#python--plone-compatibility).
```


(version-policy-node-js)=

## Node.js

Volto runs using [Node.js](https://nodejs.org/en).
Volto always supports only [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule).
We recommend using the current LTS version.

- Node.js 20 LTS: Supported since Volto 17.
- Node.js 18 LTS: Supported since Volto 17.
- Node.js 16: No longer supported. It was supported in Volto 14 - 16.
- Node.js 14: No longer supported. It was supported in Volto 8.8.0 - 16.
- Node.js 12: No longer supported. It was supported in Volto 4 - 15.
- Node.js 10: No longer supported. It was supported in Volto 1 - 12.


(version-policy-supported-browsers)=

## Supported browsers

Volto works well with the current version of any modern browser—including Chrome, Firefox, Safari, and Edge—as well as their mobile flavors.

We do not guarantee that outdated browsers, such as Internet Explorer 11, are supported by Volto.


## Branch policy
Expand Down
2 changes: 1 addition & 1 deletion packages/client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

The Javascript Plone client is an agnostic library that provides easy access to the Plone REST API from a client written in TypeScript.
This client can be used as an alternative to directly interacting with the Plone REST API.
It is based on the foundations that [@tanstack/query](https://tanstack.com/query) lays off.
It is based on the foundations that [@tanstack/query](https://tanstack.com/query/latest) lays off.
It should be possible to use it in React/Vue/Solid/Svelte projects.
It provides the artifacts that TanStack Query requires to work:

Expand Down
1 change: 1 addition & 0 deletions packages/client/news/5437.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reorganize `README.md`, merging content into authoritative locations. Add `awesome_bot` to check links in all READMEs. @stevepiercy
2 changes: 1 addition & 1 deletion packages/generator-volto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Installation

First, install [Yeoman](http://yeoman.io) and @plone/generator-volto using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/en)).
First, install [Yeoman](https://yeoman.io/) and @plone/generator-volto using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/en)).

```bash
npm install -g yo
Expand Down
1 change: 1 addition & 0 deletions packages/generator-volto/news/5437.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reorganize `README.md`, merging content into authoritative locations. Add `awesome_bot` to check links in all READMEs. @stevepiercy
1 change: 1 addition & 0 deletions packages/volto/news/5437.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reorganize `README.md`, merging content into authoritative locations. Add `awesome_bot` to check links in all READMEs. @stevepiercy