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 13 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
10 changes: 5 additions & 5 deletions docs/source/deploying/pm2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ myst:
"keywords": "Volto, Plone, frontend, React, deployment, PM2"
---

# Deployment using a node process manager (PM2)
# Deployment using a {term}Node.js process manager (PM2)

PM2 is a popular and maintained process manager based in node (https://pm2.keymetrics.io/).
PM2 is a popular and maintained process manager based in {term}Node.js (https://pm2.keymetrics.io/).

```{note}
You can use the good old known supervisord as well. However, the supervisord project is stalled and in low maintenance mode for many years. PM2 is a good alternative, and as you'll see you can manage all kind of processes, not only node ones, including the Plone processes.
```

Create a file `mywebsite.com.pm2.config.js` in your repo or on your server.
Create a file `mywebsite.com.pm2.config.js` in your repository or on your server.

```{important}
Make sure your PM2 config file sufix ends in `config.js`, otherwise PM2 will ignore it.
Expand Down Expand Up @@ -54,8 +54,8 @@ module.exports = {
};
```

- `mywebsite.com-volto` starts the Node process that is responsible for Volto {term}`server-side rendering`.
- `mywebsite.com-api-zeo` starts the ZEO server.
- `mywebsite.com-volto` starts the {term}`Node.js` process that's responsible for Volto {term}`server-side rendering`.
- `mywebsite.com-api-zeo` starts the {term}`ZEO` server.
- `mywebsite.com-api-instance1` starts the first Zope instance.
- `mywebsite.com-api-instance2` starts the second Zope instance.

Expand Down
12 changes: 6 additions & 6 deletions docs/source/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ and suggest you start the API backend using a container.
## Install nvm (NodeJS version manager)

If you have a working Node JavaScript development already set up on your machine or you prefer
another management tool to install/maintain node this step is not needed. If you have less
another management tool to install/maintain Node.js this step is not needed. If you have less
experience with setting up JavaScript, it's a good idea to integrate nvm for development, as
it provides easy access to any NodeJS released version.

Expand Down Expand Up @@ -124,7 +124,7 @@ npm install -g yo

## Yarn (NodeJS package manager)

Install the Yarn Classic version (not the 2.x one!), of the popular node package manager.
Install the Yarn Classic version (not the 2.x one!), of the popular Node.js package manager.

1. Open a terminal and type:

Expand Down Expand Up @@ -206,7 +206,7 @@ execute `docker run` will be use to persist the backend server data.

If you are somewhat familiar with Python development, you can also install Plone locally
without using Docker. Check the [backend configuration](../configuration/backend.md) section.
It also has more information on plone.volto.
It also has more information on `plone.volto`.


(frontend-getting-started-install-volto-label)=
Expand Down Expand Up @@ -266,7 +266,7 @@ You may choose to install the canary version, which is the latest alpha release,
## Build the production bundle

In production environments, you should build an static version of your (Volto) app. The
app should be run in a node process (because of the {term}`server-side rendering`
app should be run in a Node.js process (because of the {term}`server-side rendering`
part), but it also have a client part that is provided and deployed by the server
side rendering process.

Expand All @@ -277,12 +277,12 @@ side rendering process.
```
The resultant build is available in the `build` folder.

2. Run the Volto Nodejs process
2. Run the Volto Node.js process
```bash
yarn start:prod
```

to run the node process with the production build. You can also run it manually:
to run the Node.js process with the production build. You can also run it manually:

```bash
NODE_ENV=production node build/server.js
Expand Down
12 changes: 6 additions & 6 deletions docs/source/getting-started/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ complete and accurate picture of the Volto framework.

## The foundation

As is the case with similar modern Javascript-based applications, you should know:
As is the case with similar modern JavaScript-based applications, you should know:

- Modern Javascript development. Volto uses next-generation Javascript. Follow
- Modern JavaScript development. Volto uses next-generation JavaScript. Follow
the [ES6 guide](https://flaviocopes.com/es6/) to get up to speed.
- React knowledge - [basic level is
fine](https://react.dev/learn/tutorial-tic-tac-toe) for the beginning, you'll progress
along the way. React itself is a simple and well documented framework.
- A basic understanding of Javascript
- A basic understanding of JavaScript
[CommonJS](https://flaviocopes.com/commonjs/),
[NPM packages](https://flaviocopes.com/npm/),
[npm packages](https://flaviocopes.com/npm/),
[Yarn](https://flaviocopes.com/yarn/),
[Babel](https://flaviocopes.com/babel/) and
[Webpack](https://flaviocopes.com/webpack/).
Expand All @@ -42,7 +42,7 @@ As is the case with similar modern Javascript-based applications, you should kno
Once you've bootstrapped your Volto project you can already start hacking. Some
of the things you can do at this stage:

- Configure your text editor for Javascript and Volto development
- Configure your text editor for JavaScript and Volto development
- Volto project-based development
- Understand and debug React errors
- Understand React component lifecycle
Expand All @@ -63,7 +63,7 @@ can be really productive.

- Write new Redux actions and reducers
- Create new views for Plone content.
- Install and integrate new Javascript libraries or third-party React
- Install and integrate new JavaScript libraries or third-party React
components
- Create a new Volto addon
- Integrate addon LESS with Volto's theme variables
Expand Down
1 change: 1 addition & 0 deletions news/1190.internal
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improved spellcheck to keep spellings consistent. @chirayu-humar
11 changes: 9 additions & 2 deletions styles/Vocab/Plone/accept.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
`plone.restapi`
`plone.volto`
[Aa]sync
[Bb]ackend
JavaScript
Node.js
Node\.js
Node.js®
npm
nvm
Pastanaga
Plone
Razzle
RichText
Volto
Vue
Zope
JavaScript
NodeJS
13 changes: 9 additions & 4 deletions styles/Vocab/Plone/reject.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
node
nodejs
api
Javascript
javascript
js
Javascript
[^.]js
node
[Nn]odejs
NPM
plone
razzle
volto