Skip to content

Commit

Permalink
remove some chapters,fix grammer
Browse files Browse the repository at this point in the history
  • Loading branch information
nileshgulia1 committed Nov 2, 2024
1 parent 3f214f7 commit f044b3a
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 837 deletions.
594 changes: 0 additions & 594 deletions docs/volto_customization/extending_teasers.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/volto_customization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ schema
teaser_variations
data_adapters
styling
extending_teasers
listing_block
```

Expand Down
10 changes: 3 additions & 7 deletions docs/volto_customization/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ They assume you have a macOS/Linux machine.

### Python

Installing Python is beyond the scope of this documentation. However, it is recommended to use a Python version manager, pyenv, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
Installing Python is beyond the scope of this training. However, it is recommended to use a Python version manager, pyenv, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.

Plone requires Python version 3.8, 3.9, 3.10, 3.11, or 3.12.

Expand Down Expand Up @@ -81,10 +81,10 @@ To bootstrap a new Plone project(with both backend and frontend), you can use [C
You can use pipx to run cookieplone (<a target="_blank" href="https://6.docs.plone.org/install/create-project-cookieplone.html#generate-the-project">see instructions for installation</a>):
```shell
pipx run cookieplone tutorial-project
pipx run cookieplone project
```
You will be presented with a series of prompts. You can also specify the addons you want to install along with the project. You can type `volto-teaser-tutorial` when prompted for the addons.
You will be presented with a series of prompts. You can also specify the addons you want to install along with the project. You can type the name of the project as `tutorial-project` and name of the addon as `volto-teaser-tutorial` when prompted for the addons.
```shell
[11/17] Volto Addon Name (volto-project-title): volto-teaser-tutorial
Expand All @@ -93,10 +93,6 @@ You will be presented with a series of prompts. You can also specify the addons
You can accept the rest of the default values in square brackets (`[default-option]`) by hitting the {kbd}`Enter` key, or enter your preferred values.
For the training, we will use the default values for the rest of the prompts.
```{tip}
See the cookiecutter's README for how to [Use options to avoid prompts](https://github.com/collective/cookieplone/?tab=readme-ov-file#use-options-to-avoid-prompts).
```

## Install the project
To work on your project, you need to install both the frontend and backend.
Expand Down
227 changes: 0 additions & 227 deletions docs/volto_customization/listing_block.md

This file was deleted.

14 changes: 10 additions & 4 deletions docs/volto_customization/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,14 @@ const TeaserBlockImageDefault = (props) => {
: null
}
>
<div className="teaser-item default">
<div
className="teaser-item default"
style={{
display: "flex",
flexDirection: "column",
alignItems: "center",
}}
>
{(href.hasPreviewImage || href.image_field || image) && (
<div className="image-wrapper">
<Image
Expand Down Expand Up @@ -177,9 +184,8 @@ export default TeaserBlockImageDefault;
```
After this you will be able to choose variations for this block from the Blocks Settings sidebar.
Right now this variation only shows default variation of Teaser block.
You could decide to modify the template here already though.
In the coming chapter we are gonna enhance this variation with extension per teaser.
Right now this variation only shows image top variation of Teaser block.
You could decide to modify the template here in any way though.
```{note}
The <a target="blank" href="https://github.com/plone/volto/blob/9667cf735e5c3e848de852d615941d98193e0a5e/src/components/manage/Blocks/Teaser/Body.jsx#L13">Body</a> component in Teaser block also supports adding variations from component registry. You can read more about component registry in following chapters.
Expand Down
2 changes: 1 addition & 1 deletion docs/volto_customization/shadowing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For example when we customize the News Item View instead of adding the override

we add it as

`src/addon/volto-teaser-tutorial/src/customizations/volto/components/theme/View/NewsItemView.jsx`.
`packages/volto-teaser-tutorial/src/customizations/volto/components/theme/View/NewsItemView.jsx`.

Both paths work fine though, we just want to go all-in with the addon-approach.

Expand Down
9 changes: 8 additions & 1 deletion docs/volto_customization/teaser_variations.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,14 @@ const TeaserBlockImageDefault = (props) => {
: null
}
>
<div className="teaser-item default">
<div
className="teaser-item default"
style={{
display: "flex",
flexDirection: "column",
alignItems: "center",
}}
>
{(href.hasPreviewImage || href.image_field || image) && (
<div className="image-wrapper">
<Image
Expand Down
2 changes: 1 addition & 1 deletion docs/volto_customization/voltosettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Here are some more setting you might use in your projects:
- `maxFileUploadSize` - Limit the size of uploads
- `nonContentRoutes` - A list of path strings which are considered to be outside of plone-restapi's content serialization. For example: `/controlpanel, /login,/sitemap,/personal-information` are all nonContentRoutes.

You can find all existing options in the file <a target="_blank" href="https://github.com/plone/volto/blob/main/packages/volto/src/config/index.js#L73">config/index.js</a> of Volto itself which is available in your projects in `frontend/omelette/src/config/index.js`.
You can find all existing options in the file <a target="_blank" href="https://github.com/plone/volto/blob/main/packages/volto/src/config/index.js#L73">config/index.js</a> of Volto itself which is available in your projects in `frontend/core/packages/volto/src/config/index.js`.

```{seealso}
Many options are explained in the {doc}`plone6docs:volto/configuration/settings-reference`
Expand Down

0 comments on commit f044b3a

Please sign in to comment.