Skip to content

Commit 13db642

Browse files
committed
Improve Volto Glosary terms
1 parent 7e6ece2 commit 13db642

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

docs/glossary.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,22 @@ record
129129
Records are basic dictionaries.
130130
131131
Project (Volto)
132-
The product of running `create-volto-app`, a customizable instance of Volto.
132+
The product of running `@plone/generator-volto` package, a customizable instance of Volto.
133133
134134
Add-on (Volto)
135-
A JavaScript package that integrates with Volto's configuration registry.
135+
A JavaScript package that integrates with Volto's configuration registry and is able to enhance, extend and customize it.
136136
137137
Add-on configuration loader (Volto)
138138
A function with signature `config => config`.
139+
It gets the Volto Configuration registry and it must return it back after mutating it.
140+
It is similar to Generic Setup profiles in Plone Backend.
141+
An add-on must provide a default one, that is always loaded when Volto runs.
142+
An add-on can have multiple of them, and they can be loaded optionally from the Volto configuration.
139143
140144
Configuration registry (Volto)
141145
A singleton object modeled using JavaScript modules, accessible from the Volto
142-
project using the `~/config` path.
146+
project by importing `@plone/volto/config` module (`import registry from '@plone/volto/config'`).
147+
It contains the configuration of the Volto app.
143148
144149
Shadowing (Volto)
145150
Webpack provides an "alias" mechanism, where the path for a module can be aliased to another module.
@@ -204,7 +209,7 @@ Scoped packages
204209
Namespace for JavaScript packages, they provide a way to avoid naming conflicts for common package names.
205210
206211
middleware (Redux)
207-
Custom wrappers for the Redux store dispatch methods.
212+
Custom wrappers for the Redux store dispatch methods.
208213
They allow customizing the behavior of the data flow inside the redux store.
209214
210215
hooks (React)
@@ -242,8 +247,8 @@ Markdown
242247
fence
243248
A method to extend basic MyST syntax.
244249
You can define a directive with backticks (`` ` ``) followed by a reStructuredText directive in curly brackets (`{}`), and a matching number of closing backticks.
245-
You can also nest fences by increasing the number of backticks.
246-
250+
You can also nest fences by increasing the number of backticks.
251+
247252
`````md
248253
````{warning}
249254
There be dragons!
@@ -252,7 +257,7 @@ fence
252257
```
253258
````
254259
`````
255-
260+
256261
````{warning}
257262
There be dragons!
258263
```{important}

0 commit comments

Comments
 (0)