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

improved spellcheck #5056

Merged
merged 27 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
12ae81b
improved spellcheck
chirayu-humar Aug 4, 2023
a1296b6
made some updations with correct sollution for review
chirayu-humar Aug 5, 2023
9b0e42c
arranged accept.txt & reject.txt in alphabetically, reverted previous…
chirayu-humar Aug 6, 2023
0ee57d5
some errors resolved related to spellcheck
chirayu-humar Aug 6, 2023
3d6461e
Merge remote-tracking branch 'upstream/master' into spell-check-update
chirayu-humar Aug 7, 2023
2b8732f
made some required changes
chirayu-humar Aug 7, 2023
0c2f309
changed the left chages
chirayu-humar Aug 8, 2023
c4136b0
Fix errors from Vale.
stevepiercy Aug 8, 2023
256c5f7
Sort
stevepiercy Aug 8, 2023
9cd46e3
Sort
stevepiercy Aug 8, 2023
6f06daa
Resolve some Vale issues
stevepiercy Aug 8, 2023
8a15170
Sort correctly
stevepiercy Aug 8, 2023
ca93d24
implemented chages suggested vale maintainer
chirayu-humar Aug 9, 2023
dfd8d9a
Merge remote-tracking branch 'upstream/master' into spell-check-update
chirayu-humar Aug 11, 2023
26ecf9e
Correct all instances of Node.js, not just in a few files, and set pr…
stevepiercy Aug 13, 2023
cd08395
Fix misspellings, grammar, syntax
stevepiercy Aug 13, 2023
6c4f1f1
Fix JavaScript misspellings
stevepiercy Aug 13, 2023
9ba3a2b
Fix API misspellings
stevepiercy Aug 13, 2023
c776c48
Fix misspellings of Plone and its `plone.*` packages
stevepiercy Aug 13, 2023
a2c061b
Fix misspellings of npm
stevepiercy Aug 13, 2023
6b0d60f
Fix misspelling of transformers
stevepiercy Aug 13, 2023
f6610c5
Fix MyST syntax
stevepiercy Aug 13, 2023
4ac113c
Fix English grammar
stevepiercy Aug 13, 2023
cf34a70
Fix misspellings of Razzle with bonus grammar fixes
stevepiercy Aug 13, 2023
cda4121
Fix misspellings of Sass
stevepiercy Aug 13, 2023
3d78d43
Fix misspellings of Volto and `volto-*` packages
stevepiercy Aug 13, 2023
81f68c5
Merge branch 'master' into spell-check-update
stevepiercy Aug 13, 2023
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
12 changes: 6 additions & 6 deletions docs/source/addons/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,15 @@ hold the Cypress integration tests and trigger the CI tests.
If you're releasing your add-on to `npmjs.com`, please consider adding the
following tags, next to your add-on-specific tags:

- volto-addon
- volto
- plone
- react
- `volto-addon`
- `volto`
- `plone`
- `react`

## Include in collective/awesome-volto
## Include in `collective/awesome-volto`

