Skip to content

Commit

Permalink
more reorg
Browse files Browse the repository at this point in the history
  • Loading branch information
davisagli committed Oct 7, 2023
1 parent 4d768e6 commit 0b69901
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 368 deletions.
54 changes: 8 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ You can try a Volto online demo at [https://6.demo.plone.org/](https://6.demo.pl

To start a new project using Volto, follow the [Plone installation documentation](https://6.docs.plone.org/install/install-from-packages.html).

## Documentation

You can find the latest documentation at [https://6.docs.plone.org/](https://6.docs.plone.org/volto/index.html)

For links to trainings and videos, see [Other learning resources](https://6.docs.plone.org/volto/getting-started/others.html).

## Supported Node.js versions

Volto runs using [Node.js](https://nodejs.org/).
Expand Down Expand Up @@ -80,6 +86,7 @@ On Plone 5, Volto is currently tested with the following packages pinned to spec
- plone.rest 2.0.0
- plone.volto 4.0.3


## Volto in Production

Volto is actively developed since 2017 and used in production since 2018 on the following websites:
Expand Down Expand Up @@ -133,54 +140,9 @@ Volto is actively developed since 2017 and used in production since 2018 on the

Please create a new [issue](https://github.com/plone/volto/issues/new) or [pull request](https://github.com/plone/volto/pulls) to add your Volto-site here!

## Documentation

You can find the latest documentation at [https://6.docs.plone.org/](https://6.docs.plone.org/volto/index.html)

## Training

On the [Plone Training website](https://training.plone.org), you'll find Volto-dedicated training materials, plus other JavaScript-centered trainings.

- [Mastering Plone 6 Development](https://training.plone.org/mastering-plone/)
The comprehensive training on Plone 6 with best practice tips for developers and integrators.
- [Volto Hands-On](https://training.plone.org/voltohandson/index.html)
- [Volto Add-ons Development](https://training.plone.org/voltoaddons/index.html)
- [Effective Volto](https://training.plone.org/effective-volto/index.html)
- [Plone Deployment](https://training.plone.org/plone-deployment/index.html)
- [Volto](https://2022.training.plone.org/volto/index.html) (archived)
- [JavaScript For Plone Developers](https://2022.training.plone.org/javascript/index.html) (archived)

## Talks

### Plone Conference Ferrara 2019

[Víctor Fernández de Alba - Plone Beyond 2020: Jump into Volto today!](https://www.youtube.com/watch?v=8QrGOgXo1Js&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=16&t=0s)

[Rob Gietema - How to create your own Volto site!](https://www.youtube.com/watch?v=3QLN8tsjjf4&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=11&t=0s)

[Timo Stollenwerk - On the Road - Plone 6 and Beyond](https://www.youtube.com/watch?v=suXVdfYV2kA&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=14&t=0s)

[Rodrigo Ferreira de Souza - Data migration to Plone 5.2 and Volto](https://www.youtube.com/watch?v=kb9SEsnllqE&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=49&t=0s)

[Nicola Zambello - A Volto story: building a website by prototyping](https://www.youtube.com/watch?v=xtxJURICkWc&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=17&t=0s)

[Luca Pisani - Plone and React.js: An interview to Volto](https://www.youtube.com/watch?v=JZFUOG843no&list=PLGN9BI-OAQkQD9HliElIk9pe-8O_Y6S04&index=26&t=0s)

### Plone Conference Tokyo 2018

[Rob Gietema - Volto](https://2018.ploneconf.org/talks/plone-react)

[Rob Gietema / Víctor Fernández de Alba - Volto Extensibility Story](https://2018.ploneconf.org/talks/plone-react-extensibility-story)

[Víctor Fernández de Alba - Theming Volto](https://2018.ploneconf.org/talks/theming-plone-react)

[Timo Stollenwerk / Víctor Fernández de Alba / Ramon Navarro - Volto Case Studies](https://2018.ploneconf.org/talks/plone-react-case-studies-when-stability-and-security-meet-speed-and-a-modern-user-interface)

[Timo Stollenwerk - Reinventing Plone, Roadmap to the Modern Web](https://2018.ploneconf.org/talks/reinventing-plone-roadmap-to-the-modern-web)

## Contributing to Volto

If you would like to contribute to the Volto project by writing code, documentation, translations, etc., please read [Contributing to Plone](https://6.docs.plone.org/contributing/index.html) and [Contributing to Volto](https://6.docs.plone.org/volto/contributing/index.html).
To contribute to the Volto project by writing code, documentation, translations, etc., please read [Contributing to Plone](https://6.docs.plone.org/contributing/index.html) and [Contributing to Volto](https://6.docs.plone.org/volto/contributing/index.html).

## Contributors

Expand Down
15 changes: 10 additions & 5 deletions docs/source/backend/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,13 @@ These proxied backend routes are in place for accessing URLs containing `@@downl
These are the backend `BrowserView`s routes that retrieve images and file resources.
Thus the Node.js Express server takes care of proxying and enhancing them at the same time as the authentication headers.

```{todo}
This section contains pointers for backend integration with Plone.
Contributions for the Guillotina backend are needed.
See https://github.com/plone/volto/issues/4430
```
## Alternative backends

Volto can also be used with other backend systems if they provide an API that is compatible with `plone.restapi`.

[Nick](https://nickcms.org/) is a headless CMS built with Node.js that supports Volto as a frontend.

[Guillotina](https://guillotina.io/) is a resource management system built with Python, inspired by Plone and using the same basic concepts like traversal, content types, and permissions model.

There is also a [Volto Node.js-based backend reference](https://github.com/plone/volto-reference-backend) API implementation that demonstrates how other systems could also use Volto to display and create content
through it.
7 changes: 0 additions & 7 deletions docs/source/contributing/branch-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,3 @@ legacy
```{todo}
See https://github.com/plone/volto/issues/5255
```


## Translation contributing policy

Due to the nature of `main` and `16.x.x` branches, some developments that may land in `main` may not be backported to `16.x.x`. This means that many translations that may come with those developments will be useless in the `16.x.x` branch and thus porting them to `16.x.x` makes no sense.

So when contributing translations, please create PRs directly from branches created from `16.x.x` and point your PRs to that exact branch instead of `main`.
50 changes: 48 additions & 2 deletions docs/source/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Volto follows those guidelines with a few specific variations, as described in t

(contributing-reporting-an-issue-or-making-a-feature-request-label)=

## Reporting an issue or making a feature request
## Report an issue or make a feature request

If you know the issue or feature request is for Volto, first search for an existing item in the [Volto issue tracker](https://github.com/plone/volto/issues).

Expand Down Expand Up @@ -50,11 +50,57 @@ The Volto Team reviews pull requests only from people with a GitHub account who

(contributing-translations-label)=

## Install Volto for development

To make changes to Volto, you need to run it from a copy of the `plone/volto` repository.

### Prerequisites

You need all the requirements already mentioned in {doc}`plone:install-packages-prerequisites-label`.

### Clone the Volto repository

```shell
git clone https://github.com/plone/volto.git
```

### Start the Plone backend

While developing Volto, you need to have the Plone backend running.
If you don't already have the backend installed,
the easiest way is to run the following command inside the Volto repository:

```shell
make start-backend-docker
```

### Install Node.js dependencies

```shell
yarn
```

### Start Volto

```
yarn start
```

### Open Volto in your browser

Browse to [http://localhost:3000](http://localhost:3000).

## Translations

All text that can be shown in a browser must be translatable.
Please mark all such strings as translatable as defined in the [i18n guide](../recipes/i18n.md).

### Branch policy for translations

Due to the nature of `main` and `16.x.x` branches, some developments that may land in `main` may not be backported to `16.x.x`. This means that many translations that may come with those developments will be useless in the `16.x.x` branch and thus porting them to `16.x.x` makes no sense.

So when contributing translations, please create PRs directly from branches created from `16.x.x` and point your PRs to that exact branch instead of `main`.


(contributing-change-log-entry-label)=

Expand All @@ -70,7 +116,7 @@ For details see {ref}`contributing-change-log-label`.

(contributing-documenting-your-changes-label)=

## Documenting your changes
## Document your changes

If the feature includes a breaking change, you must include instructions for how to upgrade in the [upgrade guide](../upgrade-guide/index.md).

Expand Down
1 change: 0 additions & 1 deletion docs/source/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ myst:
```{toctree}
:maxdepth: 1
install
roadmap
others
```
Loading

0 comments on commit 0b69901

Please sign in to comment.