Skip to content

Commit 298002a

Browse files
committed
revise volto_development
1 parent d871fa8 commit 298002a

1 file changed

Lines changed: 18 additions & 15 deletions

File tree

docs/mastering-plone/volto_development.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@ myst:
33
html_meta:
44
"description": "Plone development tools"
55
"property=og:description": "Plone development tools"
6-
"property=og:title": "Plone development"
6+
"property=og:title": "Development tools"
77
"keywords": "Plone, Volto, development, React, Redux"
88
---
99

1010
(volto-development-label)=
1111

12-
# Develop
12+
# Development tools
1313

1414

1515
(editors)=
1616

17-
## IDE: Integrated development environment
17+
## Integrated development environment (IDE)
1818

1919
You are about to write code in Python and React / JavaScript.
2020
An appropriate integrated development environment supports both writing code and accessing our coding base: Plone Python code and JavaScript / React code.
2121

2222
Some of the most used editors in the Plone community are listed here.
2323

2424
- [VSCode](https://code.visualstudio.com/)
25-
- [Sublime](https://www.sublimetext.com/)
2625
- [PyCharm](https://www.jetbrains.com/pycharm/)
26+
- [Sublime](https://www.sublimetext.com/)
2727
- [Wing IDE](https://wingware.com/)
2828

2929
Some features that most editors have in one form or another, are essential when developing with Plone.
@@ -38,8 +38,7 @@ Some features that most editors have in one form or another, are essential when
3838
| git diff | sidebar tab 'source control' |
3939
| file diff | select via sidebar tab 'explorer' |
4040

41-
The capability of performing a _full text search_ through the complete Plone frontend code is invaluable.
42-
Thanks to `omelette` mapping the Volto code in your project, you can search through the complete Plone frontend code base quickly.
41+
The capability of performing a _full text search_ through the complete Plone codebase is invaluable.
4342

4443
IDEs nowadays have plenty of features.
4544
Beyond the existing features, many extensions offer multiple practical features.
@@ -48,33 +47,38 @@ Here are some extensions we recommend when using VSCode:
4847
- `Easy Snippet`: Turn your selection into a snippet.
4948
- `autoDocstring`: Generates python docstrings.
5049
- JSON Crack: Seamlessly visualize JSON data instantly into graphs.
51-
- MyST-Markdown:Oofficial markdown syntax extension for MyST (Markedly Structured Text)
50+
- MyST-Markdown: Official markdown syntax extension for MyST (Markedly Structured Text)
5251
- Plone Snippets
5352
- `EsLint`: Statically analyzes your code to find problems.
5453

5554
Editor support for `ReactJS` development is explained in {doc}`Effective Volto training: VSCode extensions and helpers <training2024:effective-volto/development/vscode>`.
5655

57-
Checkout VSCode documentation for topics like [code navigation](https://code.visualstudio.com/docs/editing/editingevolved), [Keyboard shortcuts and Multiple selections](https://code.visualstudio.com/docs/editing/codebasics) and many more that makes your everyday work easier.
56+
Check VSCode documentation for topics like [code navigation](https://code.visualstudio.com/docs/editing/editingevolved), [Keyboard shortcuts and Multiple selections](https://code.visualstudio.com/docs/editing/codebasics) and many more that make your everyday work easier.
5857

5958

6059
(volto-development-tools-label)=
6160

62-
## Tools
61+
## Browser development tools
6362

64-
### Browser Development Tools
63+
Most browsers have built-in developer tools which can be used to:
6564

66-
React components can be inspected with `React Developer Tools`: props, hierarchy, and a lot more.
65+
- explore the document object model (DOM)
66+
- debug JavaScript code
67+
- inspect styles
68+
- inspect network requests
69+
70+
The **React Developer Tools** add a tab to inspect React components: props, hierarchy, and a lot more.
6771

6872
- [React Developer Tools Chrome](https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi)
6973
- [React Developer Tools Firefox](https://addons.mozilla.org/de/firefox/addon/react-devtools/)
7074

71-
The Redux store and actions can be inspected with `Redux Developer Tools`.
75+
The **Redux Developer Tools** add a tab to inspect the Redux store and actions.
7276

7377
- [Redux Developer Tools Chrome](https://chromewebstore.google.com/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
7478
- [Redux Developer Tools Firefox](https://addons.mozilla.org/de/firefox/addon/reduxdevtools/)
7579

7680

77-
### Postman
81+
## Postman
7882

7983
[Postman](https://www.postman.com/) is an app that lets you execute and save requests.
8084
We will request REST API endpoints of the backend later with actions.
@@ -98,5 +102,4 @@ Just include `{JSON.stringify(var_name_object)}` in your components `html` code.
98102

99103
Select the Python of your project `backend/venv/bin/python`.
100104

101-
In VSCode this can be done by following the menu on selecting the current Python in the bottom of the IDE.
102-
105+
In VSCode this can be done by opening the Python menu at the bottom of the IDE.

0 commit comments

Comments
 (0)