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

Add monorepo structure to the README #6542

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ You can build your own or choose from the community released ones:
You can try a Volto online demo at [https://demo.plone.org/](https://demo.plone.org/).


## Monorepo structure

Since version 18.0.0-alpha4, the Volto core repository has had the shape of a monorepo, where "mono" means "single" and "repo" is short for "repository".
This means that several apps and libraries related to each other are stored in the same repository.
They are managed together but released individually.
This allows the code to be shared effectively, and unifies tracking of changes across all of the apps and libraries.

Some packages released to npm were previously in separate repositories, but are now included in this monorepo.
They include the following items.
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved

| Package | Location |
|---|---|
| [`@plone/client`](https://www.npmjs.com/package/@plone/client) | [`packages/client`](https://github.com/plone/volto/tree/main/packages/client#readme) |
| [`@plone/components`](https://www.npmjs.com/package/@plone/components) | [`packages/components`](https://github.com/plone/volto/tree/main/packages/components#readme) |
| [`@plone/generator-volto`](https://www.npmjs.com/package/@plone/generator-volto) | [`packages/generator-volto`](https://github.com/plone/volto/tree/main/packages/generator-volto#readme) |
| [`@plone/helpers`](https://www.npmjs.com/package/@plone/helpers) | [`packages/helpers`](https://github.com/plone/volto/tree/main/packages/helpers#readme) |
| [`@plone/providers`](https://www.npmjs.com/package/@plone/providers) | [`packages/providers`](https://github.com/plone/volto/tree/main/packages/providers#readme) |
| [`@plone/registry`](https://www.npmjs.com/package/@plone/registry) | [`packages/registry`](https://github.com/plone/volto/tree/main/packages/registry#readme) |
| [`@plone/scripts`](https://www.npmjs.com/package/@plone/scripts) | [`packages/scripts`](https://github.com/plone/volto/tree/main/packages/scripts#readme) |
| [`@plone/types`](https://www.npmjs.com/package/@plone/types) | [`packages/types`](https://github.com/plone/volto/tree/main/packages/types#readme) |
| n/a | [`packages/volto-guillotina`](https://github.com/plone/volto/tree/main/packages/volto-guillotina) |
| [`@plone/volto-slate`](https://www.npmjs.com/package/@plone/volto-slate) | [`packages/volto-slate`](https://github.com/plone/volto/tree/main/packages/volto-slate#readme) |
| [`@plone/volto-testing`](https://www.npmjs.com/package/@plone/volto-testing) | [`packages/volto-testing`](https://github.com/plone/volto/tree/main/packages/volto-testing) |

See also [Monorepo structure](https://6.docs.plone.org/volto/contributing/developing-core.html#monorepo-structure).


## Create a Volto project

To start a new project using Volto, follow the [Plone installation documentation](https://6.docs.plone.org/install/create-project.html).
Expand Down
25 changes: 14 additions & 11 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,32 +42,35 @@ The workspaces are located in the `packages` or `apps` folder.
### Folder layout

Volto has the following folder structure.
The package `volto` is the core code of Volto.

```text
(volto-monorepo)/
/
├─ apps/
│ ├─ plone
│ ├─ nextjs
│ ├─ remix
│ └─ rr7
│ ├─ rr7
│ ├─ vite
│ └─ vite-ssr
├─ ...
├─ packages/
│ ├─ volto
│ ├─ blocks
│ ├─ client
│ ├─ components
│ ├─ registry
│ ├─ types
│ ├─ coresandbox
│ ├─ generator-volto
│ ├─ helpers
│ ├─ providers
│ ├─ registry
│ ├─ scripts
│ ├─ slots
│ ├─ theming
│ ├─ tsconfig
│ ├─ types
│ ├─ volto
│ ├─ volto-guillotina
│ ├─ volto-slate
│ └─ volto-testing
├─ .gitignore
├─ package.json
├─ pnpm-workspace.yaml
├─ turbo.json
├─ tsconfig.json
├─ ...
```

Expand Down
1 change: 1 addition & 0 deletions packages/components/news/6542.internal
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update `@plone/components`'s URLs in its `package.json`. @stevepiercy
4 changes: 2 additions & 2 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
"version": "3.0.0",
"repository": {
"type": "git",
"url": "http://github.com/plone/components.git"
"url": "http://github.com/plone/volto.git"
},
"bugs": {
"url": "https://github.com/plone/components/issues"
"url": "https://github.com/plone/volto/issues"
},
"type": "module",
"files": [
Expand Down
1 change: 1 addition & 0 deletions packages/volto/news/6542.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add monorepo structure to the README. Update the monorepo structure file tree. @stevepiercy
Loading