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

Tidy up from synch with 16.x.x #4728

Merged
merged 3 commits into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 17 additions & 4 deletions docs/source/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,15 +219,28 @@ You may choose to install the canary version, which is the latest alpha release,

1. Open a terminal and execute:

```bash
```shell
npm install -g yo @plone/generator-volto
# install latest stable release
yo @plone/volto
# or install latest alpha release
yo @plone/volto --canary
```

See the [Creating a project](../recipes/creating-project) page for more
advanced options that can be passed to the generator.
See {doc}`../recipes/creating-project` for more advanced options that can be passed to the generator.

2. Answer the questions when prompted, and provide the name of the new app (folder) to be created.
For the sake of this documentation, provide `myvoltoproject` as the project name.

````{note}
You can run the generator with parameters to tailor your requirements.

```shell
yo @plone/volto --help
```

2. Answer the questions when prompted, and provide the name of the new app (folder) to be created. For the sake of this documentation, provide `myvoltoproject` as the project name.
or take a look at the [README](https://github.com/plone/volto/blob/master/packages/generator-volto/README.md) for more information.
````

3. Change directory to the newly created folder `myvoltoapp` (or the one you've chosen):
```bash
Expand Down
3 changes: 1 addition & 2 deletions docs/source/getting-started/others.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ You can watch the talk during the World Plone Day 2021:

## Presentations at Plone Conferences (PloneConf) and other events

In recent years the react based Volto frontend for Plone has been presented in more and more talks at
our yearly Conferences:
In recent years the React based Volto frontend for Plone has been presented in more and more talks at our yearly Conferences.

### PloneConf 2022

Expand Down
5 changes: 3 additions & 2 deletions docs/source/recipes/creating-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In addition to bootstrapping stand-alone Volto projects, it can also bootstrap V

1. Open a terminal and execute:

```bash
```shell
npm install -g yo @plone/generator-volto
# Install the latest and stable release of Volto with the following command
yo @plone/volto
Expand All @@ -29,7 +29,8 @@ In addition to bootstrapping stand-alone Volto projects, it can also bootstrap V
yo @plone/volto --addon=volto-form-block
```

2. Answer the questions when prompted, and provide the name of the new app (folder) to be created. For the sake of this documentation, provide `myvoltoproject` as the project name then.
2. Answer the questions when prompted, and provide the name of the new app (folder) to be created.
For the sake of this documentation, provide `myvoltoproject` as the project name then.

````{note}
You can run the generator with parameters to tailor your requirements.
Expand Down
1 change: 1 addition & 0 deletions news/4728.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Synch stuff from `16.x.x` branch that should have been in `master` as well. @stevepiercy