diff --git a/docs/source/getting-started/install.md b/docs/source/getting-started/install.md index 911f9582f7..cb405dac88 100644 --- a/docs/source/getting-started/install.md +++ b/docs/source/getting-started/install.md @@ -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 diff --git a/docs/source/getting-started/others.md b/docs/source/getting-started/others.md index 4cdb8f4dd2..a0b0ed82c2 100644 --- a/docs/source/getting-started/others.md +++ b/docs/source/getting-started/others.md @@ -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 diff --git a/docs/source/recipes/creating-project.md b/docs/source/recipes/creating-project.md index c577cedd35..03e0bd47b0 100644 --- a/docs/source/recipes/creating-project.md +++ b/docs/source/recipes/creating-project.md @@ -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 @@ -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. diff --git a/news/4728.documentation b/news/4728.documentation new file mode 100644 index 0000000000..c06faf93be --- /dev/null +++ b/news/4728.documentation @@ -0,0 +1 @@ +Synch stuff from `16.x.x` branch that should have been in `master` as well. @stevepiercy