Even if you think your add-on is not generic or it's tricky to integrate, please
consider including your add-on in the
[collective/awesome-volto](https://github.com/collective/awesome-volto) add-ons
[`collective/awesome-volto`](https://github.com/collective/awesome-volto) add-ons
list. This provides visibility to your add-on but also further solidifies
Volto's possition in our Plone community.
12 changes: 6 additions & 6 deletions docs/source/addons/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ by Babel), whole-process customization via razzle.extend.js and
integration with Volto's {term}`configuration registry`.
```

The add-on can be published to an NPM registry or directly installed from github
The add-on can be published to an npm registry or directly installed from github
by Yarn. By using [mrs-develop](https://github.com/collective/mrs-developer),
it's possible to have a workflow similar to zc.buildout's mr.developer, where
you can "checkout" an add-on for development.
Expand All @@ -56,7 +56,7 @@ You can install a Volto add-on just like any other JS package:
yarn add name-of-add-on
```

If the add-on is not published on NPM, you can retrieve it directly from Github:
If the add-on is not published on npm, you can retrieve it directly from Github:

```shell
yarn add collective/volto-dropdownmenu
Expand All @@ -74,7 +74,7 @@ configurations methods, making it possible to selectively choose which specific
add-on functionality you want to load.

In your Volto project's ``package.json`` you can allow the add-on to alter the
global configuration by adding, in the `addons` key, a list of volto add-on
global configuration by adding, in the `addons` key, a list of Volto add-on
package names, like:

```js
Expand Down Expand Up @@ -439,9 +439,9 @@ in your add-on's `addons` key, just like you do in your project. By doing so,
that other add-on's configuration loader is executed first, so you can depend on
the configuration being already applied. Another benefit is that you'll have
to declare only the "top level" add-on in your project, the dependencies will be
discovered and automatically treated as Volto add-ons. For example, volto-slate
depends on volto-object-widget's configuration being already applied, so
volto-slate can declare in its `package.json`:
discovered and automatically treated as Volto add-ons. For example, `volto-slate`
depends on `volto-object-widget`'s configuration being already applied, so
`volto-slate` can declare in its `package.json`:

```json
{
Expand Down
4 changes: 2 additions & 2 deletions docs/source/backend/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Search and indexing integration
Access to images and files are a special use case in Volto.
Usually in plain HTML, `src` and `href` attributes resource calls cannot be wrapped in a JavaScript backend call.
This is problematic when dealing with protected resources that need the user to be authenticated to access them.
For this reason, these resources are rerouted through an internal route in Node Express server and wrapped with the proper authentication headers.
For this reason, these resources are rerouted through an internal route in the Node.js Express server and wrapped with the proper authentication headers.

These proxied backend routes are in place for accessing URLs containing `@@downloads` `@@display-file`, and `@@images` backend views.
These are the backend `BrowserView`s routes that retrieve images and file resources.
Thus the Node Express server takes care of proxying and enhancing them at the same time as the authentication headers.
Thus the Node.js Express server takes care of proxying and enhancing them at the same time as the authentication headers.

```{todo}
This section contains pointers for backend integration with Plone.
Expand Down
52 changes: 26 additions & 26 deletions docs/source/blocks/editcomponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The sidebar and the object browser are the main ones.

## Sidebar

We can use the new sidebar when building our blocks' edit components.
We can use the new sidebar when building our block's edit components.
The sidebar is a new UI asset that is available in Volto 4.
You need to instantiate it this way:

Expand Down Expand Up @@ -195,19 +195,19 @@ this.props.openObjectBrowser({

This widget shows an objectBrowser to find content/contents on site.

It is the default widget for vocabulary fields that uses plone.app.vocabularies.Catalog.
It is the default widget for vocabulary fields that uses `plone.app.vocabularies.Catalog`.

It works in 3 different mode:

- **image**: The field value is an object.
The path of selected item is saved in 'url' property of value object. (fieldName: {url:''})
- **link**: The field value is an object.
The path of selected item is saved in 'href' property of value object. (fieldName: {href:''})
- **multiple**: The field value is an array of objects.
- `image`: The field value is an object.
The path of selected item is saved in `url` property of value object. (`fieldName: {url:''}`)
- `link`: The field value is an object.
The path of selected item is saved in `href` property of value object. (`fieldName: {href:''}`)
- `multiple`: The field value is an array of objects.

#### `return` prop

The object widget returns always an array, even if it's meant to have only one object in return. In order to fix that situation and do not issue a breaking change, a `return` prop is being introduced, so if it's value is `single`, then it returns a single value:
The object widget returns always an array, even if it's meant to have only one object in return. In order to fix that situation and do not issue a breaking change, a `return` prop is being introduced, so if its value is `single`, then it returns a single value:

```js
export const Image = () => <ObjectBrowserWidget mode="image" return="single" />;
Expand All @@ -219,8 +219,8 @@ This situation will be fixed in subsequent Volto releases.

#### PropDataName vs dataName

- **dataName** is the prop inside _data_ object, used for _link_ and _image_ mode.
- **PropDataName** is the name of field wich value is _data_. It's used for _multiple_ mode.
- `dataName` is the prop inside `data` object, used for `link` and `image` mode.
- `PropDataName` is the name of field wich value is `data`. It's used for `multiple` mode.

For example:

Expand All @@ -230,9 +230,9 @@ content:{ '@id': 'page-1', related_pages:[], image:{url:""}, link:{href:""} }

if we use object browser widget for fields:

- **related_pages**: propDataName is _related_pages_ and dataName is null,
- **image**: dataName is _url_ and propDataName is null
- **link**: dataName is _href_ and propDataName is null
- `related_pages`: propDataName is `related_pages` and `dataName` is `null`.
- `image`: dataName is `url` and `propDataName` is `null`.
- `link`: dataName is `href` and `propDataName` is `null`.

#### Usage in blocks schema

Expand Down Expand Up @@ -273,7 +273,7 @@ tokenized value, as if it was selected via the Object Browser widget.

#### ObjectBrowserWidgetMode()

Returns the component widget with _mode_ passed as argument.
Returns the component widget with `mode` passed as argument.

The default mode for ObjectBrowserWidget is multiple. If you would like to use this widget with link or image mode as widget field for a specific field id (for example), you could specify in in config.js as:

Expand All @@ -299,7 +299,7 @@ If `selectableTypes` is set in `widgetOptions.pattern_options`, then only items
<ObjectBrowserWidget ... widgetOptions={{pattern_options:{selectableTypes:['News Item','Event']}}}>
```

You can also set the _selectableTypes_ from plone when declaring a field for contenttype:
You can also set the `selectableTypes` from `plone` when declaring a field for `contenttype`:

```jsx
form.widget(
Expand All @@ -313,15 +313,15 @@ form.widget(
);
```

#### MaximumSelectionSize
#### `maximumSelectionSize`

If **maximumSelectionSize** is set in _widgetOptions.pattern_options_, widget allows to select at most the **maximumSelectionSize** number of items defined in _widgetOptions.pattern_options.maximumSelectionSize_.
If `maximumSelectionSize` is set in `widgetOptions.pattern_options`, the widget allows to select at most the `maximumSelectionSize` number of items defined in `widgetOptions.pattern_options.maximumSelectionSize`.

```jsx
<ObjectBrowserWidget ... widgetOptions={{pattern_options:{maximumSelectionSize:2}}}>
```

You can also set the _maximumSelectionSize_ from plone when declaring a field for contenttype:
You can also set the `maximumSelectionSize` from `plone` when declaring a field for `contenttype`:

```jsx
form.widget(
Expand Down Expand Up @@ -429,15 +429,15 @@ class Example extends Component {

The current block engine is available as the separate `BlocksForm` component,
used to be a part of the `Form.jsx` component. It has been previously exposed
as the [@eeacms/volto-blocks-form](https://github.com/eea/volto-blocks-form)
as the [`@eeacms/volto-blocks-form`](https://github.com/eea/volto-blocks-form)
addon and reused in several other addons, so you can find integration examples
in addons such as
[volto-columns-block](https://github.com/eea/volto-columns-block),
[volto-accordion-block](https://github.com/rohberg/volto-accordion-block),
[@eeacms/volto-accordion-block](https://github.com/eea/volto-accordion-block),
[@eeacms/volto-grid-block](https://github.com/eea/volto-accordion-block), but
[`volto-columns-block`](https://github.com/eea/volto-columns-block),
[`volto-accordion-block`](https://github.com/rohberg/volto-accordion-block),
[`@eeacms/volto-accordion-block`](https://github.com/eea/volto-accordion-block),
[`@eeacms/volto-grid-block`](https://github.com/eea/volto-accordion-block), but
probably the simplest implementation to follow is in the
[@eeacms/volto-group-block](https://github.com/eea/volto-group-block)
[`@eeacms/volto-group-block`](https://github.com/eea/volto-group-block)

Notice that the `BlocksForm` component allows overriding the edit block
wrapper and allows passing a custom `blocksConfig` configuration object, for
Expand Down Expand Up @@ -507,6 +507,6 @@ You can also reuse the DragDropList component as a separate component:
</DragDropList>
```

Check the source code of volto-columns-block and
[volto-taxonomy](https://github.com/eea/volto-taxonomy/) for details on
Check the source code of `volto-columns-block` and
[`volto-taxonomy`](https://github.com/eea/volto-taxonomy/) for details on
how to reuse this component.
2 changes: 1 addition & 1 deletion docs/source/configuration/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ myst:

# Backend configuration

## plone.volto
## `plone.volto`
In order to fully support all Volto features, the Plone backend content API needs to be prepared for Volto. The add-on `plone.volto` does all the heavy lifting for you and is ready to use in your own projects. We used it in our Getting Started section.

This package is slightly opinionated but provides the correct default settings for when
Expand Down
2 changes: 1 addition & 1 deletion docs/source/configuration/environmentvariables.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ As a result, your app will load the add-ons in the following order:
- `volto-slate`

```{important}
The `ADDONS` key is a Volto specific configuration. Simply setting `ADDONS` doesn't download the javascript package. This has to be covered by another way, either installing the addon package (with yarn add) or loading it as a development package with mrs-developer.
The `ADDONS` key is a Volto specific configuration. Simply setting `ADDONS` doesn't download the JavaScript package. This has to be covered by another way, either installing the addon package (with yarn add) or loading it as a development package with mrs-developer.
```

## BUILD_DIR
Expand Down
2 changes: 1 addition & 1 deletion docs/source/configuration/expanders.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Configure the API expanders in Volto using the `settings.apiExpanders`"
"property=og:description": "Configure the API expanders in Volto using the `settings.apiExpanders`"
"property=og:title": "API expanders"
"keywords": "Volto, Plone, frontend, React, api expanders"
"keywords": "Volto, Plone, frontend, React, API expanders"
---

# API expanders
Expand Down
19 changes: 10 additions & 9 deletions docs/source/configuration/internalproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ develop/test drive/demo Volto.

To understand the need for the internal proxy, there are three processes running in a Volto website:

1. A frontend web application running in your browser (Javascript)
2. A Node.js server process that delivers the javascript to the client and does
{term}`server-side rendering` (SSR) of your pages on first request (Javascript, the
1. A frontend web application running in your browser (JavaScript)
2. A Node.js server process that delivers the JavaScript to the client and does
{term}`server-side rendering` (SSR) of your pages on first request (JavaScript, the
Razzle package is used for SSR)
3. A Plone server process that stores and delivers all content through a REST API (Python)

Expand All @@ -30,16 +30,16 @@ The default values from Volto configuration expect a Plone content backend locat

What happens in the default development configuration/setup:

* The client side Volto javascript files precooked HTML (SSR) is served from http://localhost:3000/ by the NodeJS server process
* The client javascript does API requests for content and other data on the same url at http://localhost:3000/++api++/
* The NodeJS service its internal proxy requests the data from the Plone content backend api and delivers
* The client side Volto JavaScript files precooked HTML (SSR) is served from http://localhost:3000/ by the Node.js server process
* The client JavaScript does API requests for content and other data on the same url at http://localhost:3000/++api++/
* The Node.js service its internal proxy requests the data from the Plone content backend API and delivers
back json to the frontend.
* The web browser application is happy, because all connections go through the same URL and no CORS related security issues will be triggered.

```{tip}
You could also use the internal proxy for production setups. For convenience and for
testing/demoing using the stock build, it is also enabled in production mode since
Volto 14. But it is bad for performance because the server side running Node process
Volto 14. But it is bad for performance because the server side running Node.js process
is also responsable for generating the SSR HTML. With nginx, Apache or another
'reverse proxy' you can also create an internal API mount which is more suited for
that. For more deployment information see {doc}`../deploying/seamless-mode`.
Expand All @@ -59,12 +59,13 @@ export const settings = {
```

or use the environment variable:

```bash
RAZZLE_DEV_PROXY_API_PATH=http://localhost:8081/mysite yarn start
```

This redefines the request path from the internal proxy of the server side Node proces to the Plone content backend API, but leaves the frontend Volto process making all content requests to http://localhost:3000/++api++/
This redefines the request path from the internal proxy of the server side Node.js process to the Plone content backend API, but leaves the frontend Volto process making all content requests to `http://localhost:3000/++api++/`.

### Advanced usage

See [](../recipes/environment-variables.md) for recipes on internal proxy usage.
See {doc}`../recipes/environment-variables` for recipes for internal proxy usage.
2 changes: 1 addition & 1 deletion docs/source/configuration/multilingual.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ myst:
# Multilingual

Volto provide support for Plone's Multilingual feature. You need to install Multiligual
support in Plone (plone.app.multilingual add-on), that comes available by default since
support in Plone (`plone.app.multilingual` add-on), that comes available by default since
Plone 5 and can be installed in Plone's control panel.

## Volto configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/source/configuration/volto-slate/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The {term}`elementEditor` is a top-level wrapper of all plugins used in `volto-s
It consists of various modules:

`makeInlineElementPlugin`
: Used to build and install a custom schema based plugin from volto-slate API.
: Used to build and install a custom schema based plugin from `volto-slate` API.
It expects a set of options passed as a property to your plugin.

`PluginEditor`
Expand Down
10 changes: 6 additions & 4 deletions docs/source/configuration/zero-config-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ This feature is available since Volto 13.
```

In the past (before Volto 13), Volto was configured in build time using several
environment vars, commonly supplied via the command line, like:
environment variables, commonly supplied via the command line, such as the following:

`PORT=11001 RAZZLE_API_PATH=https://plone.org/api yarn build`
```shell
PORT=11001 RAZZLE_API_PATH=https://plone.org/api yarn build`
```

and since RAZZLE is a isomorphic app, some of these values passed on build time, were
hardcoded in the code because the code in client and server need to know them upfront to
and since Razzle is an isomorphic application, some of these values passed on build time, were
hardcoded in the code because the code in client and server need to know them up front to
in order to work.

Volto 13 has several new features that allows zero configuration on build time, using
Expand Down
8 changes: 4 additions & 4 deletions docs/source/contributing/language-features.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
myst:
html_meta:
"description": "Volto is developed using Babel to transpile modern Javascript to Javascript that browsers are able to understand and execute."
"property=og:description": "Volto is developed using Babel to transpile modern Javascript to Javascript that browsers are able to understand and execute."
"description": "Volto is developed using Babel to transpile modern JavaScript to JavaScript that browsers are able to understand and execute."
"property=og:description": "Volto is developed using Babel to transpile modern JavaScript to JavaScript that browsers are able to understand and execute."
"property=og:title": "Language features and conventions"
"keywords": "Volto, Plone, frontend, React, Babel, translations, language, internationalization, i18n, localization, transpilation"
---
Expand All @@ -11,15 +11,15 @@ myst:

## Babel

Volto is developed using Babel to transpile modern Javascript to Javascript that
Volto is developed using Babel to transpile modern JavaScript to JavaScript that
browsers are able to understand and execute.

Ecma International's TC39 (https://tc39.es/) is a group of JavaScript developers,
implementers, academics, and more, collaborating with the community to maintain and
evolve the definition of JavaScript. They stablished a process
(https://tc39.es/process-document/) where the proposals are discussed, developed, and
eventually approved (or dropped). The process has five stages (0 to 4) where reaching
the stage 4 means the proposal is accepted and it becomes part of the Javascript
the stage 4 means the proposal is accepted and it becomes part of the JavaScript
specification.

Babel enables a series of features and syntax that the developer can use in code to
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contributing/linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ gaps!
```

Volto developers can enjoy a lot of freedom in their choice of text editors and
IDEs, thanks to the strong tooling provided by the Javascript ecosystem.
IDEs, thanks to the strong tooling provided by the JavaScript ecosystem.

At the core of these capabilities is ESLint, the advanced javascript linting
At the core of these capabilities is ESLint, the advanced JavaScript linting
and formatting tool. Also included with Volto is integration with Stylelint and
Prettier.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/redux.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Creating a "request action" potentially triggers some additional access. For
example, even if we only declare the `GET_CONTENT` type of action, we can see
that `GET_CONTENT_SUCCESS`, `GET_CONTENT_PENDING` and `GET_CONTENT_FAIL` are
also used in the `content` reducer. They are automatically created by the
special Api middleware, available in `src/middleware/api.js`.
special API middleware, available in `src/middleware/api.js`.

## Customizing the Redux middleware

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/volto-core-addons.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Volto Core add-ons
# Volto core add-ons

Volto has the concept of "core add-ons".
They are add-ons that are always installed in Volto.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/deploying/apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ myst:

# Apache

Apache configuration for a Plone backend deployed under /api and a Volto frontend deployed under the root "/". This configuration also redirects http -> https:
Apache configuration for a Plone backend deployed under `/api` and a Volto frontend deployed under the root `/`.
This configuration also redirects `http` -> `https`.

```apache
<Proxy balancer://plonebackend>
Expand Down