Skip to content

Commit

Permalink
- Hyphenate add-on almost everywhere
Browse files Browse the repository at this point in the history
- Fix references
  • Loading branch information
stevepiercy committed Oct 14, 2024
1 parent a16c9ce commit d1b2019
Show file tree
Hide file tree
Showing 16 changed files with 26 additions and 29 deletions.
Binary file added docs/source/_static/plone-home-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/source/addons/how-an-add-on-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ They should be released as "source" packages.

See [@kitconcept/volto-button-block](https://github.com/kitconcept/volto-button-block) as an example.

### Add-on configuration
## Add-on configuration

The default export of your add-on main `index.js` file should be a function with
the signature `config => config`.
Expand Down Expand Up @@ -73,7 +73,7 @@ So the Volto add-on needs to export a default function that receives the Volto c

Volto will chain-execute all the add-on configuration functions to compute the final configuration registry.

```{info}
```{note}
An add-on's default configuration method will always be loaded.
```

Expand All @@ -90,7 +90,7 @@ export default applyConfig;
```

```{seealso}
{doc}`./how-to-load-addon-configuration`
{doc}`how-to-load-add-on-configuration`
```

## Customizations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This chapter describes how you can create a Volto add-on using the latest **deve
{term}`Cookieplone` is now the method to create a Plone add-on with unstable versions of Volto, version 18.0.0-alpha.43 and above.
```

Follow the steps required to install [Cookieplone]({doc}`plone:install/create-project-cookieplone.md`).
Follow the steps required to install Cookieplone as described in {doc}`plone:install/create-project-cookieplone`.

```shell
pipx run cookieplone frontend_addon
Expand Down Expand Up @@ -114,7 +114,7 @@ To install the frontend setup, use the following command.
make install
```

### Start Plone backend Docker container
## Start Plone backend Docker container

In the currently open session, issue the following command.

Expand Down Expand Up @@ -146,7 +146,7 @@ Starting server in PID 1.

This will start a clean Plone server for development purposes so you can start developing your add-on.

### Start Plone development frontend
## Start Plone development frontend

Create a second shell session in a new window.
Change your current working directory to {file}`volto-addon`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,13 @@ you'll have to set your addon package as a "Yarn workspace". You do this by
adding a `workspaces` key to the the `package.json` of your Volto project:

```json
...
"workspaces": ["src/addons/my-volto-addon"],
...
```

It is common practice to use a star glob pattern for the workspaces:

```json
...
"workspaces": ["src/addons/*"],
...
```

If you do this, make sure to always cleanup the `src/addons` folder whenever
Expand Down
File renamed without changes.
39 changes: 20 additions & 19 deletions docs/source/addons/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,26 @@ myst:
:maxdepth: 1
how-an-add-on-works
addon-configuration-pipeline
how-to-install-an-addon-stable
how-to-install-an-addon-prerelease
how-to-install-an-addon-dev-stable
how-to-install-an-addon-dev-prerelease
how-to-load-addon-configuration
how-to-create-an-addon-stable
how-to-create-an-addon-prerelease
how-to-testing-addons
how-to-extend-webpack-addon
how-to-extend-eslint-addon
add-on-configuration-pipeline
how-to-install-an-add-on-stable
how-to-install-an-add-on-prerelease
how-to-install-an-add-on-dev-stable
how-to-install-an-add-on-dev-prerelease
how-to-load-add-on-configuration
how-to-create-an-add-on-stable
how-to-create-an-add-on-prerelease
how-to-test-add-ons
how-to-test-add-ons-prerelease
how-to-extend-webpack-add-on
how-to-extend-eslint-add-on
how-to-troubleshoot-transpilation
i18n
best-practices
theme
public-folder
```

```{include} ./what-is-an-addon.md
```{include} what-is-an-add-on.md
```

## Configuring Volto to use a frontend add-on
Expand All @@ -47,37 +48,37 @@ A development add-on package can be either local to the Plone project or as a re
This is the most common use case, you want to install a Volto add-on that has been released as a in npm registry (or alike).
These are the instructions for the stable release.

{doc}`./how-to-install-an-addon-stable`
{doc}`how-to-install-an-add-on-stable`

### Installing a released add-on (development or pre-release)

These are the instructions for the development or pre-release.

{doc}`./how-to-install-an-addon-prerelease`
{doc}`how-to-install-an-add-on-prerelease`

### Installing an add-on in development mode

It is also usual that you develop an add-on at the same time that you are developing a project.
These are the instructions for the stable release.

{doc}`./how-to-install-an-addon-dev-stable`
{doc}`how-to-install-an-add-on-dev-stable`

### Installing an add-on in development mode (development or pre-release)

{doc}`./how-to-install-an-addon-dev-prerelease`
{doc}`how-to-install-an-add-on-dev-prerelease`

### Loading add-on configuration

Add-ons can provide configuration:

{doc}`./how-to-load-addon-configuration`
{doc}`how-to-load-add-on-configuration`

## Creating add-ons

In case you want to create your own add-on, here you can find the instructions:

{doc}`./how-to-create-an-addon-stable`
{doc}`how-to-create-an-add-on-stable`

### Creating add-ons (development or pre-release)

{doc}`./how-to-create-an-addon-prerelease`
{doc}`how-to-create-an-add-on-prerelease`
File renamed without changes.

0 comments on commit d1b2019

Please sign in to comment.